/

Get Batch Operations

get

Retrieves a list of batch operations for an organization

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

operationTypestring · enumOptional

The type of batch operation to filter by

Example: BULK_APPOINTMENT_RESCHEDULEPossible values:

entityTypestring · enumOptional

The type of entity to filter by

Example: SCHEDULER_APPOINTMENTPossible values:

statusstring · enumOptional

The status of the batch operation to filter by

Example: PENDINGPossible values:

carePlanIdintegerOptional

The care plan id to filter by

Example: 1

startDateone ofOptional

The start date of the batch operation to filter by

Example: 2025-01-01

string · dateOptional

or

string · date-timeOptional

sortBystringOptional

The field to sort by

Example: startDate

endDateone ofOptional

The end date of the batch operation to filter by

Example: 2025-01-01

string · dateOptional

or

string · date-timeOptional

organizationIdanyRequired

The organization id to filter by

Example: 1

initiatedByPersonIdnumberOptional

The person id that initiated the batch operation to filter by

Example: 1

pageNumbernumberOptional

The page number to filter by

Example: 1

pageSizenumberOptional

The page size to filter by

Example: 10

batchOperationIdstringOptional

The batch operation id to filter by

Example: 123

sortOrderstring · enumRequired

The order to sort by

Example: ascPossible values:

includeLogsbooleanOptional

Whether to include logs in the response

Example: true

includeInitiatedByPersonbooleanOptional

Whether to include the initiator in the response

Example: true

Responses

200Success

application/json

get

/api/batch-operations/

HTTPcURLJavaScriptPython

GET /api/batch-operations/?organizationId=1&sortOrder=asc HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [],
  "totalCount": 100,
  "pageNumber": 1,
  "pageSize": 50
}