API Reference
- Switchboard API
- POSTPreview the output of a transformer.
- boards
- hubs
- data-mappings
- apps
- operations
- schemas
- GETGet organisations schema utils signed url
- POSTPost organisations schema utils source url
- POSTPost organisations schema utils info
- connections
- credentials
- GETGet organisations signed url
- POST
connections
Get organisations connections
Retrieves connections for an organisation, potentially filtering by appId. The response is structured as a page but currently the response returns all items. Consumers wishing to be backwards compatible should not assume this API will always return all items.
GET
/
organisations
/
{organisationId}
/
connections
curl --request GET \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/connections \
--header 'Authorization: <api-key>'
{
"totalCount": 123,
"next": "<string>",
"prev": "<string>",
"items": [
{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"app": {
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"public": true,
"server": {
"name": "<string>",
"url": "<string>"
},
"schemaMetadata": {
"type": "<string>",
"version": "<string>",
"url": "<string>"
},
"supportedAuthConfigs": [
{
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
],
"imageUrl": "<string>",
"schema": {
"id": "<string>",
"type": "<string>",
"version": "<string>",
"sourceUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"authConfig": {
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
},
"credentialId": "<string>",
"usedByBoards": [
{
"id": "<string>",
"name": "<string>"
}
]
}
]
}
Authorizations
Path Parameters
Query Parameters
Optionally filter connections by an App ID
Response
200
application/json
A paginated result of Apps.
The response is of type object
.
curl --request GET \
--url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/connections \
--header 'Authorization: <api-key>'
{
"totalCount": 123,
"next": "<string>",
"prev": "<string>",
"items": [
{
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"app": {
"id": "<string>",
"orgId": "<string>",
"name": "<string>",
"public": true,
"server": {
"name": "<string>",
"url": "<string>"
},
"schemaMetadata": {
"type": "<string>",
"version": "<string>",
"url": "<string>"
},
"supportedAuthConfigs": [
{
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
}
],
"imageUrl": "<string>",
"schema": {
"id": "<string>",
"type": "<string>",
"version": "<string>",
"sourceUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"schemaId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"authConfig": {
"type": "<string>",
"isValid": true,
"data": {
"discoveryUrl": "<string>",
"clientId": "<string>",
"clientSecret": "<string>",
"scopes": {}
}
},
"credentialId": "<string>",
"usedByBoards": [
{
"id": "<string>",
"name": "<string>"
}
]
}
]
}