{
  "opencollection": "1.0.0",
  "info": {
    "name": "Phorest Third-Party Appointments Leads API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Leads",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List marketing leads",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/leads",
            "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": "name",
                "value": "",
                "type": "query"
              },
              {
                "name": "status",
                "value": "",
                "type": "query"
              },
              {
                "name": "contactableByEmail",
                "value": "",
                "type": "query"
              },
              {
                "name": "contactableByMobile",
                "value": "",
                "type": "query"
              },
              {
                "name": "fetchMessageHistory",
                "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 marketing leads for a branch, filterable by name, status, and contactability. Confirmed: developer.phorest.com/reference/getleads."
        },
        {
          "info": {
            "name": "Retrieve lead statistics",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/branch/:branchId/leads/stats",
            "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": "Retrieves aggregate lead statistics for a branch. Confirmed to exist: developer.phorest.com/reference/getleadsstats; sub-path modeled by convention."
        },
        {
          "info": {
            "name": "Create a lead",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api-gateway-eu.phorest.com/third-party-api-server/api/business/:businessId/lead",
            "params": [
              {
                "name": "businessId",
                "value": "",
                "type": "path",
                "description": "The Phorest business (salon group) identifier."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a marketing lead (e.g. from a website contact form). Confirmed to exist: developer.phorest.com/reference/createlead; sub-path modeled by convention."
        }
      ]
    }
  ],
  "bundled": true
}