Skip to main content
GET
List people

Authorizations

Authorization
string
header
required

Bearer API key. Secret server keys start with gt_live_; client-safe browser keys start with gt_pub_ (write-only, origin-pinned). Create and scope keys in Settings → API Keys.

Query Parameters

limit
integer
default:50

Max rows to return. Default 50, max 100.

Required range: 1 <= x <= 100
offset
integer
default:0

Rows to skip (pagination).

Required range: x >= 0
accountId
string<uuid>

Only People at this Company.

email
string<email>

Exact match.

externalId
string

Your own stable id for the Person (for example a Segment userId). Exact match.

includeArchived
boolean
default:false

Set to true to include archived records. GainTrace archives a record instead of deleting it when its source removes it, or when a Person leaves a Company. Lists leave archived records out by default. Any value other than true or false returns 422.

Response

A page of People.

data
object[]
meta
object