Account

Get and manage account information.

Part of the API reference collection

This page is part of the Crunchy Bridge API reference, and primarily meant to act as an exhaustive guide for technical integrations which are already in progress. To understand the basics of using the API, see API concepts and getting started.

Get account

Get the currently authenticated account.

GET /account

Request

cURL example

curl -X GET https://api.crunchybridge.com/account
    -H "Authorization: Bearer $CRUNCHY_API_KEY"

Response

Status: 200

A user account.

During a SSO-based authentication, GET /account still returns an account API resource, but a synthetic one that’s missing some normal fields.

Content type: application/json

Name	Nullable	Type	Description
id		`string` in EID format	Primary ID of the account.
created_at	✔	`string` of date/time formatted as RFC 3339	Time at which the account was created. Always present for a real account, but not present for a synthetic account resource returned during SSO-based authentication.
default_team_id	✔	`string` in EID format	The account’s default team. If null, the account’s default team is their personal team (which has the same ID as the account).
email		`string`	Email associated with the account.
first_name	✔	`string`	First name associated with the account. Always has a value for password-based accounts, but may be empty in the case of an SSO account that doesn’t provide a name.
has_personal_team		`boolean`	Indicates whether the account has a personal team, a team which shares the account’s ID which is for its exclusive use. Most accounts have a personal team, and this value will be `true`, but some SSO-only accounts don’t, and this property provides an easy way of distinguishing between the two.
last_name	✔	`string`	Last name associated with the account. Always has a value for password-based accounts, but may be empty in the case of an SSO account that doesn’t provide a name.
last_seen_at	✔	`string` of date/time formatted as RFC 3339	Time at which the account was last seen in either the API of web dashboard.
login_url	✔	`string`	A URL for where it’s appropriate to redirect the user to relogin. This may be useful for when it’s detected that a session has expired, and to reinitiate a login flow, especially for SSO-based logins that may not use the normal login screen.
name	✔	`string`	Full name associated with the account. Always has a value for password-based accounts, but may be empty in the case of an SSO account that doesn’t provide a name.
updated_at	✔	`string` of date/time formatted as RFC 3339	Time at which the account was last updated. Always present for a real account, but not present for a synthetic account resource returned during SSO-based authentication.

Example

{
    "created_at": "2021-07-11T01:02:03Z",
    "dashboard_settings": null,
    "default_team_id": null,
    "email": "[email protected]",
    "first_name": "First",
    "has_personal_team": true,
    "id": "qvcw4hylovgyzbwzp53bmmlhga",
    "last_name": "Last",
    "last_seen_at": "2021-07-11T01:02:03Z",
    "login_url": null,
    "name": "First Last",
    "updated_at": "2021-07-11T01:02:03Z"
}