Contacts

List contacts

get/contacts

Request

  • Base URL: https://api.echtpost.de/v2
  • URL: https://api.echtpost.de/v2/contacts
  • Auth: one of:
    • OAuth 2 (authorization code, authorization URL https://my.echtpost.de/oauth/authorize, token URL https://my.echtpost.de/oauth/token, scopes: mcp)
    • API key in header X-Api-Key
    • HTTP bearer

Query parameters

pageinteger
per_pageinteger
country_codestring
group_idinteger
external_idstring
searchstring
sort'last_name' | 'created_at' | 'updated_at'
direction'asc' | 'desc'
includestring

Comma-separated. Allowed groups, cards.

Response

OK

idinteger
account_idinteger
first_namestring
last_namestring
titlestring
greeting_style'formal' | 'informal' | 'custom'
custom_salutationstring nullable
greetingstring nullable
genderstring nullable
company_namestring nullable
departmentstring nullable
streetstring
zipstring
citystring
state_codestring nullable
country_codestring

ISO 3166-1 alpha-2

birthdatestring date nullable
external_idstring nullable
group_idsinteger[]

Only present with include=groups

card_idsstring[]

Only present with include=cards

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.