Skip to main content

Get Integration

GET 
/v1/integrations/:integrationId

This endpoint returns the metadata of an Integration identified by the integrationId.

Request​

Path Parameters

    integrationId uuidrequired

    The identifier of the Integration.

Responses​

When everything is ok, the integration data returned.

Schema

    product

    object

    Details of the Product.

    organization

    object

    Details of the Organization.

    organizationId uuid

    Identifier of the Organization.

    name stringnullable

    Name of the Organization.

    productId uuid

    Identifier of the Product.

    name stringnullable

    Name of the Product.

    description stringnullable

    Description of the Product.

    order int32

    The order of the Product represented on the ConfigCat Dashboard. Determined from an ascending sequence of integers.

    reasonRequired boolean

    Determines whether a mandatory reason must be given every time when the Feature Flags or Settings within a Product are saved.

    integrationId uuid

    Identifier of the Integration.

    name stringnullable

    Name of the Integration.

    integrationType IntegrationType (string)

    Possible values: [dataDog, slack, amplitude, mixPanel, segment, pubNub]

    parameters

    object

    nullable

    Parameters of the Integration.

    property name* stringnullable
    environmentIds uuid[]nullable

    List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected.

    configIds uuid[]nullable

    List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected.

Loading...