Get an end user
Fetch a single end-user record by its ID, or a 404 NOT_FOUND when no record matches.
_id of the record, as returned by list or create.Response
Returns the end-user record, or404 with code NOT_FOUND.
Errors
Authorizations
API key sent as Authorization: Bearer YOUR_API_KEY. Campaign endpoints use campaign-scoped keys; the rest use organization or agent keys with the matching permission.
Path Parameters
The end-user record ID
Response
The end-user record
An end-user record in your organization.
The end-user record ID. Pass it to the single-record endpoints.
How the record was created. inbound came from a conversation, imported came from a file import, and manual was created by hand or over this API.
inbound, imported, manual When the record was created, in milliseconds since epoch.
When the end user was last active, in milliseconds since epoch.
Display name.
Email address, normalized by Tars.
Phone number in international format.
Free-form tags applied to this record.
Where Tars can reach this end user on each channel. Every field is optional, and only the channels Tars has seen are present.
Consent for each channel, keyed by channel name such as web or whatsapp. Absent when no consent has been recorded.
