PeopleList people
People

List people

Retrieve a paginated list of people in the workspace.

curl -X GET "https://api.flameup.ai/api/v1/workspaces/example_string/people?limit=42&offset=42&status=active&search=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "people": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "example_string",
      "external_id": "example_string",
      "email": "user@example.com",
      "phone": "+1-555-0123",
      "first_name": "John Doe",
      "last_name": "John Doe",
      "avatar_url": "example_string",
      "timezone": "example_string",
      "locale": "example_string",
      "status": "active",
      "attributes": {},
      "created_at": "2024-12-25T10:00:00Z",
      "updated_at": "2024-12-25T10:00:00Z",
      "first_seen_at": "2024-12-25T10:00:00Z",
      "last_seen_at": "2024-12-25T10:00:00Z"
    }
  ],
  "total": 42,
  "limit": 42,
  "offset": 42
}
GET
/workspaces/{workspaceId}/people
GET
Security Scheme
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 100)

Max: 100
query
offsetinteger

Pagination offset

query
statusstring

Filter by status

Options: active, unsubscribed, bounced
Request Preview
Response

Response will appear here after sending the request

Authentication

BearerAuth
header
Authorizationstring
Required

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

Path Parameters

Query Parameters

limitinteger

Number of results (max 100)

offsetinteger

Pagination offset

statusstring

Filter by status

Responses

peoplearray
totalinteger
limitinteger
offsetinteger
Was this page helpful?
Built with Documentation.AI

Last updated today