Integration Providers

Integration providers define the shared provider-level contract for a given integration.

Integration Providers object

Attributes

object

String

id

String

status

Enum

integration_id

String

name

String

description

StringNullable

metadata

ObjectNullable

A key-value map

tool_filter

ObjectNullable

Tool filter configuration

provider

Object

deployment

Object

auth_method

ObjectNullable

auth_credentials

ObjectNullable

config

ObjectNullable

created_at

Date

updated_at

Date

archived_at

DateNullable
{
  "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 integration providers

Returns a paginated list of integration providers.

Query Parameters

limit

NumberOptional

after

StringOptional

before

StringOptional

cursor

StringOptional

order

EnumOptional

search

StringOptional

status

UnionOptional

id

UnionOptional

integration_id

UnionOptional

provider_id

UnionOptional

provider_deployment_id

UnionOptional

provider_auth_method_id

UnionOptional

provider_auth_credentials_id

UnionOptional

provider_config_id

UnionOptional

created_at

ObjectOptional

Filter integration provider creation time by date range

updated_at

ObjectOptional

Filter integration provider last update time by date range

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

Get integration provider

Retrieves a specific integration provider.

URL Parameters

integration_provider_id

String

The unique identifier for the integration_provider

GEThttp://api.metorial.com/integration-providers/:integration_provider_id
curl -X GET "https://api.metorial.com/integration-providers/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."

Create integration provider

Creates a new integration provider.

Request Body

integration_id

String

provider_id

String

provider_deployment_id

String

provider_auth_method_id

StringOptionalNullable

provider_auth_credentials_id

StringOptionalNullable

provider_config_id

StringOptionalNullable

name

StringOptional

description

StringOptional

metadata

ObjectOptional

A key-value map

tool_filters

UnionOptionalNullable
POSThttp://api.metorial.com/integration-providers
curl -X POST "https://api.metorial.com/integration-providers" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "integration_id": "example_integration_id",
  "provider_id": "example_provider_id",
  "provider_deployment_id": "example_provider_deployment_id",
  "provider_auth_method_id": "example_provider_auth_method_id",
  "provider_auth_credentials_id": "example_provider_auth_credentials_id",
  "provider_config_id": "example_provider_config_id",
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "tool_filters": {
    "type": "example_type",
    "keys": [
      "example_item"
    ]
  }
}'

Update integration provider

Updates a specific integration provider.

URL Parameters

integration_provider_id

String

The unique identifier for the integration_provider

Request Body

provider_deployment_id

StringOptional

provider_auth_method_id

StringOptionalNullable

provider_auth_credentials_id

StringOptionalNullable

provider_config_id

StringOptionalNullable

name

StringOptional

description

StringOptionalNullable

metadata

ObjectOptionalNullable

A key-value map

tool_filters

UnionOptionalNullable
PATCHhttp://api.metorial.com/integration-providers/:integration_provider_id
curl -X PATCH "https://api.metorial.com/integration-providers/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer metorial_sk_..." \
  -d '{
  "provider_deployment_id": "example_provider_deployment_id",
  "provider_auth_method_id": "example_provider_auth_method_id",
  "provider_auth_credentials_id": "example_provider_auth_credentials_id",
  "provider_config_id": "example_provider_config_id",
  "name": "example_name",
  "description": "example_description",
  "metadata": {},
  "tool_filters": {
    "type": "example_type",
    "keys": [
      "example_item"
    ]
  }
}'

Delete integration provider

Archives a specific integration provider.

URL Parameters

integration_provider_id

String

The unique identifier for the integration_provider

DELETEhttp://api.metorial.com/integration-providers/:integration_provider_id
curl -X DELETE "https://api.metorial.com/integration-providers/int_Rm4Mnheq2bfEPhBhP7SY" \
  -H "Authorization: Bearer metorial_sk_..."