Action

Get appointment actions

get

Retrieves appointment actions

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Responses

200Success

application/json

get

/api/service-provider-scheduling/appointments/{appointmentId}/action

HTTPcURLJavaScriptPython

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

200Success

[
  {
    "id": 1,
    "appointmentId": 1,
    "organizationActionId": 1,
    "serviceProviderId": 1,
    "action": {
      "id": 1,
      "name": "text",
      "description": "text",
      "order": 1,
      "organizationId": 1,
      "active": true,
      "organization": {
        "id": 12,
        "name": "Azodha",
        "urlCode": "dev-azodha",
        "apiKey": "1v23-v456-a987",
        "accessCode": "asfdg23",
        "addresses": [],
        "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
        "logoUrl": null,
        "description": "This is a test organization",
        "attributes": {},
        "parentOrganizationId": 23,
        "parentOrganization": {
          "id": 12,
          "name": "Azodha",
          "urlCode": "dev-azodha",
          "apiKey": "1v23-v456-a987",
          "accessCode": "asfdg23",
          "addresses": [],
          "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
          "logoUrl": null,
          "description": "This is a test organization",
          "attributes": {},
          "parentOrganizationId": 23,
          "parentOrganization": {
            "id": 12,
            "name": "Azodha",
            "urlCode": "dev-azodha",
            "apiKey": "1v23-v456-a987",
            "accessCode": "asfdg23",
            "addresses": [],
            "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
            "logoUrl": null,
            "description": "This is a test organization",
            "attributes": {},
            "parentOrganizationId": 23,
            "parentOrganization": "[Circular Reference]",
            "childOrganizations": "[Circular Reference]",
            "organizationSettings": [],
            "language": "[Circular Reference]",
            "ehrIntegrations": "[Circular Reference]",
            "webhookConfiguration": [],
            "attributeSchema": [],
            "emailTemplate": [],
            "organizationResourceIntegration": "[Circular Reference]",
            "surveys": "[Circular Reference]",
            "observationGroup": "[Circular Reference]",
            "healthRecordAttribute": [],
            "wearablesApiSync": "[Circular Reference]",
            "aiInferenceUseCases": "[Circular Reference]",
            "workflow": [],
            "organizationModuleMapping": []
          },
          "childOrganizations": [],
          "organizationSettings": [],
          "language": [],
          "ehrIntegrations": [],
          "webhookConfiguration": [],
          "attributeSchema": [],
          "emailTemplate": [],
          "organizationResourceIntegration": [],
          "surveys": [],
          "observationGroup": [],
          "healthRecordAttribute": [],
          "wearablesApiSync": [],
          "aiInferenceUseCases": [],
          "workflow": [],
          "organizationModuleMapping": []
        },
        "childOrganizations": [],
        "organizationSettings": [],
        "language": [],
        "ehrIntegrations": [],
        "webhookConfiguration": [],
        "attributeSchema": [],
        "emailTemplate": [],
        "organizationResourceIntegration": [],
        "surveys": [],
        "observationGroup": [],
        "healthRecordAttribute": [],
        "wearablesApiSync": [],
        "aiInferenceUseCases": [],
        "workflow": [],
        "organizationModuleMapping": []
      },
      "resourceType": "APPOINTMENT",
      "allowedRoles": [
        "OWNER"
      ],
      "nextActionIds": [
        1
      ],
      "appointmentTypeTemplateId": 1,
      "duration": 1,
      "createdAt": "2026-02-07",
      "updatedAt": "2026-02-07",
      "schedulerAppointmentAction": []
    },
    "latitude": 1,
    "longitude": 1,
    "status": "DONE",
    "createdAt": "2026-02-07"
  }
]

Create appointment action

post

Creates an appointment action

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

appointmentIdnumberOptional

organizationActionIdnumberRequired

serviceProviderIdnumberRequired

activebooleanOptional

statusstring · enumOptionalPossible values:

Responses

200Success

application/json

post

/api/service-provider-scheduling/appointments/{appointmentId}/action

HTTPcURLJavaScriptPython

POST /api/service-provider-scheduling/appointments/{appointmentId}/action 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: 96

{
  "appointmentId": 1,
  "organizationActionId": 1,
  "serviceProviderId": 1,
  "active": true,
  "status": "DONE"
}

200Success

{
  "id": 1,
  "appointmentId": 1,
  "organizationActionId": 1,
  "serviceProviderId": 1,
  "action": {
    "id": 1,
    "name": "text",
    "description": "text",
    "order": 1,
    "organizationId": 1,
    "active": true,
    "organization": {
      "id": 12,
      "name": "Azodha",
      "urlCode": "dev-azodha",
      "apiKey": "1v23-v456-a987",
      "accessCode": "asfdg23",
      "addresses": [],
      "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
      "logoUrl": null,
      "description": "This is a test organization",
      "attributes": {},
      "parentOrganizationId": 23,
      "parentOrganization": {
        "id": 12,
        "name": "Azodha",
        "urlCode": "dev-azodha",
        "apiKey": "1v23-v456-a987",
        "accessCode": "asfdg23",
        "addresses": [],
        "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
        "logoUrl": null,
        "description": "This is a test organization",
        "attributes": {},
        "parentOrganizationId": 23,
        "parentOrganization": {
          "id": 12,
          "name": "Azodha",
          "urlCode": "dev-azodha",
          "apiKey": "1v23-v456-a987",
          "accessCode": "asfdg23",
          "addresses": [],
          "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
          "logoUrl": null,
          "description": "This is a test organization",
          "attributes": {},
          "parentOrganizationId": 23,
          "parentOrganization": {
            "id": 12,
            "name": "Azodha",
            "urlCode": "dev-azodha",
            "apiKey": "1v23-v456-a987",
            "accessCode": "asfdg23",
            "addresses": [],
            "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
            "logoUrl": null,
            "description": "This is a test organization",
            "attributes": {},
            "parentOrganizationId": 23,
            "parentOrganization": "[Circular Reference]",
            "childOrganizations": "[Circular Reference]",
            "organizationSettings": [],
            "language": "[Circular Reference]",
            "ehrIntegrations": "[Circular Reference]",
            "webhookConfiguration": [],
            "attributeSchema": [],
            "emailTemplate": [],
            "organizationResourceIntegration": "[Circular Reference]",
            "surveys": "[Circular Reference]",
            "observationGroup": "[Circular Reference]",
            "healthRecordAttribute": [],
            "wearablesApiSync": "[Circular Reference]",
            "aiInferenceUseCases": "[Circular Reference]",
            "workflow": [],
            "organizationModuleMapping": []
          },
          "childOrganizations": [],
          "organizationSettings": [],
          "language": [],
          "ehrIntegrations": [],
          "webhookConfiguration": [],
          "attributeSchema": [],
          "emailTemplate": [],
          "organizationResourceIntegration": [],
          "surveys": [],
          "observationGroup": [],
          "healthRecordAttribute": [],
          "wearablesApiSync": [],
          "aiInferenceUseCases": [],
          "workflow": [],
          "organizationModuleMapping": []
        },
        "childOrganizations": [],
        "organizationSettings": [],
        "language": [],
        "ehrIntegrations": [],
        "webhookConfiguration": [],
        "attributeSchema": [],
        "emailTemplate": [],
        "organizationResourceIntegration": [],
        "surveys": [],
        "observationGroup": [],
        "healthRecordAttribute": [],
        "wearablesApiSync": [],
        "aiInferenceUseCases": [],
        "workflow": [],
        "organizationModuleMapping": []
      },
      "childOrganizations": [],
      "organizationSettings": [],
      "language": [],
      "ehrIntegrations": [],
      "webhookConfiguration": [],
      "attributeSchema": [],
      "emailTemplate": [],
      "organizationResourceIntegration": [],
      "surveys": [],
      "observationGroup": [],
      "healthRecordAttribute": [],
      "wearablesApiSync": [],
      "aiInferenceUseCases": [],
      "workflow": [],
      "organizationModuleMapping": []
    },
    "resourceType": "APPOINTMENT",
    "allowedRoles": [
      "OWNER"
    ],
    "nextActionIds": [
      1
    ],
    "appointmentTypeTemplateId": 1,
    "duration": 1,
    "createdAt": "2026-02-07",
    "updatedAt": "2026-02-07",
    "schedulerAppointmentAction": []
  },
  "latitude": 1,
  "longitude": 1,
  "status": "DONE",
  "createdAt": "2026-02-07"
}

Update appointment action

put

Updates an appointment action

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Body

application/json

appointmentIdnumberOptional

organizationActionIdnumberRequired

serviceProviderIdnumberRequired

activebooleanOptional

statusstring · enumOptionalPossible values:

Responses

200Success

application/json

put

/api/service-provider-scheduling/appointments/{appointmentId}/action/{id}

HTTPcURLJavaScriptPython

PUT /api/service-provider-scheduling/appointments/{appointmentId}/action/{id} 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: 96

{
  "appointmentId": 1,
  "organizationActionId": 1,
  "serviceProviderId": 1,
  "active": true,
  "status": "DONE"
}

200Success

{
  "id": 1,
  "appointmentId": 1,
  "organizationActionId": 1,
  "serviceProviderId": 1,
  "action": {
    "id": 1,
    "name": "text",
    "description": "text",
    "order": 1,
    "organizationId": 1,
    "active": true,
    "organization": {
      "id": 12,
      "name": "Azodha",
      "urlCode": "dev-azodha",
      "apiKey": "1v23-v456-a987",
      "accessCode": "asfdg23",
      "addresses": [],
      "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
      "logoUrl": null,
      "description": "This is a test organization",
      "attributes": {},
      "parentOrganizationId": 23,
      "parentOrganization": {
        "id": 12,
        "name": "Azodha",
        "urlCode": "dev-azodha",
        "apiKey": "1v23-v456-a987",
        "accessCode": "asfdg23",
        "addresses": [],
        "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
        "logoUrl": null,
        "description": "This is a test organization",
        "attributes": {},
        "parentOrganizationId": 23,
        "parentOrganization": {
          "id": 12,
          "name": "Azodha",
          "urlCode": "dev-azodha",
          "apiKey": "1v23-v456-a987",
          "accessCode": "asfdg23",
          "addresses": [],
          "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
          "logoUrl": null,
          "description": "This is a test organization",
          "attributes": {},
          "parentOrganizationId": 23,
          "parentOrganization": {
            "id": 12,
            "name": "Azodha",
            "urlCode": "dev-azodha",
            "apiKey": "1v23-v456-a987",
            "accessCode": "asfdg23",
            "addresses": [],
            "logoId": "118/c7b85a46-0208-4b6b-bb65-476d89d600f01712829554268",
            "logoUrl": null,
            "description": "This is a test organization",
            "attributes": {},
            "parentOrganizationId": 23,
            "parentOrganization": "[Circular Reference]",
            "childOrganizations": "[Circular Reference]",
            "organizationSettings": [],
            "language": "[Circular Reference]",
            "ehrIntegrations": "[Circular Reference]",
            "webhookConfiguration": [],
            "attributeSchema": [],
            "emailTemplate": [],
            "organizationResourceIntegration": "[Circular Reference]",
            "surveys": "[Circular Reference]",
            "observationGroup": "[Circular Reference]",
            "healthRecordAttribute": [],
            "wearablesApiSync": "[Circular Reference]",
            "aiInferenceUseCases": "[Circular Reference]",
            "workflow": [],
            "organizationModuleMapping": []
          },
          "childOrganizations": [],
          "organizationSettings": [],
          "language": [],
          "ehrIntegrations": [],
          "webhookConfiguration": [],
          "attributeSchema": [],
          "emailTemplate": [],
          "organizationResourceIntegration": [],
          "surveys": [],
          "observationGroup": [],
          "healthRecordAttribute": [],
          "wearablesApiSync": [],
          "aiInferenceUseCases": [],
          "workflow": [],
          "organizationModuleMapping": []
        },
        "childOrganizations": [],
        "organizationSettings": [],
        "language": [],
        "ehrIntegrations": [],
        "webhookConfiguration": [],
        "attributeSchema": [],
        "emailTemplate": [],
        "organizationResourceIntegration": [],
        "surveys": [],
        "observationGroup": [],
        "healthRecordAttribute": [],
        "wearablesApiSync": [],
        "aiInferenceUseCases": [],
        "workflow": [],
        "organizationModuleMapping": []
      },
      "childOrganizations": [],
      "organizationSettings": [],
      "language": [],
      "ehrIntegrations": [],
      "webhookConfiguration": [],
      "attributeSchema": [],
      "emailTemplate": [],
      "organizationResourceIntegration": [],
      "surveys": [],
      "observationGroup": [],
      "healthRecordAttribute": [],
      "wearablesApiSync": [],
      "aiInferenceUseCases": [],
      "workflow": [],
      "organizationModuleMapping": []
    },
    "resourceType": "APPOINTMENT",
    "allowedRoles": [
      "OWNER"
    ],
    "nextActionIds": [
      1
    ],
    "appointmentTypeTemplateId": 1,
    "duration": 1,
    "createdAt": "2026-02-07",
    "updatedAt": "2026-02-07",
    "schedulerAppointmentAction": []
  },
  "latitude": 1,
  "longitude": 1,
  "status": "DONE",
  "createdAt": "2026-02-07"
}