Appointment Availability

Query live availability and per-date capacity data to determine when appointments can be booked, and manage the schedule tracking records that back the booking engine.

Before You Begin

GET /v1/appointment-slots/availability and GET /v1/appointment-slots/schedule-tracking require the slots:read scope.
PATCH /v1/appointment-slots/tracking/:slot_id and POST /v1/appointment-slots/regenerate require the slots:write scope.

Get Availability

Returns all open calendar windows for a specific date, with live filled and available slot counts.

Endpoint: GET https://api.huskyvoice.ai/v1/appointment-slots/availability
Required scope: slots:read

Parameter	Required	Description
`date`	Yes	Date to check — `YYYY-MM-DD`
`branch_id`	No	Filter by branch UUID
`session`	No	Filter by session: `Morning`, `Afternoon`, or `Evening`

cURL
Python
JavaScript
n8n

curl -s "https://api.huskyvoice.ai/v1/appointment-slots/availability?date=2026-06-15&session=Morning" \
  -H "x-api-key: YOUR_API_KEY"

import requests

url = "https://api.huskyvoice.ai/v1/appointment-slots/availability"
headers = {"x-api-key": "YOUR_API_KEY"}
params = {"date": "2026-06-15", "session": "Morning"}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const params = new URLSearchParams({ date: "2026-06-15", session: "Morning" });
const response = await fetch(
  `https://api.huskyvoice.ai/v1/appointment-slots/availability?${params}`,
  { headers: { "x-api-key": "YOUR_API_KEY" } }
);
const data = await response.json();
console.log(data);

Credential setup

Create an HTTP Header Auth credential in n8n: set Name to x-api-key and Value to YOUR_API_KEY. Select it in the HTTP Request node's Authentication field.

{
  "name": "HuskyVoice – Get Availability",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.huskyvoice.ai/v1/appointment-slots/availability",
        "authentication": "genericCredentialType",
        "genericAuthType": "httpHeaderAuth",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            { "name": "date", "value": "2026-06-15" },
            { "name": "session", "value": "Morning" }
          ]
        }
      },
      "id": "1",
      "name": "Get Availability",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [250, 300]
    }
  ],
  "connections": {},
  "settings": {},
  "meta": { "instanceId": "huskyvoice-docs" }
}

Response — 200 OK

{
  "success": true,
  "date": "2026-07-15",
  "slots": [
    {
      "slot_id": "f3c2b61b-52d9-4a71-8ae8-63f4464711b9||2026-07-15",
      "calendar_id": "f3c2b61b-52d9-4a71-8ae8-63f4464711b9",
      "parent_calendar_id": null,
      "branch_id": "5dd088a7-285a-405a-a0de-1c6ff0e9bd78",
      "day": "wednesday",
      "session": "evening",
      "batch": "A",
      "start_time": "15:30",
      "end_time": "16:00",
      "appointment_type": null,
      "max_slots": 12,
      "ai_slots": 12,
      "filled_slots": 0,
      "available_slots": 12,
      "status": "OPEN",
      "created_at": "2026-06-19T06:14:13.944Z",
      "updated_at": "2026-07-06T04:43:50.249Z"
    }
  ]
}

Get Schedule Tracking

Returns per-date schedule tracking records — the persistent fill-count projections the booking engine maintains for each calendar window and date.

Endpoint: GET https://api.huskyvoice.ai/v1/appointment-slots/schedule-tracking
Required scope: slots:read

Parameter	Required	Description
`date_from`	Yes	Start date — `YYYY-MM-DD`
`date_to`	No	End date — `YYYY-MM-DD` (defaults to `date_from` if omitted)
`branch_id`	No	Filter by branch UUID
`appointment_type_id`	No	Filter by service UUID
`session`	No	Filter by session

cURL
Python
JavaScript
n8n

curl -s "https://api.huskyvoice.ai/v1/appointment-slots/schedule-tracking?date_from=2026-06-15&date_to=2026-06-21" \
  -H "x-api-key: YOUR_API_KEY"

import requests

url = "https://api.huskyvoice.ai/v1/appointment-slots/schedule-tracking"
headers = {"x-api-key": "YOUR_API_KEY"}
params = {
    "date_from": "2026-06-15",
    "date_to": "2026-06-21"
}

response = requests.get(url, headers=headers, params=params)
print(response.json())

const params = new URLSearchParams({
  date_from: "2026-06-15",
  date_to: "2026-06-21"
});
const response = await fetch(
  `https://api.huskyvoice.ai/v1/appointment-slots/schedule-tracking?${params}`,
  { headers: { "x-api-key": "YOUR_API_KEY" } }
);
const data = await response.json();
console.log(data);

Credential setup

Create an HTTP Header Auth credential in n8n: set Name to x-api-key and Value to YOUR_API_KEY. Select it in the HTTP Request node's Authentication field.

{
  "name": "HuskyVoice – Get Schedule Tracking",
  "nodes": [
    {
      "parameters": {
        "method": "GET",
        "url": "https://api.huskyvoice.ai/v1/appointment-slots/schedule-tracking",
        "authentication": "genericCredentialType",
        "genericAuthType": "httpHeaderAuth",
        "sendQuery": true,
        "queryParameters": {
          "parameters": [
            { "name": "date_from", "value": "2026-06-15" },
            { "name": "date_to", "value": "2026-06-21" }
          ]
        }
      },
      "id": "1",
      "name": "Get Schedule Tracking",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [250, 300]
    }
  ],
  "connections": {},
  "settings": {},
  "meta": { "instanceId": "huskyvoice-docs" }
}

Response — 200 OK

{
  "success": true,
  "data": [
    {
      "slot_id": "f3c2b61b-52d9-4a71-8ae8-63f4464711b9||2026-07-15||",
      "calendar_id": "f3c2b61b-52d9-4a71-8ae8-63f4464711b9",
      "appointment_type_id": null,
      "appointment_type_name": null,
      "date": "2026-07-15",
      "day_of_week": "wednesday",
      "session": "Evening",
      "batch": "A",
      "start_time": "15:30",
      "end_time": "16:00",
      "max_slots": 12,
      "ai_slots": 12,
      "filled_slots": 0,
      "agent_filled": 0,
      "available_slots": 12,
      "status": "OPEN",
      "child_types": [
        "42031a9f-368a-46ee-ba4a-724d744f9c03",
        "13af12ed-4c62-46cb-ae77-88819d3ab4ee",
        "1ef5c539-c545-4c70-a9bd-482cbf62cdf1"
      ]
    }
  ]
}

Update a Schedule Tracking Record

Override the status or max_slots for a specific date's tracking record. Filled and available counts are always computed from live appointment data and cannot be set directly.

Endpoint: PATCH https://api.huskyvoice.ai/v1/appointment-slots/tracking/{slot_id}
Required scope: slots:write

The {slot_id} must be the 3-part format from a schedule-tracking response: calendar_id||YYYY-MM-DD||appointment_type_id.

cURL
Python
JavaScript
n8n

curl -s -X PATCH \
  "https://api.huskyvoice.ai/v1/appointment-slots/tracking/a1b2c3d4-e5f6-7890-abcd-ef1234567890||2026-06-15||f47ac10b-58cc-4372-a567-0e02b2c3d479" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "CLOSED"}'

import requests

slot_id = "a1b2c3d4-e5f6-7890-abcd-ef1234567890||2026-06-15||f47ac10b-58cc-4372-a567-0e02b2c3d479"
url = f"https://api.huskyvoice.ai/v1/appointment-slots/tracking/{slot_id}"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {"status": "CLOSED"}

response = requests.patch(url, json=payload, headers=headers)
print(response.json())

const slotId = "a1b2c3d4-e5f6-7890-abcd-ef1234567890||2026-06-15||f47ac10b-58cc-4372-a567-0e02b2c3d479";
const response = await fetch(
  `https://api.huskyvoice.ai/v1/appointment-slots/tracking/${encodeURIComponent(slotId)}`,
  {
    method: "PATCH",
    headers: {
      "x-api-key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({ status: "CLOSED" })
  }
);
const data = await response.json();
console.log(data);

Credential setup

Create an HTTP Header Auth credential in n8n: set Name to x-api-key and Value to YOUR_API_KEY. Select it in the HTTP Request node's Authentication field.

{
  "name": "HuskyVoice – Update Tracking Record",
  "nodes": [
    {
      "parameters": {
        "method": "PATCH",
        "url": "https://api.huskyvoice.ai/v1/appointment-slots/tracking/a1b2c3d4-e5f6-7890-abcd-ef1234567890||2026-06-15||f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "authentication": "genericCredentialType",
        "genericAuthType": "httpHeaderAuth",
        "sendBody": true,
        "specifyBody": "json",
        "jsonBody": "{\n  \"status\": \"CLOSED\"\n}"
      },
      "id": "1",
      "name": "Update Tracking Record",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [250, 300]
    }
  ],
  "connections": {},
  "settings": {},
  "meta": { "instanceId": "huskyvoice-docs" }
}

Response — 200 OK

{
  "success": true,
  "data": {
    "_id": "6a4d45c9f01a52acd5487fea",
    "org_id": "8ba8b0bf-c63e-421c-b22d-1f64a964c155",
    "batch_name": "A",
    "date_str": "2026-07-15",
    "appointment_type_id": null,
    "branch_id": "5dd088a7-285a-405a-a0de-1c6ff0e9bd78",
    "calendar_id": "f3c2b61b-52d9-4a71-8ae8-63f4464711b9",
    "date": "2026-07-14T18:30:00.000Z",
    "day_of_week": "wednesday",
    "session": "Evening",
    "batch_start": "15:30",
    "batch_end": "16:00",
    "max_slots": 12,
    "max_agent_slots": 12,
    "agent_filled": 0,
    "prebooking_filled": 0,
    "walkin_filled": 0,
    "total_filled": 0,
    "available": 12,
    "status": "OPEN",
    "max_slots_overridden": true
  }
}

Field	Description
`status`	`"OPEN"` or `"CLOSED"` — overrides the window's status for this date only
`max_slots`	Override the slot capacity for this date only

Regenerate Schedule Tracking

Recreates schedule tracking records for a date range from the current calendar window definitions. Use this after making changes to calendar windows to ensure the per-date projections are up to date.

Endpoint: POST https://api.huskyvoice.ai/v1/appointment-slots/regenerate
Required scope: slots:write

cURL
Python
JavaScript
n8n

curl -s -X POST https://api.huskyvoice.ai/v1/appointment-slots/regenerate \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date_from": "2026-06-15", "date_to": "2026-06-30"}'

import requests

url = "https://api.huskyvoice.ai/v1/appointment-slots/regenerate"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "date_from": "2026-06-15",
    "date_to": "2026-06-30"
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

const response = await fetch(
  "https://api.huskyvoice.ai/v1/appointment-slots/regenerate",
  {
    method: "POST",
    headers: {
      "x-api-key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({ date_from: "2026-06-15", date_to: "2026-06-30" })
  }
);
const data = await response.json();
console.log(data);

Credential setup

Create an HTTP Header Auth credential in n8n: set Name to x-api-key and Value to YOUR_API_KEY. Select it in the HTTP Request node's Authentication field.

{
  "name": "HuskyVoice – Regenerate Schedule Tracking",
  "nodes": [
    {
      "parameters": {
        "method": "POST",
        "url": "https://api.huskyvoice.ai/v1/appointment-slots/regenerate",
        "authentication": "genericCredentialType",
        "genericAuthType": "httpHeaderAuth",
        "sendBody": true,
        "specifyBody": "json",
        "jsonBody": "{\n  \"date_from\": \"2026-06-15\",\n  \"date_to\": \"2026-06-30\"\n}"
      },
      "id": "1",
      "name": "Regenerate Schedule Tracking",
      "type": "n8n-nodes-base.httpRequest",
      "typeVersion": 4.2,
      "position": [250, 300]
    }
  ],
  "connections": {},
  "settings": {},
  "meta": { "instanceId": "huskyvoice-docs" }
}

Field	Required	Description
`date_from`	Yes	Start of the regeneration range — `YYYY-MM-DD`
`date_to`	No	End of the range — `YYYY-MM-DD` (defaults to `date_from` if omitted)

Response — 200 OK

{
  "success": true,
  "processed": 16,
  "skipped": 0,
  "errors": 0,
  "upserted": 16
}

Error Codes

Status	Code	Cause
`400`	`VALIDATION_ERROR`	Missing required parameter (`date` or `date_from`)
`404`	`NOT_FOUND`	Schedule tracking record not found (PATCH only)
`403`	`INSUFFICIENT_SCOPE`	API key does not have the required scope

Before You Begin​

Get Availability​

Get Schedule Tracking​

Update a Schedule Tracking Record​

Regenerate Schedule Tracking​

Error Codes​

Before You Begin

Get Availability

Get Schedule Tracking

Update a Schedule Tracking Record

Regenerate Schedule Tracking

Error Codes