Get Subscriber

Fetch one contact by id or email.

MethodGET
/api/v2/subscribers/:subscriber

Returns one contact. :subscriber is an id or email. Permission: subscribers.

Path Parameters

NameTypeDescription
subscriberstringRequired. Subscriber id or email.

Response Fields

FieldTypeDescription
idstringSubscriber id.
emailstringEmail address.
namestring or nullDisplay name.
phonestring or nullPhone number.
statusstringCurrent status.
createdAtstringISO 8601 created timestamp.
updatedAtstringISO 8601 updated timestamp.
tags{ id, name }[]Attached tags.
fields{ name, value }[]Custom fields.

Errors

StatusnameWhen
401missing_api_keyMissing or invalid bearer token
403missing_permissionToken lacks the subscribers permission
404not_foundUnknown id or email