Sign in
Integrations

Retrieve Available Configurations

This endpoint gets the available configuration options for integrations.

get/organizations/{orgId}/integrationconfigs/available

Path parameters

orgIdstring required

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

Query parameters

systemNamestring

The system to retrieve the configuration for.

entityTypestring

The entity to retrieve the configuration for.

Response

Returns the configuration details

supportedEntitiesobject required

An object mapping entity types to their respective EntityConfiguration. Provides information on which entities are supported and their configurations.

selectedConfigurationsobject required

Changes

Changed in 2 of the 10 revisions of this API.5

  • 9f9e5f3dbde74See the full diff
    • ○

      added the new optional query request parameter entityType

      new-optional-request-parameter

    • ○

      added the new optional query request parameter systemName

      new-optional-request-parameter

    • ○

      added the required property to the response with the status

      response-required-property-added

    • ○

      added the required property //// to the response with the status

      response-required-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b51See the full diff
    • ○

      added the required property //// to the response with the status

      response-required-property-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog