{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phorest Third-Party Appointments Staff API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Staff",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List staff",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff",
            "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": "updatedAfter",
                "value": "",
                "type": "query"
              },
              {
                "name": "updatedBefore",
                "value": "",
                "type": "query"
              },
              {
                "name": "fetch_archived",
                "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 staff for a branch, filterable by update time and archived status. Confirmed: developer.phorest.com/reference/getstafflist."
        },
        {
          "info": {
            "name": "Retrieve a staff member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff/:staffId",
            "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": "staffId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a single staff member by ID. Confirmed to exist: developer.phorest.com/reference/getstaff; sub-path modeled by convention with the confirmed collection path."
        },
        {
          "info": {
            "name": "List staff work time tables (rota)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff-work-time-table",
            "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": "from_date",
                "value": "",
                "type": "query"
              },
              {
                "name": "to_date",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Returns staff work-time entries (rota) for a date range. This endpoint does not support pagination and always returns all records for the given range. Confirmed: developer.phorest.com/reference/getstaffworktimetables."
        },
        {
          "info": {
            "name": "List a staff member's breaks",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff/:staffId/break",
            "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": "staffId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Lists breaks scheduled for a staff member. Confirmed to exist: developer.phorest.com/reference/getbreaks; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "Create a staff break",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff/:staffId/break",
            "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": "staffId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a break on a staff member's rota. Confirmed to exist: developer.phorest.com/reference/createbreak; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "Retrieve a staff break",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff/:staffId/break/:breakId",
            "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": "staffId",
                "value": "",
                "type": "path"
              },
              {
                "name": "breakId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a single break by ID. Confirmed to exist: developer.phorest.com/reference/getstaffbreak; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "Update a staff break",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff/:staffId/break/:breakId",
            "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": "staffId",
                "value": "",
                "type": "path"
              },
              {
                "name": "breakId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing break. Confirmed to exist: developer.phorest.com/reference/updatebreak; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "Delete a staff break",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/staff/:staffId/break/:breakId",
            "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": "staffId",
                "value": "",
                "type": "path"
              },
              {
                "name": "breakId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Deletes a break. Confirmed to exist: developer.phorest.com/reference/deletebreak; sub-path modeled by convention."
        }
      ]
    }
  ],
  "bundled": true
}