GEgetsitecontrol
Contacts

Get a contact

One contact by id, with everything list_contacts gives for it. Call it to read a contact you know the id of; to find one by e-mail, use list_contacts with email.

get/v1/sites/{site_id}/contacts/{contact_id}

Request

  • Base URL
    https://api.getsitecontrol.com
  • Auth
    HTTP bearer

Path parameters

site_idinteger required
contact_idinteger required

Contact id from list_contacts

Response

Successful Response

idinteger required
emailstring required
status'subscribed' | 'unsubscribed' | 'bounced' required

subscribed: subscribed to e-mails. unsubscribed: opted out, never subscribed, or has not confirmed the subscription yet. bounced: e-mails to the address bounced, or it was cleaned from the list.

first_namestring nullable
last_namestring nullable
phonestring nullable
countrystring nullable

ISO 3166-1 alpha-2

timezonestring nullable

IANA time zone name

languagestring nullable

ISO 639-1 code

fieldsobject required

Set values of custom fields by field id, typed by the field: a date as YYYY-MM-DD, a datetime in ISO 8601

created_atstring date-time required

When the contact was added at its source; imports keep the original date

updated_atstring date-time required

Last change; equals created_at when none was recorded

warningsstring[] required

Empty unless the contact could not be read in full; wording is not stable, do not parse

Changes

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