PHphorest
Course

List courses

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

get/api/business/{businessId}/branch/{branchId}/course

Request

Path parameters

businessIdstring required
branchIdstring required

Query parameters

includeArchivedboolean

include archived courses in the list

number of course records to return, max is 200

page number, default is 0 and is optional

Response

Courses listed

Example response

{
  "_embedded": {
    "courses": [
      {
        "courseId": "ab123",
        "courseName": "10 x Massage",
        "availableOnline": true,
        "multiBranchCourse": true,
        "minDaysBetweenSessions": 7,
        "maxDaysBetweenSessions": 30,
        "totalPrice": 100,
        "courseItems": [
          {
            "courseItemId": "ab123",
            "unitType": "SESSIONS, MINUTES",
            "totalUnits": 10,
            "totalPrice": 100,
            "serviceId": "service1"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.