Get contact
GET/api/v1/contacts/{id}
A contact with the lists it is on.
Scope
contacts:readRead contacts – the person behind the key must be all members.
Path parameters
idstringrequired- The contact's ID.
Response
200 The contact.
idstringrequired- The contact's ID.
emailstringrequired- The email address (lower case). Never changes: consents and suppressions apply to the address.
first_namestring | nullrequiredlast_namestring | nullrequiredcompanystring | nullrequiredphonestring | nullrequired- In international format (E.164), e.g. +46701234567.
statusstringrequired- active: can receive mailings · unsubscribed: has unsubscribed from everything · bounced: the address bounces · complained: has reported spam · deleted: erased (GDPR), the personal data is gone.
activeunsubscribedbouncedcomplaineddeleted fieldsobject<string | number | boolean>required- Custom fields by key (see GET /fields). Sensitive fields, such as personal identity numbers, are never sent out.
tagsarray<string>requiredsourcestringrequired- How the contact was added: manual, import, form, api …
consentobjectrequiredconsent.atstring (time, ISO 8601) | nullrequired- When consent was given.
consent.sourcestring | nullrequired- How the person consented, in your own words.
suppressionobject | nullrequired- The workspace's suppression of the address. A suppressed address never receives mailings, regardless of status.
suppression.reasonstringrequired- unsubscribed, bounced, complained, manual or imported.
suppression.created_atstring (time, ISO 8601)required- When the address was suppressed.
sharedbooleanrequired- Shared from a level above in the organisation: can be read and receive mailings from here, but can only be changed where it belongs.
created_atstring (time, ISO 8601)required- When the contact was created.
updated_atstring (time, ISO 8601)required- When the contact was last changed.
unsubscribed_atstring (time, ISO 8601) | nullrequired- When the person unsubscribed.
listsarray<object>required- The workspace's lists that the contact is on. Empty for a shared contact.
lists[].list_idstringrequiredlists[].namestringrequiredlists[].statusstringrequired- subscribed: on the list · pending: waiting to confirm by email · unsubscribed: has left the list.
subscribedpendingunsubscribed lists[].subscribed_atstring (time, ISO 8601) | nullrequired- When the person joined the list.
Errors
- 404
- not_found
- 429
- rate_limited