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

List an Organization's integration applications

Return the Organization's bounded set of safe OAuth application metadata, with at most one application for each supported integration provider.

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]+$

Responses

200Success
application/json
401Unauthorized
application/json
403Forbidden
application/json

Reusable schemas

IntegrationApplicationEncoded

object
  • unknown properties allowed false
integrationApplicationIdrequired
stringThe Organization-owned integration application identifier.
  • maximum length 64
  • pattern ^integration_app_[\s\S]+$
organizationIdrequired
stringThe Organization identifier.
  • maximum length 64
  • pattern ^org_[\s\S]+$
providerrequired
IntegrationProviderThe model, Surface, or integration provider key.
providerClientIdrequired
stringThe provider's stable OAuth client identifier.
displayNamerequired
stringThe human-readable resource name.
credentialGenerationrequired
integerThe current credential generation, incremented on rotation.
  • greater than 0
credentialEtagrequired
stringThe strong ETag for the current provider-credential generation.
  • maximum length 12
  • pattern ^"(?:[1-9][0-9]{0,9})"$
statusrequired
IntegrationApplicationStatusThe current lifecycle status.
createdAtrequired
stringWhen the resource was created, in UTC.
  • format date-time

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.

IntegrationProvider

string
  • allowed values "gmail", "googleCalendar", "twitter"

IntegrationApplicationStatus

string
  • allowed values "active", "disabled"