Skip to main content
GET
Get a current user

Authorizations

Authorization
string
header
required

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

Response

200 - application/json

OK

user_id
integer

The user id

access_token
object

Information about the access token used to make this request.

name
string

Name of the user

email
string<email>

Email address of the user

role
enum<string>

The user's role.

  • global_admin — Narrative staff, unrestricted across companies
  • partner_admin — administers their own company
  • partner_user — ordinary member of their own company
Available options:
global_admin,
partner_admin,
partner_user
company_access_list
integer[]
deprecated

IDs of companies that could be accessed by the user. Deprecated, use accessible_companies instead. Will be removed in a future release.

accessible_companies
object[]

Companies that could be accessed by the user, with full company details.

current_company_scope
object
Example:
permissions
object[]
created_at
string

The instant this user account was created.

Example:

"2021-06-24T00:54:40.029056Z"

created_by
string | null

Email address of the user who created this account. Null when no creator was recorded.

last_updated_at
string | null

The instant this user account was last updated. Null when it has never been updated.

Example:

"2021-06-24T00:54:40.029056Z"

last_updated_by
string | null

Email address of the user who last updated this account. Null when it has never been updated.