Skip to main content
GET
Get a user

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

User external ID

environmentId
string
required

Environment ID

projectId
string
required

Project ID

Query Parameters

expand

Inline: companies, memberships, memberships.company.

Available options:
companies,
memberships,
memberships.company

Response

User found

id
string
required

External user id — the id your app supplied at identify/upsert.

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

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

memberships
object[] | null
required

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