A valid request URL is required to generate request examples{
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"avatar_url": "<string>",
"locale": "en",
"identified": true,
"email_verified": true,
"attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_term": "<string>",
"utm_content": "<string>",
"referrer": "<string>",
"landing_page": "<string>"
},
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"verified": true,
"session_expires_at": "2023-11-07T05:31:56Z",
"impersonation": {
"expires_at": "2023-11-07T05:31:56Z"
},
"pending_agreements": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"accepted": true,
"accepted_at": "2023-11-07T05:31:56Z",
"pending": true,
"blocking": true,
"deferrable": true,
"accept_by": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Read the current contact
The customer plane’s identity read: who am I, in this product. A contact session reads its own contact and nothing else — that scope is the whole authorization model of uk_ct_.
A valid request URL is required to generate request examples{
"contact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>",
"avatar_url": "<string>",
"locale": "en",
"identified": true,
"email_verified": true,
"attribution": {
"utm_source": "<string>",
"utm_medium": "<string>",
"utm_campaign": "<string>",
"utm_term": "<string>",
"utm_content": "<string>",
"referrer": "<string>",
"landing_page": "<string>"
},
"first_seen_at": "2023-11-07T05:31:56Z",
"last_seen_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
},
"verified": true,
"session_expires_at": "2023-11-07T05:31:56Z",
"impersonation": {
"expires_at": "2023-11-07T05:31:56Z"
},
"pending_agreements": [
{
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"title": "<string>",
"enforcement": "required",
"version": 123,
"summary": "<string>",
"effective_at": "2023-11-07T05:31:56Z",
"accepted": true,
"accepted_at": "2023-11-07T05:31:56Z",
"pending": true,
"blocking": true,
"deferrable": true,
"accept_by": "2023-11-07T05:31:56Z"
}
]
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A contact session token, uk_ct_…. Belongs to one of the developer's own users, and reads only that user's data.
Resposta
The contact.
One of the developer's own users — anonymous or identified.
Show child attributes
Show child attributes
Whether the identity behind this session was proven.
Present and non-null when somebody from the tenant's staff is holding this session rather than the person it names (POST /v1/organization/contacts/{id}/impersonate). Render a permanent banner while it is non-null — an account being looked at without its owner being able to see that it is being looked at is the version of this feature that should not exist. The key is always present so that forgetting to check reads as a missing banner rather than as a calm page. It never names the operator: which employee opened the session is the tenant's audit log, not something their customers are shown.
Show child attributes
Show child attributes
Outstanding agreements on published terms. A FACT, never a refusal: what to do about one is the product's decision, made where the cost of interrupting is visible.
Show child attributes
Show child attributes