Skip to main content
GET
/
calendars
List Calendars
curl --request GET \
  --url https://calendar.universal.rollout.com/api/calendars \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Rollout-Credential-Id: <api-key>'
{
  "_metadata": {
    "collection": "<string>",
    "offset": 123,
    "limit": 123,
    "total": 123,
    "next": "<string>",
    "nextLink": "<string>"
  },
  "calendars": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "timezone": "<string>",
      "color": "<string>",
      "isPrimary": true,
      "isReadOnly": true,
      "created": "<string>",
      "updated": "<string>",
      "rolloutUpdated": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Authorization JWT

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Query Parameters

next
string
offset
default:0
limit
number

Response

OK

_metadata
object
required
calendars
object[]
required