List all instances for an MCP server

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.

Path parameters

serverIdstringRequired

The ID of the MCP server

Query parameters

page_nodoubleOptionalDefaults to 1

Page number for pagination (1-based)

limitdoubleOptionalDefaults to 20

Number of items per page (default: 20)

searchstringOptional

Search instances by user ID/instance ID

order_byenumOptionalDefaults to updated_at

Field to order results by

Allowed values:

order_directionenumOptionalDefaults to desc

Direction of ordering

Allowed values:

Response

Successfully retrieved MCP server instances. Returns the list of user IDs associated with this server.

instanceslist of objects

List of instance objects associated with this MCP server for the current page

server_idstring

UUID of the MCP server

server_namestring

Name of the MCP server

total_pagesdouble

Total number of pages in the paginated response

current_pagedouble

Current page number being returned

1	import requests
2
3	url = "https://backend.composio.dev/api/v3/mcp/servers/550e8400-e29b-41d4-a716-446655440000/instances"
4
5	querystring = {"page_no":"1","limit":"20","search":"user_123"}
6
7	headers = {"x-api-key": "<apiKey>"}
8
9	response = requests.get(url, headers=headers, params=querystring)
10
11	print(response.json())

1	{
2	"instances": [
3	{
4	"id": "550e8400-e29b-41d4-a716-446655440000",
5	"instance_id": "user_123456",
6	"mcp_server_id": "660e8400-e29b-41d4-a716-446655440001",
7	"created_at": "2023-06-10T09:15:00.000Z",
8	"updated_at": "2023-06-15T14:30:00.000Z"
9	}
10	],
11	"server_id": "550e8400-e29b-41d4-a716-446655440000",
12	"server_name": "Production GitHub Integration",
13	"total_pages": 3,
14	"current_page": 1
15	}

List all instances for an MCP server

Path parameters

Headers

Query parameters

Response

Errors