Skip to main content

Get Connector

Retrieve detailed information about a connector.

GET /api/connectors/{id}

Authorization​

  • Any authenticated user: Required. Customers legitimately read connector details (e.g. runtime parameters) when creating collections, so any authenticated user may read the full record. Unauthenticated requests receive 401.

Path Parameters​

ParameterTypeRequiredDescription
idstringYesConnector ID

Response​

{
  "id": "conn_slack001",
  "platform_name": "Slack",
  "platform_url": "https://slack.com/api",
  "version": "1.2.0",
  "endpoints": [
    {
      "id": "ep_conv_list",
      "path": "/conversations.list",
      "method": "GET",
      "order": 1,
      "dependencies": [],
      "enabled": true,
      "rate_limit": {
        "requests": 50,
        "window_seconds": 60
      },
      "pagination": {
        "type": "cursor",
        "params": {
          "cursor_param": "cursor",
          "cursor_path": "$.response_metadata.next_cursor"
        }
      },
      "data_extraction": {
        "path": "$.channels[*]",
        "file_naming": "channel_{id}.json"
      }
    },
    {
      "id": "ep_conv_history",
      "path": "/conversations.history",
      "method": "GET",
      "order": 2,
      "dependencies": ["ep_conv_list"],
      "enabled": true,
      "rate_limit": {
        "requests": 50,
        "window_seconds": 60
      },
      "pagination": {
        "type": "cursor",
        "params": {
          "cursor_param": "cursor",
          "cursor_path": "$.response_metadata.next_cursor"
        }
      },
      "data_extraction": {
        "path": "$.messages[*]",
        "file_naming": "channel_{channel}_messages.json"
      }
    }
  ],
  "auth_config": {
    "type": "oauth2",
    "required_scopes": ["channels:read", "channels:history", "files:read"],
    "token_endpoint": "https://slack.com/api/oauth.v2.access",
    "refresh_supported": true
  },
  "rate_limit_global": {
    "requests": 100,
    "window_seconds": 60
  },
  "default_data_extraction": null,
  "documentation_url": "https://api.slack.com/docs",
  "runtime_parameters": null,
  "status": "production",
  "credential_guide": null,
  "created_by": {
    "id": "analyst_001",
    "full_name": "John Doe"
  },
  "created_at": "2024-01-01T00:00:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}
note

All top-level fields use snake_case. The runtime_parameters, default_data_extraction, and credential_guide fields are null when not configured. credential_guide is sourced from the connector's generation log. Endpoint paths are normalized to {param} syntax.

Example Request​

curl -X GET "https://api.traces.io/api/connectors/conn_slack001" \
  -H "Authorization: Bearer <token>"

Error Responses​

404 Not Found​

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Connector not found"
  }
}