Integrations

Integrations define reusable provider contracts that can then be materialized into integration instances.

Integrations object

Attributes

object

String

id

String

status

Enum

slug

String

name

String

description

StringNullable

metadata

ObjectNullable

A key-value map

configuration

Object

implementation

ObjectNullable

providers

Object

created_at

Date

updated_at

Date

archived_at

DateNullable
{
  "object": "integration",
  "status": "active",
  "metadata": {},
  "configuration": {},
  "implementation": {
    "type": "provider_template"
  },
  "providers": [
    {
      "object": "integration.provider",
      "status": "active",
      "metadata": {},
      "tool_filter": {
        "type": "allow_all"
      },
      "provider": {
        "object": "provider#preview",
        "id": "pro_5gHjKlMnPqRsTuVw",
        "name": "GitHub",
        "description": "Connect to GitHub repositories, issues, and pull requests",
        "slug": "github",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "deployment": {
        "object": "provider.deployment#preview",
        "id": "pde_1aBcDeFgHjKlMnPq",
        "name": "Production",
        "description": "Production deployment",
        "metadata": {},
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "auth_method": {
        "object": "provider.capabilities.auth_method",
        "id": "pam_2mNpQrStUvWxYzAb",
        "type": "oauth",
        "key": "oauth2",
        "name": "OAuth 2.0",
        "description": "Authenticate using OAuth 2.0",
        "capabilities": {},
        "input_schema": {
          "type": "json_schema",
          "schema": {}
        },
        "output_schema": {
          "type": "json_schema",
          "schema": {}
        },
        "scopes": [
          {
            "object": "provider.capabilities.auth_method.scope",
            "id": "pams_8tUvWxYzAbCdEfGh",
            "scope": "repo",
            "name": "Repository Access",
            "description": "Full control of private repositories"
          },
          {
            "object": "provider.capabilities.auth_method.scope",
            "id": "pams_8tUvWxYzAbCdEfGh",
            "scope": "repo",
            "name": "Repository Access",
            "description": "Full control of private repositories"
          }
        ],
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "provider_specification_id": "psp_9gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "auth_credentials": {
        "object": "provider.auth_credentials",
        "id": "par_4sTuVwXyZaBcDeFg",
        "type": "oauth",
        "status": "active",
        "is_default": true,
        "is_managed": true,
        "name": "GitHub OAuth",
        "description": "OAuth credentials for GitHub API",
        "metadata": {},
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "config": {
        "object": "provider.config#preview",
        "id": "pcf_7dEfGhJkLmNpQrSt",
        "name": "Production Config",
        "description": "Configuration for production environment",
        "metadata": {},
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      }
    },
    {
      "object": "integration.provider",
      "status": "active",
      "metadata": {},
      "tool_filter": {
        "type": "allow_all"
      },
      "provider": {
        "object": "provider#preview",
        "id": "pro_5gHjKlMnPqRsTuVw",
        "name": "GitHub",
        "description": "Connect to GitHub repositories, issues, and pull requests",
        "slug": "github",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "deployment": {
        "object": "provider.deployment#preview",
        "id": "pde_1aBcDeFgHjKlMnPq",
        "name": "Production",
        "description": "Production deployment",
        "metadata": {},
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "auth_method": {
        "object": "provider.capabilities.auth_method",
        "id": "pam_2mNpQrStUvWxYzAb",
        "type": "oauth",
        "key": "oauth2",
        "name": "OAuth 2.0",
        "description": "Authenticate using OAuth 2.0",
        "capabilities": {},
        "input_schema": {
          "type": "json_schema",
          "schema": {}
        },
        "output_schema": {
          "type": "json_schema",
          "schema": {}
        },
        "scopes": [
          {
            "object": "provider.capabilities.auth_method.scope",
            "id": "pams_8tUvWxYzAbCdEfGh",
            "scope": "repo",
            "name": "Repository Access",
            "description": "Full control of private repositories"
          },
          {
            "object": "provider.capabilities.auth_method.scope",
            "id": "pams_8tUvWxYzAbCdEfGh",
            "scope": "repo",
            "name": "Repository Access",
            "description": "Full control of private repositories"
          }
        ],
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "provider_specification_id": "psp_9gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "auth_credentials": {
        "object": "provider.auth_credentials",
        "id": "par_4sTuVwXyZaBcDeFg",
        "type": "oauth",
        "status": "active",
        "is_default": true,
        "is_managed": true,
        "name": "GitHub OAuth",
        "description": "OAuth credentials for GitHub API",
        "metadata": {},
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      },
      "config": {
        "object": "provider.config#preview",
        "id": "pcf_7dEfGhJkLmNpQrSt",
        "name": "Production Config",
        "description": "Configuration for production environment",
        "metadata": {},
        "provider_id": "pro_5gHjKlMnPqRsTuVw",
        "created_at": "2025-09-15T10:30:00.000Z",
        "updated_at": "2026-01-10T14:45:00.000Z"
      }
    }
  ]
}

List integrations

Returns a paginated list of integrations.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

search

StringOptional

status

UnionOptional

id

UnionOptional

provider_id

UnionOptional

integration_provider_id

UnionOptional

created_at

ObjectOptional

Filter integration creation time by date range

updated_at

ObjectOptional

Filter integration last update time by date range

GEThttp://api.metorial.com/integrations
curl -X GET "https://api.metorial.com/integrations" \
  -H "Authorization: Bearer metorial_sk_..."

Get integration

Retrieves a specific integration.

URL Parameters

integration_id

String

The unique identifier for the integration

GEThttp://api.metorial.com/integrations/:integration_id
curl -X GET "https://api.metorial.com/integrations/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create integration

Creates a new integration.

Request Body

name

String

description

StringOptional

metadata

ObjectOptional

A key-value map

can_attach_custom_tool_filters

BooleanOptional

can_attach_custom_provider_config

BooleanOptional

can_override_tool_filters

BooleanOptional
POSThttp://api.metorial.com/integrations
curl -X POST "https://api.metorial.com/integrations" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "can_attach_custom_tool_filters": false,
  "can_attach_custom_provider_config": false,
  "can_override_tool_filters": false
}'

Update integration

Updates a specific integration.

URL Parameters

integration_id

String

The unique identifier for the integration

Request Body

name

StringOptional

description

StringOptionalNullable

metadata

ObjectOptionalNullable

A key-value map

can_attach_custom_tool_filters

BooleanOptional

can_attach_custom_provider_config

BooleanOptional

can_override_tool_filters

BooleanOptional
PATCHhttp://api.metorial.com/integrations/:integration_id
curl -X PATCH "https://api.metorial.com/integrations/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "can_attach_custom_tool_filters": false,
  "can_attach_custom_provider_config": false,
  "can_override_tool_filters": false
}'

Delete integration

Archives a specific integration.

URL Parameters

integration_id

String

The unique identifier for the integration

DELETEhttp://api.metorial.com/integrations/:integration_id
curl -X DELETE "https://api.metorial.com/integrations/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."