Sign in

v10

latestOpenAPI 3.0.1raw.githubusercontent.com2025-12-033223581.2 MB
Integrations

List IntegrationRuns

Retrieve a list of the integration runs for the specified entity.

You can filter the list using the startDate and endDate query parameters to specify date/times to define the time period you want to return integration runs for.

get/organizations/{orgId}/integrationruns/{entityType}/{entityId}

Path parameters

orgIdstring required

The unique identifier (UUID) for your Organization. The Organization represents your company as a direct customer of our service.

entityIdstring required

The UUID of the entity to retrieve the integration runs for.

entityTypestring required

The type of the entity you want to retrieve the integration runs for. Two options:

  • Bill
  • Notification

Query parameters

startDatestring

Retrieve only those integration runs started after the specified date/time.(ISO 8601 formatted)

endDatestring

Retrieve only those integration runs started before or on the specified date/time.(ISO 8601 formatted)

pageSizeinteger

Number of integration runs to retrieve per page.

nextTokenstring

nextToken for multi page retrievals.

status'WAITING' | 'STARTED' | 'COMPLETE' | 'ERROR' | 'AWAITING_RETRY' | 'AUTH_FAILED' | 'ACCOUNTING_PERIOD_CLOSED' | 'INVOICE_ALREADY_PAID' | 'DISABLED' | 'TIMEOUT_LIMIT_EXCEEDED' | 'RATE_LIMIT_RETRY'

Status of the integration run

order'ASC' | 'DESC'

Integration runs order

Response

Return the Integration Runs

nextTokenstring