{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phorest Third-Party Appointments Branches API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Branches",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List branches",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "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 a business's branches (locations). Confirmed: developer.phorest.com/reference/getbranches."
        },
        {
          "info": {
            "name": "Retrieve a branch's work time table",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/worktimetable",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              },
              {
                "name": "branchId",
                "value": "",
                "type": "path",
                "description": "The Phorest branch (location) identifier."
              }
            ]
          },
          "docs": "Returns the branch's opening hours / work-time table. Confirmed to exist: developer.phorest.com/reference/getbranchworktimetable; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "List treatment rooms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/room",
            "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": "updated_from",
                "value": "",
                "type": "query"
              },
              {
                "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 treatment rooms for a branch, filterable by update date and archived status. Confirmed: developer.phorest.com/reference/getrooms."
        },
        {
          "info": {
            "name": "Retrieve a treatment room",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/room/:roomId",
            "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": "roomId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a single room by ID. Confirmed to exist: developer.phorest.com/reference/getroom; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "List machines",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/machine",
            "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": "updated_from",
                "value": "",
                "type": "query"
              },
              {
                "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 equipment/machines for a branch, filterable by update date and archived status. Confirmed: developer.phorest.com/reference/getmachines."
        },
        {
          "info": {
            "name": "Retrieve a machine",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/machine/:machineId",
            "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": "machineId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a single machine by ID. Confirmed to exist: developer.phorest.com/reference/getmachine; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "List tax rates",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/taxrate",
            "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": "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 tax rates configured for a branch. Confirmed: developer.phorest.com/reference/gettaxrates."
        },
        {
          "info": {
            "name": "Retrieve a tax rate",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/taxrate/:taxRateId",
            "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": "taxRateId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieves a single tax rate by ID. Confirmed to exist: developer.phorest.com/reference/gettaxrate; sub-path modeled by convention."
        }
      ]
    }
  ],
  "bundled": true
}