Skip to main content
GET
/
v1
/
scheduling
/
actors
Search booking entities (actors)
curl --request GET \
  --url https://api.haau3.com/v1/scheduling/actors \
  --header 'Authorization: Bearer <token>'
{
  "actors": [
    {
      "key": "<string>",
      "publisher": "<string>",
      "serviceTypes": [
        {
          "code": "<string>",
          "display": "<string>"
        }
      ],
      "totalSlots": 4503599627370495,
      "provider": {
        "id": "<string>",
        "identifier": [
          {
            "value": "<string>",
            "system": "<string>"
          }
        ],
        "name": "<string>",
        "specialty": "<string>",
        "npi": "<string>"
      },
      "location": {
        "id": "<string>",
        "identifier": [
          {
            "value": "<string>",
            "system": "<string>"
          }
        ],
        "name": "<string>",
        "phone": [
          "<string>"
        ],
        "website": [
          "<string>"
        ],
        "addressLine": [
          "<string>"
        ],
        "city": "<string>",
        "state": "<string>",
        "postalCode": "<string>"
      },
      "isVirtual": true,
      "nextAvailableStart": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 4503599627370495
}

Authorizations

Authorization
string
header
required

Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.

Query Parameters

status
enum<string>
default:free

Slot availability state to return. Defaults to free.

Available options:
free,
busy,
busy-unavailable,
busy-tentative
publisher
string

Filter to a single publisher (source) by slug — e.g. zocdoc, defacto. See GET /v1/scheduling/publishers for the available slugs.

Minimum string length: 1
serviceTypeCode
string

Filter by service type code (as published by the source).

Minimum string length: 1
appointmentType
string

Filter by appointment type.

Minimum string length: 1
acceptingPatients
enum<string>

Filter to slots accepting patients of this kind (HL7 accepting-patients CodeSystem: newpt | existptonly | existptfam). Slots marked nopt (not accepting patients) are never served, so nopt is not a valid filter value. Lenient: a slot that does not declare an accepting-patients code matches any value (absence never hides a slot); a slot that declares one must equal the requested value.

Available options:
newpt,
existptonly,
existptfam
isVirtual
boolean

Filter to virtual (true) or in-person (false) slots.

city
string

Filter by the location's city.

Minimum string length: 1
state
string

Filter by the location's state.

Minimum string length: 1
startAfter
string<date-time>

Only slots starting at or after this ISO 8601 instant (with offset).

startBefore
string<date-time>

Only slots starting at or before this ISO 8601 instant (with offset).

limit
integer
default:25

Page size — number of actor cards (1–100). Defaults to 25.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of actor cards to skip for pagination. Defaults to 0.

Required range: 0 <= x <= 9007199254740991

Response

Matching booking entities and the total pre-pagination group count.

actors
object[]
required
total
integer
required
Required range: 0 <= x <= 9007199254740991