API ReferenceMCP

List all instances for an MCP server

Markdown
GET
/api/v3/mcp/servers/{serverId}/instances

Retrieves a paginated list of user instances (user IDs) associated with a specific Model Control Protocol (MCP) server. This endpoint supports pagination to handle servers with many instances.

Authorization

ApiKeyAuth
x-api-key<token>

API key authentication

In: header

Path Parameters

serverId*string

The ID of the MCP server

Query Parameters

page_no?number|null

Page number for pagination (1-based)

Default1
limit?number|null

Number of items per page (default: 20)

Default20
search?string

Search instances by user ID/instance ID

order_by?string

Field to order results by

Default"updated_at"
Value in"created_at" | "updated_at"
order_direction?string

Direction of ordering

Default"desc"
Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://backend.composio.dev/api/v3/mcp/servers/550e8400-e29b-41d4-a716-446655440000/instances"
{
  "instances": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "instance_id": "user_123456",
      "mcp_server_id": "660e8400-e29b-41d4-a716-446655440001",
      "created_at": "2023-06-10T09:15:00.000Z",
      "updated_at": "2023-06-15T14:30:00.000Z"
    }
  ],
  "server_id": "550e8400-e29b-41d4-a716-446655440000",
  "server_name": "Production GitHub Integration",
  "total_pages": 3,
  "current_page": 1
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}
{
  "error": {
    "message": "string",
    "code": 0,
    "slug": "string",
    "status": 0,
    "request_id": "string",
    "suggested_fix": "string",
    "errors": [
      "string"
    ]
  }
}