Read one connector - Spacefast Docs
Read one connector
Returns one connector with the connections the calling credential may use and the tools it currently exposes.
GET /v1/connectors/{connectorRef}
Authorization
Authorization Bearer token · header required
Authorization: Bearer <token>
with an API key (sfa_ prefix), an OAuth access token, a session token, or a Space machine credential (sfm_ prefix).
or
Authorization OAuth2 access token · header required
OAuth 2.0 with Spacefast scopes. People use the authorization code flow; machines use client credentials.
Scopes: connectors:read
Path parameters
connectorRef string required
- min length 1
Query parameters
team string
- min length 1 · max length 255
Responses
200 Response for status 200
$schemastringdataobject required
A tool source registered for one team.
Show properties
slugstring required
Stable, team-unique connector slug. Also the namespace tools hang off.
titlestring required
Display name, seeded from the source spec.
descriptionstring | any required
What this connector reaches, in one line. Agent-visible.
Show properties
sourcestring required
The kind of tool source a connector reads: an OpenAPI spec, a GraphQL endpoint, or a remote MCP server.
Allowed: openapi graphql mcp
sourceUrlstring | any required
Spec, endpoint, or MCP URL this connector was built from; null when it was registered from an inline spec.
Show properties
firstPartyboolean required
Built into Spacefast. First-party connectors cannot be edited or removed.
presetIdstring | any required
Curated preset this connector was created from, when it came from the catalog.
Show properties
authMethodsobject[] required
Every way this connector can be authenticated.
Show properties
Array of object
kindstring requiredslugstring requiredlabelstring required
Show properties
scopesstring[] requireddynamicRegistrationboolean requiredproviderstring requiredtoolCountinteger required
Connections
connections object[] required
Connections the calling credential may use — not every connection that exists on this connector.
Show properties
Array of object
idstring requiredconnectorstring requiredownerstring requireddisplayNamestring requireddescriptionstring | any requiredstatusstring required
Allowed: pending_authorization active degraded needs_reauth revoked
identityLabelstring | any requiredcredentialConfiguredboolean requiredauthMethodstring | any requiredscopesstring[] requiredisDefaultboolean requiredtoolCountinteger requiredcreatedBystring | any requiredlastCheckedAtstring| any required revokedAtstring| any required createdAtstringrequired updatedAtstringrequired specSyncedAtstring| any required createdAtstringrequired updatedAtstringrequired
default Problem details (RFC 9457)
Any 4xx/5xx response is one application/problem+json document.