{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phorest Third-Party Appointments Courses API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Courses",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List course templates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/course",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              },
              {
                "name": "includeArchived",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "Records per page. Max 100, defaults to 20."
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "Zero-indexed page number. Defaults to 0."
              }
            ]
          },
          "docs": "Lists prepaid-session course templates (e.g. \"10-session laser hair removal\") offered at a branch. Confirmed: developer.phorest.com/reference/getcourses."
        },
        {
          "info": {
            "name": "List a client's purchased courses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/client/:clientId/course",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              },
              {
                "name": "clientId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Lists the course instances a client has purchased, with remaining session counts. Confirmed to exist: developer.phorest.com/reference/getclientcourses; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "Retrieve a client's course",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/client/:clientId/course/:courseId",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              },
              {
                "name": "clientId",
                "value": "",
                "type": "path"
              },
              {
                "name": "courseId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a single client course instance by ID. Confirmed to exist: developer.phorest.com/reference/getclientcourse; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "Update a client's course",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/client/:clientId/course/:courseId",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              },
              {
                "name": "clientId",
                "value": "",
                "type": "path"
              },
              {
                "name": "courseId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates a client course instance (for example, adjusting remaining sessions). Confirmed to exist: developer.phorest.com/reference/updateclientcourse; sub-path modeled by convention."
        }
      ]
    }
  ],
  "bundled": true
}