Search a Schedule by Event

Request

Search for a schedule based on the appointment or event linked to it, or based on the associated appointment or event.

Security

BearerPartnerUser

Path

location_idnumberrequired

ID of a location.

Example:123

entity_typestringrequired

Type of an entity schedule is searched by:
record - individual appointment, currently not supported;
activity - group event.

Enum:"record""activity"

Example:activity

entity_idnumberrequired

ID of an entity schedule is searched by.

Example:123

Query

includeArray of strings

Requested set of an included models.

Items Enum:"days""days.events_master""days.events_labels""days.events_resource_instances"

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/search/activity/123?include=days' \
  -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

dataobject(Object of model "Schedule")

Data for an existing schedule in a location.

Example:

{
  "id": 123,
  "created_at": "2026-01-01T12:12:12-05:00",
  "updated_at": "2026-01-01T12:12:12-05:00",
  "deleted_at": null,
  "original_entity_type": "activity",
  "original_entity_id": 123,
  "date_start": "2026-01-01",
  "date_end": "2026-02-01",
  "days": [
    { … }
  ]
}

metaArray of any or object(Empty meta object)

Additional response data (empty object or empty array)

Example:

{}

Response

{
  "success": true,
  "data": {
    "id": 123,
    "created_at": "2026-01-01T12:12:12-05:00",
    "updated_at": "2026-01-01T12:12:12-05:00",
    "deleted_at": null,
    "original_entity_type": "activity",
    "original_entity_id": 123,
    "date_start": "2026-01-01",
    "date_end": "2026-02-01",
    "days": [ … ]
  },
  "meta": {}
}