Account

Description #

Returns identifying information for the authenticated account.

URL format #

api.cronofy.com/v1/account

Example Request #

GET /v1/account HTTP/1.1
Host: api.cronofy.com
Authorization: Bearer {ACCESS_TOKEN}

Example Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "account": {
    "account_id": "acc_5700a00eb0ccd07000000000",
    "email": "janed@company.com",
    "name": "Jane Doe",
    "scope": "read_events create_event delete_event",
    "default_tzid": "Europe/London"
  },
  "sub": "acc_5700a00eb0ccd07000000000"
}

Response parameters #

account.account_id  #

This specifies the internal Cronofy ID for the account, ASCII-only String.

account.email  #

The primary email address associated with the account as a String.

account.name  #

The name associated with the account as a String. May be null or blank.

account.scope  #

This specifies the scope granted for the account for the active authorization as a space-separated String in order to mimic how it is provided during an Authorization Request.

account.default_tzid  #

A String representing a known time zone identifier from the IANA Time Zone Database.

Common examples are:

  • Etc/UTC
  • Europe/Paris
  • America/Chicago
sub  #

This specifies the internal Cronofy ID for the account, ASCII-only String.

Error responses #

401 Unauthorized #

The request was refused as the provided authentication credentials were not recognized.

When an OAuth refresh_token is available then it should be used to request a replacement auth_token before the request is retried.

Search