Skip to main content
GET
/
appointments
List Appointments
curl --request GET \
  --url https://crm.universal.rollout.com/api/appointments \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Rollout-Credential-Id: <api-key>'
{
  "_metadata": {
    "collection": "<string>",
    "offset": 123,
    "limit": 123,
    "total": 123,
    "next": "<string>",
    "nextLink": "<string>"
  },
  "appointments": [
    {
      "id": "<string>",
      "personId": "<string>",
      "userId": "<string>",
      "createdById": "<string>",
      "updatedById": "<string>",
      "appointmentOutcomeId": "<string>",
      "appointmentTypeId": "<string>",
      "invitees": [
        {
          "userId": "<string>",
          "personId": "<string>"
        }
      ],
      "title": "<string>",
      "description": "<string>",
      "location": "<string>",
      "isAllDay": true,
      "type": "<string>",
      "outcome": "<string>",
      "outcomeReason": "<string>",
      "startsAt": "<string>",
      "endsAt": "<string>",
      "created": "<string>",
      "updated": "<string>",
      "rolloutUpdated": "<string>",
      "originalIds": {},
      "original": {}
    }
  ]
}

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
default:0

Response

OK

_metadata
object
required
appointments
object[]
required