Skip to main content
GET
List

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Query Parameters

q
string | null
role
string | null
all
string | null

Response

Success

id
string
required
kind
string
required
name
string
required
email
string | null
required
mobile
string | null
required
addressLine1
string | null
required
addressLine2
string | null
required
addressTown
string | null
required
addressPostcode
string | null
required
overseas
boolean
required
archivedAt
string | null
required
createdAt
string
required
roles
string[]
required
companyId
string | null
required
companyRevision
required
companyRole
string | null
required
mergedIntoId
string | null
required
mergedAt
string | null
required