Sign in

v1

latestOpenAPI 3.0.32026-07-132612241.2 MB
contact_address_exports

This view has multiple renderer classes available: json and xlsx. In order to export the data as an excel file, just set query argument format to xlsx.When downloading xlsx format, use Accept header application/vnd.openxmlformats-officedocument.spreadsheetml.sheet; version=...

The user can request what fields and in what order will be rendered using query argument fields. This is a comma separated list of field names used in the API.

When exporting to excel, the column names may be changed based on pre-defined field names and width mapping.

Available since version 2.2.1

get/contact_address_exports/

Query parameters

accountstring

account

address__apartment_numberstring

address__apartment_number

address__apartment_number__icontainsstring
address__apartment_number__iexactstring
address__apartment_number__iregexstring
address__apartment_number__istartswithstring
address__apartment_number__searchstring
address__citystring

address__city

address__city__icontainsstring
address__city__iexactstring
address__city__iregexstring
address__city__istartswithstring
address__city__searchstring
address__countrystring

address__country

address__country__icontainsstring
address__country__iexactstring
address__country__iregexstring
address__country__istartswithstring
address__country__searchstring
address__country_codestring

address__country_code

address__country_code__icontainsstring
address__country_code__iexactstring
address__country_code__iregexstring
address__country_code__istartswithstring
address__country_code__searchstring
address__formatted_addressstring

address__formatted_address

address__formatted_address__icontainsstring
address__formatted_address__iexactstring
address__formatted_address__iregexstring
address__formatted_address__istartswithstring
address__formatted_address__searchstring
address__postal_codestring

address__postal_code

address__postal_code__icontainsstring
address__postal_code__iexactstring
address__postal_code__iregexstring
address__postal_code__istartswithstring
address__postal_code__searchstring
address__statestring

address__state

address__state__icontainsstring
address__state__iexactstring
address__state__iregexstring
address__state__istartswithstring
address__state__searchstring
address__streetstring

address__street

address__street__icontainsstring
address__street__iexactstring
address__street__iregexstring
address__street__istartswithstring
address__street__searchstring
contact__companystring

contact__company

contact__company__icontainsstring
contact__company__iexactstring
contact__company__iregexstring
contact__company__istartswithstring
contact__company__searchstring
contact__emails__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

contact__emails__containsstring

Filter the returned list where filter_value in field values. Comma separated values supported

contact__emails__isnullboolean

Filter the returned list where the array is null

contact__emails__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

contact__namestring

contact__name

contact__notesstring

contact__notes

contact__notes__icontainsstring
contact__notes__iexactstring
contact__notes__iregexstring
contact__notes__istartswithstring
contact__notes__searchstring
contact__phones__contained_bystring

Filter the returned list where all target array values contained in filter values. Comma separated values supported

contact__phones__containsstring

Filter the returned list where filter_value in field values. Comma separated values supported

contact__phones__isnullboolean

Filter the returned list where the array is null

contact__phones__overlapstring

Filter the returned list where at least one filter value in target array. Comma separated values supported

created_at__datestring date
created_at__date_or_isnullstring date
created_at__gtstring datetime
created_at__gt_or_isnullstring datetime
created_at__gtestring datetime
created_at__gte_or_isnullstring datetime
created_at__ltstring datetime
created_at__lt_or_isnullstring datetime
created_at__ltestring datetime
created_at__lte_or_isnullstring datetime
fieldsstring

Select fields to be exported. Selected fields will be returned in the requested order. The value should be a comma separated value. When not used, all the fields in the serializer will be returned

format'json' | 'xlsx'

Selects response method. xlsx returns Excel file

is_ordererstring

is_orderer

is_receiverstring

is_receiver

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

sourcestring

source

sourcecontact__name__icontainsstring
sourcecontact__name__iexactstring
sourcecontact__name__iregexstring
sourcecontact__name__istartswithstring
sourcecontact__name__searchstring
updated_at__datestring date
updated_at__date_or_isnullstring date
updated_at__gtstring datetime
updated_at__gt_or_isnullstring datetime
updated_at__gtestring datetime
updated_at__gte_or_isnullstring datetime
updated_at__ltstring datetime
updated_at__lt_or_isnullstring datetime
updated_at__ltestring datetime
updated_at__lte_or_isnullstring datetime