API ReferenceContacts
Retrieve a contact
GET
Fetch one contact by id.
Requires the contacts:read scope — View your contacts and their custom fields.
header
AuthorizationBearer <API Key>API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.
id*stringResource id.
Format
uuidThe contact
application/json- response
A contact as exposed on the v1 API.
id*stringFormat
uuidemail*stringsubscribed*booleancustom_fields*||||array<any>|Arbitrary JSON value (string, number, boolean, null, array, or object).
created_at*stringFormat
date-timeupdated_at*stringFormat
date-timecurl -X GET 'https://api.sendly.now/api/v1/contacts/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "subscribed": true, "custom_fields": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z"}