Get a List of Scheduled Appointments and Events

Request

Prints a list of events of scheduled records/activities.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

schedule_idintegerrequired

ID of a schedule.

Example:123

day_idnumberrequired

ID of a schedule series.

Example:123

Acceptstringrequired

Required B2B v2 response media type. Use application/vnd.api.v2+json. A charset parameter is also accepted.

Default:"application/vnd.api.v2+json"

Example:application/vnd.api.v2+json

Content-Typestringrequired

Should be equal to application/json

Example:application/json

curl -i -X GET \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/123/schedules/123/days/123/events \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json

successboolean(Successful response status)

Response status.

Example:true

dataArray of objects(Object of model "Event of appointment/event in a Schedule")

Example:

[
  {
    "id": 123,
    "created_at": "2026-01-01T12:12:12-05:00",
    "updated_at": "2026-01-01T12:12:12-05:00",
    "deleted_at": null,
    "event_status": "stable",
    "event_datetime": "2026-01-24T14:00:00-05:00",
    "event_entity_type": "activity",
    "event_entity_id": 123,
    "is_entity_master_changed": false,
    "is_entity_datetime_changed": false,
    "is_entity_duration_changed": false,
    "is_entity_labels_changed": false,
    "is_entity_resource_instances_changed": false,
    "entity_master": { … },
    "entity_datetime": "2022-01-24 14:00:00",
    "entity_duration": 3600,
    "entity_labels": [ … ],
    "entity_resource_instances": [ … ]
  }
]

metaobject(Meta object with response results count)

Additional response data.

Response

{
  "success": true,
  "data": [
    { … }
  ],
  "meta": {
    "count": 10
  }
}