Read one connection - Spacefast Docs

Read one connection

Returns one connection’s derived state, identity, and tool count. A connection the calling credential may not use is indistinguishable from one that does not exist.

GET /v1/connectors/connections/{connectionId}

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

connectionId string required

min length 1

Query parameters

team string

min length 1 · max length 255

Responses

200 Response for status 200

{
  "$schema": "string<uri>",
  "data": {
    "id": "string",
    "connector": "string",
    "owner": "team",
    "displayName": "string",
    "description": "Any",
    "status": "pending_authorization",
    "identityLabel": "Any",
    "credentialConfigured": true,
    "authMethod": "Any",
    "scopes": [
      "string"
    ],
    "isDefault": true,
    "toolCount": -9007199254740991,
    "createdBy": "Any",
    "lastCheckedAt": "string<date-time>",
    "revokedAt": "string<date-time>",
    "createdAt": "string<date-time>",
    "updatedAt": "string<date-time>"
  }
}

Error Responses

{
  "$schema": "string<uri>",
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "pointer": "string",
  "details": {
    "property1": null,
    "property2": null
  },
  "suggestions": [
    "string"
  ],
  "next": [
    "string"
  ],
  "requestId": "string"
}