Get Integration

Retrieve an integration by its ID. This returns the integration along with its team info and the environments in which it's installed, if any.

Endpoint

http

GET /integrations/{id}

Path parameters

string · uuid

REQUIRED ·

The ID of the integration.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7

Query parameters

Refer Specifying query parameters in Truto APIs

environment_id

string

Filter by environment ID to show if integration is installed or not.

Example: 8a2b104d-74a6-47f2-b93e-c6b611e82391

Response Body

string · uuid

The ID of the integration.

Example: 4a4de828-f4db-4c9e-adfd-434e0864c3c7

name

string

The name of the integration.

Example: zendesk

category

string

The category of the integration.

Example: helpdesk

is_beta

boolean

Whether the integration is in beta or not. Beta integrations might not have been tested completely and are not recommended for production environments.

config

object

The configuration object defining the underlying API of the integration.

Example:

{
  "base_url": "https://api.example.com",
  "label": "Example API",
  "logo": "https://example.com/logo.png",
  "headers": {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "User-Agent": "truto"
  },
  "authorization": {
    "format": "bearer",
    "config": {
      "value": "{{oauth.token.access_token}}"
    }
  },
  "pagination": {
    "format": "page",
    "config": {
      "page_key": "page",
      "limit_key": "per_page"
    }
  },
  "resources": {
    "users": {
      "list": {
        "method": "get",
        "path": "/users",
        "response_path": "data.users"
      }
    }
  }
}

team_id

string · uuid

The ID of the team that owns this integration.

Example: 05daecaf-4365-42e8-8370-8127de5dd717

sharing

string

The sharing policy of the integration.

All possible enum values:

allow
ask
deny

Example: allow

created_at

string · date-time

The date and time when the integration was created.

Example: 2021-08-10T10:00:00.000Z

updated_at

string · date-time

The date and time when the integration was last updated.

Example: 2021-08-10T10:00:00.000Z

installed_environment

string[]

A list of environment IDs where this integration is installed.

team

object

The team that owns this integration.

string · uuid

The ID of the team.

Example: 05daecaf-4365-42e8-8370-8127de5dd717

name

string

The name of the team.

Example: My Awesome Team

domain

string

The domain of the team.

Example: example.com

logo

string

The URL of the team's logo.

Example: https://example.com/logo.png

is_verified

boolean

Whether the team is verified or not.

Example: true

is_white_label

boolean

Whether the team is white-labeled or not.

tos_link

string

A link to the team's Terms of Service, if available.

Example: https://example.com/tos

allow_impersonation

boolean

Whether the team allows impersonation.

created_at

string · date-time

The date and time when the team was created.

Example: 2021-08-10T10:00:00.000Z

updated_at

string · date-time

The date and time when the team was last updated.

Example: 2021-08-10T10:00:00.000Z