Batch operations

Get Batch Operation by ID

get

Retrieves a batch operation by its ID

Authorizations
AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters
idstringRequiredPattern: [^\/#\?]+?
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:
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
get
/api/batch-operations/{id}
200Success
PreviousAppointment historyNext/