Skip to main content
POST
Company create

Authorizations

x-api-key
string
header
required

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

Body

application/json
requestId
string
required
name
string
required
email
string · null · null
mobile
string · null · 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

Response

Success

id
string
required
legacyContactId
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
roles
string[]
required
registrationNumber
string | null
required
registrationJurisdiction
string | null
required
website
string | null
required
notes
string | null
required
revision
required
archivedAt
string | null
required
createdAt
string
required
people
object[]
required