Skip to main content
GET
Get a contact
A missing, deleted, merged, test or foreign record returns 404 not_found.

Authorizations

Authorization
string
header
required

An API key (tars_sk_…) sent as Authorization: Bearer <key>. Each operation names the permission it needs. Create keys in Settings → Integrations → API keys.

Path Parameters

id
string
required

The id.

Required string length: 1 - 128

Response

The contact.

A contact in your organization.

id
string
required

The contact id.

tags
string[]
required
origin
enum<string>
required

How the contact was created: inbound from a conversation, imported from a file, manual by hand or over this API, outbound_call when a voice agent called the number.

Available options:
inbound,
imported,
manual,
outbound_call
createdAt
number
required

When the contact was created, in milliseconds since the epoch.

lastSeenAt
number
required

When the contact was last active, in milliseconds since the epoch.

name
string
email
string

Email address, normalized.

phone
string

Phone number in E.164 format.

channelIdentifiers
object

Where Tars can reach the contact on each channel. Only the channels Tars has seen are present.

Consent per channel, keyed by channel name such as web or whatsapp.