PeopleSearch people

Search people

Search people in the workspace. Requires people:read.

curl -X GET "https://api.flameup.ai/api/v1/people/search?q=example_string&search=example_string&status=active&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/search
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
qstring

Search text, matched against the person's identifiers and contact fields. search is accepted as an alias; q wins if both are sent.

query
statusstring

Restrict to one lifecycle status.

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

qstring

Search text, matched against the person's identifiers and contact fields. search is accepted as an alias; q wins if both are sent.

statusstring

Restrict to one lifecycle status.

Example:
active

Responses

peoplearray
totalinteger

Total matches, not the size of this page.

limitinteger
offsetinteger