Schedule

Get service provider availability

get

Retrieves the schedule for a specific service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/service-provider-scheduling/{serviceProviderId}/schedule

HTTPcURLJavaScriptPython

GET /api/service-provider-scheduling/{serviceProviderId}/schedule HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "name": "text",
  "default": true,
  "type": "DATE_WISE",
  "disabled": true,
  "serviceProviderId": 1,
  "attributes": {},
  "periods": [
    {
      "dayOfWeek": 1,
      "startTime": "text",
      "endTime": "text",
      "belongsToDayOfWeek": 1
    }
  ],
  "overrides": [
    {
      "date": "2025-06-15",
      "startTime": "08:00:00",
      "endTime": "17:00:00",
      "unavailable": true,
      "startDateTime": "2025-06-15T08:00:00",
      "endDateTime": "2025-06-15T17:00:00",
      "externalId": "1234567890"
    }
  ]
}

Create service provider schedule

post

Creates a new schedule for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

Body

application/json

idnumberOptional

The id of the schedule

Example: 1

serviceProviderIdnumberOptional

The id of the service provider

Example: 1

namestringRequired

The name of the schedule

Example: Schedule 1

typestring · enumOptional

The type of the schedule

Example: DAY_WISEPossible values:

defaultbooleanOptional

Whether the schedule is the default schedule

Example: true

disabledbooleanOptional

Whether the schedule is disabled

Example: true

attributesobjectOptional

The attributes of the schedule

Example: {"key":"value"}

undefinedanyRequired

Responses

200Success

application/json

post

/api/service-provider-scheduling/{serviceProviderId}/schedule

HTTPcURLJavaScriptPython

POST /api/service-provider-scheduling/{serviceProviderId}/schedule HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "id": 1,
  "serviceProviderId": 1,
  "name": "Schedule 1",
  "type": "DAY_WISE",
  "default": true,
  "disabled": true,
  "attributes": {
    "key": "value"
  },
  "periods": [
    {
      "dayOfWeek": 1,
      "startTime": "09:00:00",
      "endTime": "17:00:00"
    }
  ],
  "overrides": [
    {
      "date": "2025-01-01",
      "startTime": "09:00:00",
      "endTime": "17:00:00"
    }
  ],
  "undefined": null
}

200Success

{
  "id": 1,
  "name": "text",
  "default": true,
  "type": "DATE_WISE",
  "disabled": true,
  "serviceProviderId": 1,
  "attributes": {},
  "periods": [
    {
      "dayOfWeek": 1,
      "startTime": "text",
      "endTime": "text",
      "belongsToDayOfWeek": 1
    }
  ],
  "overrides": [
    {
      "date": "2025-06-15",
      "startTime": "08:00:00",
      "endTime": "17:00:00",
      "unavailable": true,
      "startDateTime": "2025-06-15T08:00:00",
      "endDateTime": "2025-06-15T17:00:00",
      "externalId": "1234567890"
    }
  ]
}

Get service provider schedule by ID

get

Retrieves a specific schedule for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

scheduleIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/service-provider-scheduling/{serviceProviderId}/schedule/{scheduleId}

HTTPcURLJavaScriptPython

GET /api/service-provider-scheduling/{serviceProviderId}/schedule/{scheduleId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "name": "text",
  "default": true,
  "type": "DATE_WISE",
  "disabled": true,
  "serviceProviderId": 1,
  "attributes": {},
  "periods": [
    {
      "dayOfWeek": 1,
      "startTime": "text",
      "endTime": "text",
      "belongsToDayOfWeek": 1
    }
  ],
  "overrides": [
    {
      "date": "2025-06-15",
      "startTime": "08:00:00",
      "endTime": "17:00:00",
      "unavailable": true,
      "startDateTime": "2025-06-15T08:00:00",
      "endDateTime": "2025-06-15T17:00:00",
      "externalId": "1234567890"
    }
  ]
}

Update service provider schedule

put

Updates an existing schedule for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

serviceProviderScheduleIdstringRequiredPattern: [^\/#\?]+?

Body

application/json

idnumberOptional

The id of the schedule

Example: 1

serviceProviderIdnumberOptional

The id of the service provider

Example: 1

namestringRequired

The name of the schedule

Example: Schedule 1

typestring · enumOptional

The type of the schedule

Example: DAY_WISEPossible values:

defaultbooleanOptional

Whether the schedule is the default schedule

Example: true

disabledbooleanOptional

Whether the schedule is disabled

Example: true

attributesobjectOptional

The attributes of the schedule

Example: {"key":"value"}

undefinedanyRequired

Responses

200Success

application/json

put

/api/service-provider-scheduling/{serviceProviderId}/schedule/{serviceProviderScheduleId}

HTTPcURLJavaScriptPython

PUT /api/service-provider-scheduling/{serviceProviderId}/schedule/{serviceProviderScheduleId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "id": 1,
  "serviceProviderId": 1,
  "name": "Schedule 1",
  "type": "DAY_WISE",
  "default": true,
  "disabled": true,
  "attributes": {
    "key": "value"
  },
  "periods": [
    {
      "dayOfWeek": 1,
      "startTime": "09:00:00",
      "endTime": "17:00:00"
    }
  ],
  "overrides": [
    {
      "date": "2025-01-01",
      "startTime": "09:00:00",
      "endTime": "17:00:00"
    }
  ],
  "undefined": null
}

200Success

{
  "id": 1,
  "name": "text",
  "default": true,
  "type": "DATE_WISE",
  "disabled": true,
  "serviceProviderId": 1,
  "attributes": {},
  "periods": [
    {
      "dayOfWeek": 1,
      "startTime": "text",
      "endTime": "text",
      "belongsToDayOfWeek": 1
    }
  ],
  "overrides": [
    {
      "date": "2025-06-15",
      "startTime": "08:00:00",
      "endTime": "17:00:00",
      "unavailable": true,
      "startDateTime": "2025-06-15T08:00:00",
      "endDateTime": "2025-06-15T17:00:00",
      "externalId": "1234567890"
    }
  ]
}

Delete service provider schedule

delete

Deletes a specific schedule for a service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

serviceProviderIdstringRequiredPattern: [^\/#\?]+?

serviceProviderScheduleIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/service-provider-scheduling/{serviceProviderId}/schedule/{serviceProviderScheduleId}

HTTPcURLJavaScriptPython

DELETE /api/service-provider-scheduling/{serviceProviderId}/schedule/{serviceProviderScheduleId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "name": "text",
  "default": true,
  "type": "DATE_WISE",
  "disabled": true,
  "serviceProviderId": 1,
  "attributes": {},
  "periods": [
    {
      "dayOfWeek": 1,
      "startTime": "text",
      "endTime": "text",
      "belongsToDayOfWeek": 1
    }
  ],
  "overrides": [
    {
      "date": "2025-06-15",
      "startTime": "08:00:00",
      "endTime": "17:00:00",
      "unavailable": true,
      "startDateTime": "2025-06-15T08:00:00",
      "endDateTime": "2025-06-15T17:00:00",
      "externalId": "1234567890"
    }
  ]
}