---
title: "List integration instances"
method: GET
path: "/integration-instances"
tags: ["Integration Instances"]
---

# List integration instances

`GET /integration-instances`

## Request

- Base URL: `https://api.metorial.com`
- URL: `https://api.metorial.com/integration-instances`
- Auth: HTTP bearer

Returns a paginated list of integration instances.

## Query parameters

- `limit` number
- `after` string
- `before` string
- `cursor` string
- `order` 'asc' | 'desc'
- `ownership` 'shared' | 'usable' | 'all'
- `search` string
- `status` union
  - 'draft' | 'active' | 'archived' | 'deleted'
  - string[]
- `id` union
  - string
  - string[]
- `integration_id` union
  - string
  - string[]
- `provider_id` union
  - string
  - string[]
- `integration_provider_id` union
  - string
  - string[]
- `identity_id` union
  - string
  - string[]
- `identity_credential_id` union
  - string
  - string[]
- `identity_actor_id` union
  - string
  - string[]
- `provider_deployment_id` union
  - string
  - string[]
- `provider_config_id` union
  - string
  - string[]
- `provider_auth_config_id` union
  - string
  - string[]
- `session_template_id` union
  - string
  - string[]
- `created_at` object
  - `gt` string, date-time: Only include records after this timestamp for integration instance creation time
  - `lt` string, date-time: Only include records before this timestamp for integration instance creation time
- `updated_at` object
  - `gt` string, date-time: Only include records after this timestamp for integration instance last update time
  - `lt` string, date-time: Only include records before this timestamp for integration instance last update time

## Headers

- `Metorial-Version` string

## Response `200`

Successful response

- IntegrationInstanceList
  - `items` Item11[], required
    - `object` 'integration.instance', required
    - `id` string, required
    - `status` 'draft' | 'active' | 'archived' | 'deleted', required
    - `name` string, required
    - `description` string, nullable, required
    - `metadata` object, nullable, required
    - `integration_id` string, required
    - `identity_actor_id` string, nullable, required
    - `identity_id` string, nullable, required
    - `access` Access, required: Resource ownership and access settings.
      - `source` 'explorer', nullable, required: Integration resource source, or null when the resource is not from Explorer.
      - `type` 'public' | 'owner_locked', required: Whether usage is public or locked to the owner under the project ownership rules.
      - `visibility` 'anyone' | 'owner', required: Whether visibility is unrestricted or limited to the owner under the project ownership rules.
      - `owner` object, nullable, required: The actor that owns this resource, if any.
        - `type` 'person' | 'agent' | 'consumer' | 'organization_member', required: Type of the owning actor.
        - `name` string, nullable, required: Display name of the owning actor.
        - `image_url` string, nullable, required: Avatar image URL of the owning actor, if available.
        - `email` string, nullable, required: Email address of the owning actor, if available.
        - `organization_member` object: Organization member associated with this owner.
          - `id` string, required: Identifier of the organization member who owns the resource.
        - `consumer` Consumer: Consumer and profile associated with this owner.
          - `id` string, required: Identifier of the owning consumer.
          - `profile_id` string, required: Identifier of the owning consumer profile.
          - `portal_id` string, nullable, required: Identifier of the consumer profile’s portal, if any.
    - `implementation` object, nullable, required
      - `type` 'magic_mcp_server', required
      - `magic_mcp_server_id` string, required
    - `providers` Item10[], required
      - `object` 'integration.instance.provider', required
      - `id` string, required
      - `status` 'active' | 'archived' | 'deleted', required
      - `name` string, required
      - `description` string, nullable, required
      - `metadata` object, nullable, required
      - `integration_id` string, required
      - `integration_instance_id` string, required
      - `tool_filter` union, required: Tool filter configuration
        - object
          - `type` 'allow_all', required
          - `ignore_parent_filters` boolean, required
        - ToolFilter
          - `type` 'filter', required
          - `filters` union[], required
            - union
              - …
          - `ignore_parent_filters` boolean, required
      - `is_override_tool_filter` boolean, required
      - `provider` Provider2, required
        - `object` 'provider#preview', required: String representing the object's type
        - `id` string, required: Unique provider identifier
        - `name` string, required: Display name of the provider
        - `description` string, nullable, required: Brief description of the provider
        - `slug` string, required: URL-friendly identifier
        - `created_at` string, date-time, required: Timestamp when the provider was created
        - `updated_at` string, date-time, required: Timestamp when the provider was last updated
      - `integration_provider` IntegrationProvider2, required
        - `object` 'integration.provider#snapshot', required
        - `id` string, required
        - `provider_version` object, required
          - `object` 'integration.provider.version', required
          - `id` string, required
          - `index` number, required
        - `status` 'active' | 'archived' | 'deleted', required
        - `name` string, required
        - `description` string, nullable, required
        - `metadata` object, nullable, required
        - `tool_filter` union, required: Tool filter configuration
          - object
            - `type` 'allow_all', required
            - `ignore_parent_filters` boolean, required
          - ToolFilter
            - `type` 'filter', required
            - `filters` union[], required
              - …
            - `ignore_parent_filters` boolean, required
        - `provider_id` string, required
        - `deployment_id` string, required
        - `auth_method_id` string, nullable, required
        - `auth_credentials_id` string, nullable, required
        - `config` object, nullable, required
          - `object` 'provider.config#preview', required: String representing the object's type
          - `id` string, required: Config ID
          - `is_default` boolean, required: Whether this is the default config
          - `name` string, nullable, required: Config name
          - `description` string, nullable, required: Description
          - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
          - `provider_id` string, required: Provider ID
          - `created_at` string, date-time, required: Timestamp when created
          - `updated_at` string, date-time, required: Timestamp when last updated
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
        - `archived_at` string, date-time, nullable, required
      - `config` object, nullable, required
        - `object` 'provider.config#preview', required: String representing the object's type
        - `id` string, required: Config ID
        - `is_default` boolean, required: Whether this is the default config
        - `name` string, nullable, required: Config name
        - `description` string, nullable, required: Description
        - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
        - `provider_id` string, required: Provider ID
        - `created_at` string, date-time, required: Timestamp when created
        - `updated_at` string, date-time, required: Timestamp when last updated
      - `auth_config` object, nullable, required
        - `object` 'provider.auth_config#preview', required: String representing the object's type
        - `id` string, required: Config ID
        - `is_default` boolean, required: Whether this is the default config
        - `name` string, nullable, required: Config name
        - `description` string, nullable, required: Description
        - `metadata` object, nullable, required: Custom key-value pairs for storing additional information
        - `provider_id` string, required: Provider ID
        - `created_at` string, date-time, required: Timestamp when created
        - `updated_at` string, date-time, required: Timestamp when last updated
      - `callback_instance_id` string, nullable, required: The active callback instance registered for this integration instance provider, if its integration provider has callbacks enabled.
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, required
      - `archived_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `archived_at` string, date-time, nullable, required
  - `pagination` object, required
    - `has_more_before` boolean, required
    - `has_more_after` boolean, required

## Other responses

- `400`: Invalid parameters or action
- `401`: Missing or invalid API key
- `403`: The key lacks permission for this resource
- `404`: No such resource
- `422`: Validation failed
- `429`: Rate limit exceeded
- `500`: Unexpected server error

---

[API](https://skmtc.dev/metorial/apis/metorial-api.md) - [All operations](https://skmtc.dev/metorial/apis/metorial-api/llms.txt) - [OpenAPI document](https://skmtc.dev/metorial/apis/metorial-api/revisions/10ccc89f3eac?raw)