Skip to main content
POST
Create

Authorizations

x-api-key
string
header
required

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

Body

application/json
name
string
required
kind
string | null
email
string | null
mobile
string | null
addressLine1
string · null · null
addressLine2
string · null · null
addressTown
string · null · null
addressPostcode
string · null · null
overseas
boolean | null
roles
string[] | null
registrationNumber
string · null · null
registrationJurisdiction
string · null · null
website
string · null · null
notes
string · null · null
requestId
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