Profile Information

Description #

Returns a list of all the authenticated user’s calendar profiles.

URL format #

{data_center_url}/v1/profiles

Example Request #

GET /v1/profiles HTTP/1.1
Host: {data_center_url}
Authorization: Bearer {ACCESS_TOKEN}

Example Response #

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

{
  "profiles": [
    {
      "provider_name": "google",
      "provider_service": "gsuite",
      "profile_id": "pro_n23kjnwrw2",
      "profile_name": "example1@cronofy.com",
      "profile_connected": true,
      "profile_initial_sync_required": false
    },
    {
      "provider_name": "exchange",
      "provider_service": "office365",
      "profile_id": "pro_fe145c37de",
      "profile_name": "example2@cronofy.com",
      "profile_connected": false,
      "profile_initial_sync_required": false,
      "profile_relink_url": "https://app.cronofy.com/relink/apple?email=example@cronofy.com"
    }
  ]
}

Request parameters #

Response parameters #

profiles.provider_name  #

This specifies the provider of the calendar as a lowercase, ASCII-only String.

Currently one of:

• apple
• cronofy
• exchange
• google
• live_connect

However, this will be expanded over time and therefore consumers should support any value for this field.

profiles.provider_service  #

This specifies the service that hosts the calendar as a lowercase, ASCII-only String.

Currently one of:

• cronofy
• exchange
• google
• gsuite
• icloud
• office365
• outlook_com

However, this will be expanded over time and therefore consumers should support any value for this field.

This should be used to help a user distinguish between their profiles as they can have multiple profiles with the same name.

profiles.profile_id  #

This specifies the ID of the profile, a profile may consist of many calendars, as an ASCII-only String.

This is used for targetting other API actions toward this profile.

profiles.profile_name  #

This specifies the name of the profile as a String.

profiles.profile_connected  #

This specifies whether we have an active connection for this profile, usually whether we have valid credentials or not, as a Boolean.

profiles.profile_initial_sync_required  #

This specifies whether we have performed an initial sync on this profile.

When connected a calendar via Individual Connect, Cronofy will provide an access token and then start syncing the calendar data. During this period, we don’t yet have a complete calendar data. This can take between a few seconds to a few minutes depending on the quantity of data in the calendar. This indicates that while you can begin calling the API for this account, you will not see all events and Availability Query won’t be based on the full calendar content yet.

For newly connected Enterprise Connect profiles, the value is always false, as we won’t send the access token until the initial sync is completed.

Once Cronofy has completed an initial sync, this value remains false.

profiles.profile_relink_url optional  #

When the profile is not connected, a URL will be provided as a String that you can direct the user to in order for them to reconnect this profile.

This URL is unique to each profile as it contains information relating to the underlying provider and so forth.

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.