PeopleSearch people
People

Search people

Search for people by specific criteria.

curl -X GET "https://api.flameup.ai/api/v1/workspaces/example_string/people/search?q=example_string&email=user@example.com&external_id=example_string&limit=42" \
  -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"
    }
  ]
}
GET
/workspaces/{workspaceId}/people/search
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
qstring

General search query

query
emailstring

Exact email match

query
external_idstring

Exact external_id match

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

qstring

General search query

emailstring

Exact email match

external_idstring

Exact external_id match

Responses

peoplearray
Was this page helpful?
Built with Documentation.AI

Last updated today