Skip to main content
GET
Get a company

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Company external ID

environmentId
string
required

Environment ID

projectId
string
required

Project ID

Query Parameters

expand

Inline: users, memberships, memberships.user.

Available options:
users,
memberships,
memberships.user

Response

Company found

id
string
required

External company id — the id your app supplied at group/upsert.

object
enum<string>
required
Available options:
company
attributes
object
required
createdAt
string<date-time>
required
users
object[] | null
required

null = not expanded (pass expand: ["users"]); [] = expanded, none.

memberships
object[] | null
required

null = not expanded (pass expand: ["memberships"]); [] = expanded, none.