Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Integrations

List integration configurations

🔑

Required OAuth scope: integrations:read.

📖

This endpoint is paginated with a page size of 100 integration configurations. For more information, see the Pagination guide.

Lists all integration configurations.

get/api/v2/integrations

Query parameters

eqstring

Filter on values equal to the given one

nestring

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on externalPlatform property with LHS bracket notation.

Expected value format is a string.

{
  "eq": "loremIpsum",
  "ne": "loremIpsum",
  "in": [
    "loremIpsum"
  ],
  "nin": [
    "loremIpsum"
  ]
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 100 integration configurations.

defaultCompletionboolean

True if the content is auto-completed at launch; false otherwise.

defaultProgressinteger

The completion rate at launch as a percentage.

noGroupPropagationboolean

If true, the content is visible only within the integration group and is not propagated to subgroups. If false, the content is propagated to all subgroups.

externalPlatformLogoUrlstring

The URL of the logo of the external platform this integration is created for. The URL must be a valid HTTPS URL pointing to a logo with transparent background.

externalPlatformUnicolorLogoUrlstring

The URL of the unicolor logo of the external platform this integration is created for. The URL must be a valid HTTPS URL pointing to a logo with transparent background. If none is provided, the externalPlatformLogoUrl logo will be used.

externalPlatformstring required

The identifier of the external platform this integration is created for.

authorIdstring ObjectId required

The unique ID of the author of the imported content.

groupIdstring ObjectId required

The unique ID of the group to which the content is imported.

_idstring ObjectId required

The unique ID of the integration.

Example response

[
  {
    "externalPlatform": "My Platform",
    "authorId": "507f1f77bcf86cd799439011",
    "groupId": "507f1f77bcf86cd799439011",
    "_id": "507f1f77bcf86cd799439011"
  }
]