Available slots service provider info

Get available slots with service provider info

get

Retrieves available appointment slots with service provider information

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

appointmentTypeIdstringOptional

ID of the appointment type

Example: 12345

appointmentTypeTemplateIdstringOptional

ID of the appointment type template

Example: 67890

fromDateone ofOptional

Start date for the filter

Example: 2023-01-01

string · dateOptional

or

string · date-timeOptional

toDateone ofOptional

End date for the filter

Example: 2023-12-31

string · dateOptional

or

string · date-timeOptional

startDateTimeone ofOptional

Start date and time for the filter

Example: 2023-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

endDateTimeone ofOptional

End date and time for the filter

Example: 2023-12-31T23:59:59Z

string · dateOptional

or

string · date-timeOptional

includeBookedSlotsbooleanOptional

Include booked slots in the filter

Example: true

includeServiceProviderLiveLocationbooleanOptional

Include service provider live location in the filter

Example: true

includeServiceProviderStatusbooleanOptional

Include service provider status in the filter

Example: true

memberstringOptional

Member associated with the filter

Example: member123

participantsstringOptional

Participants associated with the filter

Example: participant123

regionstringOptional

Region associated with the filter

Example: region123

addressTitlestringOptional

Address title associated with the filter

Example: address123

partnerIdinteger[]Optional

Partner IDs associated with the filter

Default: []Example: [1,2,3]

patientStatestringOptional

Patient state associated with the filter

Example: state123

serviceProviderIdstringOptional

Service provider ID associated with the filter

Example: provider123

additionalCriteriaanyOptional

populationTagsinteger[]Optional

Tags for access

Default: []Example: [1,2,3]

Responses

200Success

application/json

get

/api/service-provider-scheduling/available-slots-service-provider-info

HTTPcURLJavaScriptPython

GET /api/service-provider-scheduling/available-slots-service-provider-info HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "slots": [
    {
      "startDateTime": "2023-01-01T08:00:00Z",
      "endDateTime": "2023-01-01T09:00:00Z",
      "date": "2023-01-01",
      "startTime": "08:00",
      "endTime": "09:00",
      "durationInMinutes": 60,
      "serviceProviderId": "sp123",
      "displayTitle": "MD",
      "appointmentTypeId": "at123",
      "penaltyScore": 10,
      "penaltyReason": "No penalty",
      "appointmentTypeTemplateId": "att123",
      "booked": true,
      "serviceProviderRole": "doctor",
      "slotsBooked": 1,
      "slotsLeft": 4
    }
  ],
  "serviceProviders": [
    {
      "id": "12345",
      "status": "active",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "roles": [
        "admin",
        "user"
      ],
      "profilePic": "http://example.com/profile.jpg",
      "timeZone": "UTC",
      "attributes": {
        "key": "value"
      },
      "address": [
        {
          "street": "123 Main St",
          "city": "Anytown"
        }
      ],
      "organizationAddresses": [
        {
          "street": "456 Corporate Blvd",
          "city": "Businesstown"
        }
      ],
      "isGroup": true,
      "users": [],
      "displayTitle": "MD",
      "serviceProviderLicenseInfo": [
        {
          "stateOfIssuance": "CA",
          "country": "USA"
        }
      ],
      "partnerId": 1,
      "serviceableRadius": 1,
      "partner": {
        "id": 1,
        "organizationId": 1,
        "name": "text",
        "addressGroup": {
          "id": 12,
          "name": "Name",
          "description": "Lab",
          "region": "New York",
          "type": "LAB",
          "organizationId": 1,
          "active": true,
          "addressGroupMapping": [],
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-01T00:00:00.000Z",
          "addressMappingCount": 1
        },
        "addressGroupId": 1,
        "partnerTypeId": 1,
        "attributes": {},
        "partnerType": {
          "name": "Test Partner Type Name",
          "description": "Test Partner Type Description",
          "partnerType": "CUSTOM",
          "organizationId": 1,
          "active": true,
          "createdAt": "2025-01-01T00:00:00.000Z",
          "updatedAt": "2025-01-01T00:00:00.000Z"
        },
        "active": true,
        "createdAt": "2026-02-06",
        "updatedAt": "2026-02-06"
      }
    }
  ]
}