Skip to main content
GET
Get an end user
Returns one end-user record by ID. Requires a key with the End-users permission. See API authentication.
string
required
The _id of the record, as returned by list or create.

Response

Returns the end-user record, or 404 with code NOT_FOUND.

Errors

Authorizations

Authorization
string
header
required

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

endUserId
string
required

The end-user record ID

Response

The end-user record

An end-user record in your organization.

_id
string
required

The end-user record ID. Pass it to the single-record endpoints.

origin
enum<string>
required

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.

Available options:
inbound,
imported,
manual
createdAt
number
required

When the record was created, in milliseconds since epoch.

lastSeenAt
number
required

When the end user was last active, in milliseconds since epoch.

name
string

Display name.

email
string

Email address, normalized by Tars.

phone
string

Phone number in international format.

tags
string[]

Free-form tags applied to this record.

channelIdentifiers
object

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.