PeopleList people

List people

Retrieve a paginated list of people in the workspace. limit and offset are the only query parameters — there is no status or search filtering here; use GET /people/search for that.

curl -X GET "https://api.flameup.ai/api/v1/people?limit=50&offset=0" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "people": [
    {
      "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"
    }
  ],
  "total": 42,
  "limit": 42,
  "offset": 42
}
GET
/people
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)
query
limitinteger

Number of results (max 500)

Max: 500
query
offsetinteger

Pagination offset

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)

Query Parameters

limitinteger

Number of results (max 500)

offsetinteger

Pagination offset

Responses

peoplearray
totalinteger
limitinteger
offsetinteger