PeopleGet person

Get person

Retrieve a person by external ID.

curl -X GET "https://api.flameup.ai/api/v1/people/example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "example_string",
  "email": "user@example.com",
  "phone": "+1-555-0123",
  "anonymousId": "example_string",
  "traits": {},
  "status": "active",
  "unsubscribed_at": "2024-12-25T10:00:00Z",
  "unsubscribe_reason": "example_string",
  "created_at": "2024-12-25T10:00:00Z",
  "updated_at": "2024-12-25T10:00:00Z"
}
GET
/people/{id}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Your Flameup API key (passed as Bearer token)

Your Flameup API key (passed as Bearer token)
path
idstring
Required

The person's external ID — the userId you send to /identify and /track. Email is NOT accepted here; the lookup keys on external ID only.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Your Flameup API key (passed as Bearer token)

Path Parameters

idstring
Required

The person's external ID — the userId you send to /identify and /track. Email is NOT accepted here; the lookup keys on external ID only.

Responses

idstring

The Flameup person UUID.

workspace_idstring
userIdstring

Your own user id — the external id you send to /identify and /track.

emailstring

Empty string when the person has no email.

phonestring

Empty string when the person has no phone.

anonymousIdstring

Present only when the person carries an anonymous id.

traitsobject
statusstring

The person's consent state: active, unsubscribed, bounced or suppressed. Serialized on every person read (get, list, search, the create/upsert echo for a key with people:read, and batch results), so treat it as always present. It is emitted verbatim rather than defaulted, so a row written before the column had a default can read back as an empty string — which is why this is not declared as a closed enum.

unsubscribed_atstring

When the person unsubscribed. Present only when set.

unsubscribe_reasonstring

Why the person unsubscribed. Present only when set.

created_atstring
updated_atstring