Conferencing Profiles BETA

Description #

Addition to UserInfo to enumerate the conferencing profiles an account has authorized.

URL format #

api.cronofy.com/v1/userinfo

Example Request #

GET /v1/userinfo 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

{
  "sub": "acc_5700a00eb0ccd07000000000",
  "email": "janed@company.com",
  "name": "Jane Doe",
  "zoneinfo": "Europe/London",
  "cronofy.type": "account",
  "cronofy.data": {
    "authorization": {
      "scope": "read_write"
    },
    "profiles": [
      ...
    ],
    "conferencing_profiles": [
      {
        "provider_name": "zoom",
        "profile_id": "pro_jknsdfk234",
        "profile_name": "example@cronofy.com",
        "profile_connected": true
      }
    ]
  }
}

Response parameters #

cronofy.data.conferencing_profiles.provider_name  #

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

Currently one of:

  • go_to
  • zoom
  • ms_teams

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.

cronofy.data.conferencing_profiles.profile_id  #

This specifies the ID of the conferencing profile as an ASCII-only String.

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

cronofy.data.conferencing_profiles.profile_name  #

This specifies the name of the conferencing profile as a String.

cronofy.data.conferencing_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.

Search