---
title: "List service packages"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/package"
tags: ["Service Package"]
---

# List service packages

`GET /api/business/{businessId}/branch/{branchId}/package`

## Request

- Base URL: `http://api-gateway-eu.phorest.com/third-party-api-server`
- URL: `http://api-gateway-eu.phorest.com/third-party-api-server/api/business/{businessId}/branch/{branchId}/package`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/package/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of service packages for the specified business id and branch id. List can be filtered by service category id

## Path parameters

- `businessId` string, required
- `branchId` string, required

## Query parameters

- `category_id` string

## Response `200`

Service packages listed

- DataPagedModelServiceGroupResponse
  - `_embedded` object
    - `serviceGroups` ServiceGroupResponse[]
      - `serviceGroupId` string
      - `serviceGroupName` string
      - `serviceGroupDescription` string
      - `categoryId` string
      - `availableOnline` boolean
      - `numberOfPeople` integer
      - `startDate` string, date
      - `endDate` string, date
      - `maxConcurrent` integer
      - `maxPerDay` integer
      - `excludedStaffIds` string[]
      - `availablePeriods` AvailablePeriod[]
        - `everyDay` boolean
        - `day` string
        - `allDay` boolean
        - `startTime` LocalTime
          - `millisOfSecond` integer
          - `millisOfDay` integer
          - `secondOfMinute` integer
          - `minuteOfHour` integer
          - `hourOfDay` integer
          - `chronology` Chronology
            - `zone` DateTimeZone
              - …
          - `fieldTypes` DateTimeFieldType[]
            - `durationType` DurationFieldType
              - …
            - `rangeDurationType` DurationFieldType
              - …
            - `name` string
          - `values` integer[]
          - `fields` DateTimeField[]
            - `rangeDurationField` DurationField
              - …
            - `durationField` DurationField
              - …
            - `leapDurationField` DurationField
              - …
            - `minimumValue` integer
            - `maximumValue` integer
            - `name` string
            - `supported` boolean
            - `type` DateTimeFieldType
              - …
            - `lenient` boolean
        - `endTime` LocalTime
          - `millisOfSecond` integer
          - `millisOfDay` integer
          - `secondOfMinute` integer
          - `minuteOfHour` integer
          - `hourOfDay` integer
          - `chronology` Chronology
            - `zone` DateTimeZone
              - …
          - `fieldTypes` DateTimeFieldType[]
            - `durationType` DurationFieldType
              - …
            - `rangeDurationType` DurationFieldType
              - …
            - `name` string
          - `values` integer[]
          - `fields` DateTimeField[]
            - `rangeDurationField` DurationField
              - …
            - `durationField` DurationField
              - …
            - `leapDurationField` DurationField
              - …
            - `minimumValue` integer
            - `maximumValue` integer
            - `name` string
            - `supported` boolean
            - `type` DateTimeFieldType
              - …
            - `lenient` boolean
      - `serviceGroupItems` ServiceGroupItem[]
        - `serviceGroupItemOptions` ServiceGroupItemOption[]
          - `serviceId` string
          - `serviceGroupItemOptionId` string
          - `price` number
          - `priceStaffCategories` PriceStaffCategory[]
            - `id` string
            - `price` number
  - `page` PageMetadata
    - `size` integer
    - `totalElements` integer
    - `totalPages` integer
    - `number` integer

## Other responses

- `400`: Bad Request
- `404`: Business or branch with the specified ids don't exist
- `429`: Request rate limit exceeded. Current limit set to 100 rps.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/phorest/apis/third-party-api.md) - [All operations](https://skmtc.dev/phorest/apis/third-party-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phorest/apis/third-party-api/revisions/beea6ef29634?raw)