---
title: "List Service Allocations"
method: GET
path: "/setup/v1/services/{id}/allocations"
tags: ["Services"]
---

# List Service Allocations

`GET /setup/v1/services/{id}/allocations`

Use this endpoint to return a **List of Service Allocations** for a specified service. A valid **service id** is required. Service allocations are used for **Event type services only** where the events are offered on specific dates and times. Retrieve all allocations for a location by passing in 0 as the service id.

The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

## Path parameters

- `id` string, required

## Query parameters

- `locationId` string
- `resourceId` string
- `startDate` string, date-time
- `endDate` string, date-time
- `offset` integer
- `limit` integer

## Response `200`

service alloaction object

- ServiceAllocationListViewModel
  - `object` string, nullable
  - `url` string, nullable
  - `hasMore` boolean
  - `count` integer
  - `total` integer
  - `data` ServiceAllocationViewModel[], nullable
    - `object` string, nullable
    - `id` string, nullable
    - `locationId` string, nullable
    - `timezoneOffset` integer, nullable
    - `timezoneName` string, nullable
    - `serviceId` string, nullable
    - `serviceName` string, nullable
    - `serviceDescription` string, nullable
    - `serviceImageUrl` string, nullable
    - `serviceDuration` integer
    - `reason` string, nullable
    - `bookingLimit` integer
    - `bookingCount` integer
    - `startDate` string, nullable
    - `endDate` string, nullable
    - `startTime` integer
    - `endTime` integer
    - `repeats` boolean
    - `repeat` RepeatViewModel
      - `frequency` string, nullable
      - `interval` integer
      - `weekdays` string, nullable
      - `monthDay` string, nullable
      - `monthType` string, nullable
    - `deletedStatus` boolean
    - `deletedTime` string, nullable
    - `resourceId` string, nullable
    - `resourceName` string, nullable
    - `resourceDescription` string, nullable
    - `resourceImageUrl` string, nullable
    - `resourcePhone` PhoneViewModel
      - `phoneType` string, nullable
      - `homePhone` string, nullable
      - `mobilePhone` string, nullable
      - `businessPhone` string, nullable
      - `businessPhoneExt` string, nullable
    - `resourceAddress` AddressViewModel
      - `addressLine1` string, nullable
      - `addressLine2` string, nullable
      - `city` string, nullable
      - `state` string, nullable
      - `country` string, nullable
      - `postalCode` string, nullable

## Other responses

- `400` — Missing or invalid values in the request
- `401` — Authorization error.
- `404` — Service was not found

---

[API](https://skmtc.net/onsched/apis/onsched-setup-api.md) · [All operations](https://skmtc.net/onsched/apis/onsched-setup-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onsched/onsched-setup-api/revisions/c5c023458a2f/schema)