Skip to main content
GET
Get a company user

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

CompanyUser identifier

Response

CompanyUser resource

id
integer
read-only
company
object
user
string<iri-reference> | null
Example:

"/api/v1/users/1"

contact
object | null
roles
string[]
dateCreated
string<date-time>
dateEnded
string<date-time> | null
dateJoined
string<date-time> | null
addedBy
string<iri-reference> | null
Example:

"/api/v1/users/1"

role
string