Sign in

v10

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

Retrieve IntegrationConfig

Retrieve the integration configuration for the entity

get/organizations/{orgId}/integrationconfigs/entity/{entityType}

Path parameters

orgIdstring required

UUID of the organization

entityTypestring required

The entity to retrieve the configuration for.

Query parameters

entityIdstring

UUID of the entity to retrieve IntegrationConfigs for

destinationstring

Destination type to retrieve IntegrationConfigs for

destinationIdstring

UUID of the destination to retrieve IntegrationConfigs for

nextTokenstring

nextToken for multi page retrievals

pageSizeinteger

Number of configs to retrieve per page

Response

Return the IntegrationConfig

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

entityTypestring required

The type of entity the integration run is for. Two options:

  • Bill
  • Notification
entityIdstring required

The unique identifier (UUID) of the entity the integration run is for.

dtStartedstring date-time

The date and time the integration run was started (in ISO-8601 format).

dtCompletedstring date-time

The date and time the integration was completed. (in ISO-8601 format).

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

Status of the integration

destinationstring required

The destination system for the integration run.

destinationIdstring

Identifier of the destination

errorstring

Describes any errors encountered during the integration run.

urlstring

The URL of the entity in the destination system if available.

externalIdstring

The external ID in the destination system if available.

parentIntegrationRunIdstring

ID of the parent integration run, or null if this is a parent integration run