MCP
Servers
Instances
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.
get/api/v3.1/mcp/servers/{serverId}/instances
Path parameters
serverIdstring required
UUID of the MCP server to list instances for
Example:550e8400-e29b-41d4-a716-446655440000
The ID of the MCP server
Query parameters
page_nonumber nullable
Page number to retrieve
Example:1
Page number for pagination (1-based)
limitnumber nullable
Number of instances to return per page
Example:20
Number of items per page (default: 20)
searchstring
Filter instances by user ID or instance ID (partial match)
Example:user_123
Search instances by user ID/instance ID
order_by'created_at' | 'updated_at'
Field to use for ordering the results
Example:updated_at
Field to order results by
order_direction'asc' | 'desc'
Sort direction (ascending or descending)
Example:desc
Direction of ordering
Response
Successfully retrieved MCP server instances. Returns the list of user IDs associated with this server.
Example response
{
"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
}