Skip to content

Available Slots (Batch)

Returns available booking time slots for multiple users, locations, and services at once.

Request

GET /api/oauth/v2/resource/booking/available-slots/batch

HeaderValue
AuthorizationBearer {access_token}

Query parameters

ParameterTypeRequiredDescription
userIds[]string (UUID)YesIDs of the users (multiple allowed)
locationIds[]string (UUID)YesIDs of the locations (multiple allowed)
serviceIds[]string (UUID)YesIDs of the services (multiple allowed)
startDatestring (ISO 8601)YesStart date of the search (e.g. 2026-04-01)
endDatestring (ISO 8601)NoEnd date of the search (default: startDate + 7 days)

Required scope: appointments

Note: The API returns a maximum of 50 time slots per combination. Combinations without an assigned service configuration are skipped.

Note: Each array parameter (userIds[], locationIds[], serviceIds[]) may contain at most 10 entries. The total number of combinations (users × locations × services) must not exceed 50.

Response

Success (200 OK)

json
{
  "data": [
    {
      "user": {
        "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "firstName": "Maria",
        "lastName": "Huber",
        "...": "..."
      },
      "location": {
        "id": "b2c3d4e5-f6a7-8901-bcde-f01234567890",
        "name": "Ordination Wien",
        "...": "..."
      },
      "service": {
        "id": "c3d4e5f6-a7b8-9012-cdef-012345678901",
        "name": "Erstgespräch",
        "...": "..."
      },
      "slots": [
        {
          "start": "2026-04-02T09:00:00+02:00",
          "end": "2026-04-02T10:00:00+02:00"
        }
      ]
    }
  ]
}

Response fields

FieldTypeDescription
data[].userobjectUser (see User Details)
data[].locationobjectLocation (see Location Details)
data[].serviceobjectService (see Service Details)
data[].slots[].startstring (ISO 8601)Start time of the slot
data[].slots[].endstring (ISO 8601)End time of the slot

Note: Times are given in the company's local timezone with UTC offset.

Beispiele
bash
curl -X GET "https://my.offisy.at/api/oauth/v2/resource/booking/available-slots/batch?userIds%5B%5D=b2c3d4e5-f6a7-8901-bcde-f01234567890&locationIds%5B%5D=b2c3d4e5-f6a7-8901-bcde-f01234567890&serviceIds%5B%5D=b2c3d4e5-f6a7-8901-bcde-f01234567890&startDate=2026-04-15T10%3A00%3A00&endDate=2026-04-15T10%3A00%3A00" \
  -H "Authorization: Bearer {access_token}"
Parameter
Zuerst Token anfordern

Possible errors

StatusCodeDescription
400validation_errorRequired parameter missing or UUID is invalid
401invalid_clientInvalid or missing access token
403insufficient_scopeScope appointments not present
404not_foundUser, location, or service not found

Offisy GmbH