Search people

POST/v1/people/search/

Authorization

apiKeyAuth

AuthorizationBearer <token>

Organization API key, format pulse_<prefix>_<secret>. Created by an organization admin in Settings -> API Keys.

In: header

Request Body

application/json

Request shape for POST /v1/people/search, pinned to PersonSearchViewSet.get_params (apps/public_api/api/people.py).

query?string

Name to match, against both current names and known aliases.

limit?integer

Results per page, 1-25. Defaults to 10; larger values are clamped.

offset?integer

Number of results to skip. Defaults to 0.

Response Body

Matching people.

Matching rows in results (one object per row), with the total match count and whether the result set was truncated.

results*array<>

Matching rows, one object per row — the 200 response example shows the row shape.

count*integer

Total number of matching rows, including any beyond the returned page.

truncated*boolean

true when results holds only part of the matches — page onward with limit/offset.

curl -X POST "https://example.com/v1/people/search/" \  -H "Authorization: Bearer $PULSE_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "query": "Bristow",    "limit": 10  }'

{  "results": [    {      "entity_type": "person",      "id": 70049,      "display_name": "Dennis Bristow",      "is_current": true,      "current_role": "Non-Executive Director",      "current_company": "DRDGOLD Ltd"    }  ],  "count": 1,  "truncated": false}