API ReferenceConnectors
List connectors
Any current workspace member can read the connector catalog and the workspace's connections.
No token or part of a token is returned. With connectors not turned on for this workspace it answers only while connections remain, with enabled: false and an empty catalog, so they can still be disconnected; otherwise it returns 404.
GET
/v1/workspaces/{workspaceId}/connectorsAuthorizationBearer <token>
A personal access token, which starts with sntr_. Create one on the dashboard's CLI & API page (https://app.sinatra.dev/tokens). It acts as you in every workspace you belong to, with your role in each, and expires after at most 365 days. The CLI's browser sign-in sends an OAuth access token here instead.
In: header
Path Parameters
workspaceIdstring
The workspace's id, from GET /v1/me.
Response Body
curl -X GET "https://api.sinatra.dev/v1/workspaces/string/connectors"{
"enabled": true,
"catalog": [
{
"id": "string",
"name": "string",
"summary": "string",
"methods": [
"string"
],
"reference": {
"label": "string",
"help": "string",
"required": true
},
"projectRefLabel": "string",
"projectRefHelp": "string",
"tokenHelp": "string",
"tokenHelpUrl": "string",
"providerGuidance": "string",
"oauthHelp": "string",
"leftAtProvider": "string",
"acknowledgement": {
"version": "string",
"text": "string",
"warning": {
"severity": "caution",
"title": "string",
"body": "string",
"items": [
"string"
]
},
"confirmations": [
"string"
]
},
"acknowledgements": {
"token": {
"version": "string",
"text": "string",
"warning": {
"severity": "caution",
"title": "string",
"body": "string",
"items": [
"string"
]
},
"confirmations": [
"string"
]
},
"oauth": {
"version": "string",
"text": "string",
"warning": {
"severity": "caution",
"title": "string",
"body": "string",
"items": [
"string"
]
},
"confirmations": [
"string"
]
}
},
"connectUrl": "string"
}
],
"connections": [
{
"id": "string",
"connector": "string",
"name": "string",
"label": "string",
"serverName": "string",
"method": "string",
"projectRef": "string",
"grantLabel": "string",
"status": "string",
"connectedByUserId": "string",
"connectedByName": "string",
"createdAt": "2019-08-24T14:15:22Z"
}
]
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}{
"error": "string",
"reason": "string",
"requestId": "string",
"refusal": "string",
"billingUrl": "string",
"settingsUrl": "string",
"plan": "string",
"running": 0,
"queued": 0,
"taskId": "string",
"messageId": "string"
}