Skip to content
Documentation

List MCP servers

GET
/api/v1/workspaces/{workspace_id}/mcp_servers

Retrieves the MCP servers

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Query Parameters

Section titled “Query Parameters ”
per
integer
default: 10

Number of records per page

page
integer
default: 1

Page number

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
results
required
Array<object>
object
id
required
integer
Example
12345
name
required
string
Example
Shopify
url
required
string
Example
https://example.com
healthcheck_status
required
string
Allowed values: pending healthy unhealthy
Example
pending
headers
required
object
key
additional properties
string
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
tools
required
Array<object>
object
id
required
integer
Example
12345
name
required
string
Example
Shopify
description
required
string
Example
Shopify API
enabled
required
boolean
Example
true
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
logo_url
required
string
nullable
Example
https://example.com/logo.png
oauth
required
boolean
start_oauth_flow_url
required
string
nullable
Example
https://example.com/oauth/start
pagination
required
object
per
required
integer
Example
10
page
required
integer
Example
1
total
required
integer
Example
100

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

404

Section titled “404 ”

Not Found

object
message
required
string
Example
Record not found