---
title: "List courses"
method: GET
path: "/api/business/{businessId}/branch/{branchId}/course"
tags: ["Course"]
---

# List courses

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

## 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}/course`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/phorest/apis/third-party-api/docs/api/business/:businessId/branch/:branchId/course/get.ts> (a function with typed inputs; its response is checked against the schema)

Get a list of courses for the specified business id and branch id. There is a possibility to include archived courses

## Path parameters

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

## Query parameters

- `includeArchived` boolean

## Response `200`

Courses listed

- DataPagedModelCourse
  - `_embedded` object
    - `courses` Course[]
      - `courseId` string
      - `courseName` string
      - `availableOnline` boolean
      - `archived` boolean
      - `multiBranchCourse` boolean
      - `minDaysBetweenSessions` integer
      - `maxDaysBetweenSessions` integer
      - `totalPrice` number
      - `courseItems` CourseItem[]
        - `courseItemId` string
        - `unitType` 'SESSIONS' | 'MINUTES'
        - `totalUnits` integer
        - `totalPrice` number
        - `serviceId` string
  - `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)