IntegrationConfigs

Retrieve Available Configurations

Changed on

This endpoint gets the available configuration options for integrations.

get/organizations/{orgId}/integrationconfigs/available

Request

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

    • breaking

      the ///// response's property type changed from no type to object for status

    • breaking

      the ////// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • breaking

      the ///////// response's property type changed from no type to object for status

    • breaking

      the /////// response's property type changed from no type to object for status

    • info

      api tag IntegrationConfigs added

    • info

      api tag Integrations removed

    • info

      added the new optional query request parameter entityType

    • info

      added the new optional query request parameter systemName

    • info

      added the required property to the response with the status

    • info

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