latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Directory

List export jobs for the Activity Center

Retrieves a paginated list of asynchronous directory export jobs for a tenant, for the Activity Center feature. Results can be filtered by export type (practitioner, facility, or group), job status, and job type (MANUAL or SCHEDULED).

get/directory/exports

Query parameters

initiated_bystring

Exact initiator filter

job_typestring

Job type filter (MANUAL or SCHEDULED)

page_offsetinteger

Page offset

page_sizeinteger

Page size

searchstring

Free-text search over Job ID, initiator and template name

statusstring

Status filter

status_not_instring

Comma-separated list of statuses to exclude

tenant_idstring required

Tenant ID

typestring

Export type filter (practitioner, facility, group)

Headers

tenant-idstring

Response

Export jobs retrieved successfully

pageSizeinteger

Page size used for this response

pageOffsetinteger

Page offset used for this response

totalCountinteger

Total number of jobs matching the filters

Example response

{
  "jobs": [
    {
      "correlationId": "550e8400-e29b-41d4-a716-446655440000",
      "type": "practitioner",
      "tenantId": "5cfb18b0-e1b9-4be1-b8b4-a51d62ab67ba",
      "jobType": "MANUAL",
      "expectedRows": 1000,
      "successfulRows": 950,
      "unsuccessfulRows": 50
    }
  ],
  "pageSize": 20,
  "totalCount": 137
}