Sign in
contact_addresses

get/contact_addresses/

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
clientstring

client

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__icontainsstring
contact__emails__iexactstring
contact__emails__iregexstring
contact__emails__isnullboolean

Filter the returned list where the array is null

contact__emails__istartswithstring
contact__emails__overlapstring

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

contact__emails__searchstring
contact__namestring

contact__name

contact__name__icontainsstring
contact__name__iexactstring
contact__name__iregexstring
contact__name__istartswithstring
contact__name__searchstring
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__icontainsstring
contact__phones__iexactstring
contact__phones__iregexstring
contact__phones__isnullboolean

Filter the returned list where the array is null

contact__phones__istartswithstring
contact__phones__overlapstring

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

contact__phones__searchstring
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
cursorinteger

The pagination cursor value.

format'json' | 'xlsx'
is_ordererstring

is_orderer

is_receiverstring

is_receiver

orderingstring

Which field to use when ordering the results.

page_sizeinteger

Number of results to return per page.

searchstring

A search term.

sourcestring

source

source__icontainsstring
source__iexactstring
source__iregexstring
source__istartswithstring
source__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

Changes

Changed in 6 of the 6 revisions of this API.12

  • 2557a8fec7642See the full diff
    • ○

      media type application/json; version=2.4.12 was changed to application/json; version=2.4.13 for the response status 200

      response-media-type-name-changed

    • ○

      media type application/xlsx; version=2.4.12 was changed to application/xlsx; version=2.4.13 for the response status 200

      response-media-type-name-changed

  • b89c1b3e6d092See the full diff
    • ○

      media type application/json; version=2.4.11 was changed to application/json; version=2.4.12 for the response status 200

      response-media-type-name-changed

    • ○

      media type application/xlsx; version=2.4.11 was changed to application/xlsx; version=2.4.12 for the response status 200

      response-media-type-name-changed

  • 2823b16250b72See the full diff
    • ○

      media type application/json; version=2.4.10 was changed to application/json; version=2.4.11 for the response status 200

      response-media-type-name-changed

    • ○

      media type application/xlsx; version=2.4.10 was changed to application/xlsx; version=2.4.11 for the response status 200

      response-media-type-name-changed

  • 0254944080622See the full diff
    • ○

      media type application/json; version=2.4.5 was changed to application/json; version=2.4.10 for the response status 200

      response-media-type-name-changed

    • ○

      media type application/xlsx; version=2.4.5 was changed to application/xlsx; version=2.4.10 for the response status 200

      response-media-type-name-changed

  • 486e2fd12f8f2See the full diff
    • ○

      media type application/json; version=2.3.5 was changed to application/json; version=2.4.5 for the response status 200

      response-media-type-name-changed

    • ○

      media type application/xlsx; version=2.3.5 was changed to application/xlsx; version=2.4.5 for the response status 200

      response-media-type-name-changed

  • 8446ece0e1482See the full diff
    • ○

      media type application/json; version=2.4.13 was changed to application/json; version=2.3.5 for the response status 200

      response-media-type-name-changed

    • ○

      media type application/xlsx; version=2.4.13 was changed to application/xlsx; version=2.3.5 for the response status 200

      response-media-type-name-changed

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog