Skip to main content
GET
List catalog categories

Query Parameters

supportsX402
enum<string>

Filter by static eligibility for x402 payment (POST /x402/v1/run): true keeps only payable endpoints, false only non-payable ones. Omit for all endpoints.

Available options:
true,
false
x402Network
string

Narrow to endpoints payable via x402 on this customer-payment network (CAIP-2 id, e.g. eip155:8453). Implies supportsX402=true; an unknown/unconfigured id returns an empty page.

Required string length: 1 - 100
Example:

"eip155:8453"

readonly
enum<string>

Filter by whether running the endpoint can change your workspace resources (phone numbers, files, asset libraries): true keeps only endpoints that cannot create, modify or delete them, false only endpoints that can. Omit for all endpoints. This describes RESOURCE effects only — a readonly endpoint may still perform real-world actions and is still billed.

Available options:
true,
false
effects
string

Keep only endpoints whose run can have AT LEAST ONE of the named effects on your workspace resources (phone numbers, files, asset libraries): creates, updates, deletes. Omit for all endpoints. Takes precedence over readonly (readonly=true is the alias for "no write effects"). Resource effects only — an endpoint with no effect may still perform real-world actions and is still billed.

Example:

"creates,deletes"

category
string

Node id filter. A TOP id returns the top plus its member nodes; a leaf/provider id returns that single node. Omit for every node.

Maximum string length: 60
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
Example:

"social-media"

q
string

Optional free-text query — counts become per-node search hit counts (same BM25 semantics as GET /public/v1/endpoints?q=). Nodes with zero hits are omitted.

Required string length: 1 - 200
Example:

"twitter"

Response

Category nodes

items
object[]
required

Flat node list: tops (priority order) then leaves/providers (alphabetical). Hidden, unlinked, and zero-count nodes omitted.

totalEndpointCount
integer
required

Exact number of catalog-visible endpoints (with q: matching the query) — drives the All rail count.

Required range: x >= 0