Skip to content

Persons API

6 endpoints. All requests need an Authorization header — see Authentication. API keys additionally need the matching scope.

Method Path Description
GET /api/persons/ List Persons Query: query, account_id, lifecycle_stage, limit, offset.
POST /api/persons/ Create Person Accepts a JSON body.
POST /api/persons/merge Merge Persons Accepts a JSON body.
GET /api/persons/{person_id} Get Person
POST /api/persons/{person_id}/identities Add Identity Accepts a JSON body.
GET /api/persons/{person_id}/timeline Person Timeline Query: limit, offset, types.

Try it

The full request/response schema for every endpoint is in the OpenAPI spec served by your own workspace.