Skip to content
CantoraAPI documentation
GET
/v1/organizations/{organizationId}/data-integration-applications

List data Integration Applications

Return a bounded page of safe application or token-issuer metadata without credentials.

Authentication

Send an API key as a Bearer token in the Authorization header.

Parameters

NameLocationRequiredDescription
organizationIdpathYes
The Organization to address.
stringA Cantora Organization identifier, prefixed with `org_`.
  • maximum length 64
  • pattern ^org_[\s\S]+$
cursorqueryNo
The opaque continuation token returned by the preceding page.
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
limitqueryNo
The maximum number of resources to return, from 1 through 100.
string
  • pattern ^[+-]?\d*\.?\d+(?:[Ee][+-]?\d+)?$

Responses

200DataIntegrationApplicationPage
application/json
DataIntegrationApplicationPageEncoded
400The request path, headers, query, or JSON body did not satisfy the published schema
401Unauthorized
application/json
UnauthorizedEncoded
403Forbidden
application/json
ForbiddenEncoded

Reusable schemas

DataIntegrationApplicationPageEncoded

object
  • unknown properties allowed false
itemsrequired
arrayThe resources in this page, in stable order.
Items
DataIntegrationApplicationEncoded
nextCursorrequired
The opaque continuation token for the next page, or null after the final page.
Any of
string
  • maximum length 2048
  • minimum length 1
  • pattern ^[A-Za-z0-9_-]+$
null

UnauthorizedEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Unauthorized"
reasonrequired
stringA safe explanation of why the credential was rejected.

ForbiddenEncoded

object
  • unknown properties allowed false
_tagrequired
stringThe stable machine-readable error type.
  • allowed values "Forbidden"
permissionrequired
stringThe permission required by the refused operation.

DataIntegrationApplicationEncoded

object
  • unknown properties allowed false
dataIntegrationApplicationIdrequired
stringThe Organization-owned data Integration Application identifier.
  • maximum length 64
  • pattern ^data_integration_app_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
integrationIdrequired
stringThe stable Organization-scoped Integration identifier.
  • maximum length 64
  • pattern ^integration_[\s\S]+$
keyrequired
stringThe stable key of this Integration Application within its Integration.
  • maximum length 100
  • minimum length 1
  • pattern ^[a-z][a-z0-9_]*$
displayNamerequired
stringThe human-readable resource name.
statusrequired
DataIntegrationStatusThe current lifecycle status.
generationrequired
integerThe monotonically increasing Integration Application representation generation.
  • greater than 0
etagrequired
stringThe strong ETag required for the next conditional mutation.
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time
updatedAtrequired
stringWhen the resource was last updated, in UTC.
  • format date-time

DataIntegrationStatus

string
  • allowed values "active", "disabled"