Error

A valid request URL is required to generate request examples

{
  "events": [
    {
      "type": "contact.signed_in",
      "method": "<string>",
      "ip": "<string>",
      "user_agent": "<string>",
      "sequence": 123,
      "created_at": "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"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Contacts (panel)

One contact's authentication history

Requires customers:read. What happened to this account: every sign-in, how it happened and where from, newest first (100 most recent).

It is the answer to the support conversation that starts with “was that me?” — and it matters more than usual because there is deliberately no way to lift two-factor off a contact who lost their phone and their recovery codes, so seeing the history is the least that conversation needs.

ip and user_agent are attributes of the request a session was minted on: what the proxy left, and a string the caller chose. They are for a person to recognise their own device, never for an authorization decision.

Anonymous visitors never appear. The widget mints one on every page load, none of them is an account, and a history full of them is a history nobody reads.

GET

organization

contacts

{id}

auth-events

Error

A valid request URL is required to generate request examples

{
  "events": [
    {
      "type": "contact.signed_in",
      "method": "<string>",
      "ip": "<string>",
      "user_agent": "<string>",
      "sequence": 123,
      "created_at": "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"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "your role does not allow this action"
  }
}

Autorizações

Authorization

string

header

obrigatório

A staff session token, uk_st_…. Minted by sign-up, sign-in or the two-factor exchange.

Cabeçalhos

X-Organization-Id

string

The organization the caller is acting on — the org_… code that appears in the panel URL. It identifies; the membership JOIN is what authorizes, so a forged code reads nothing. Absent, the session's default organization answers.

Parâmetros de caminho

string<uuid>

obrigatório

Parâmetros de consulta

environment

enum<string>

padrão:live

Which environment to read. A view parameter, valid only on the staff surface.

Opções disponíveis:

live,

test

Resposta

The history.

events

object[]

Show child attributes

Read a contact Merge two contacts

⌘I

Visão geral

Endpoints