GET
/
o
/
{organisation_id}
/
connectors
List Connectors
curl --request GET \
  --url https://platform.versori.com/api/connect/v1/o/{organisation_id}/connectors \
  --header 'Authorization: Bearer <token>'
{
  "totalCount": 123,
  "next": "<string>",
  "prev": "<string>",
  "connectors": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "name": "<string>",
      "public": true,
      "documentationURL": "<string>",
      "imageURL": "<string>",
      "tags": {},
      "protocol": "http",
      "authSchemeConfigs": [
        {
          "id": "<string>",
          "description": "<string>",
          "validationMessages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ],
          "schemeType": "<string>"
        }
      ],
      "connectionVariables": [
        {
          "name": "<string>",
          "value": "<string>"
        }
      ],
      "connections": [
        {
          "id": "<string>",
          "name": "<string>",
          "credentials": {
            "action": [
              {
                "id": "<string>",
                "authSchemeConfig": {
                  "id": "<string>",
                  "description": "<string>",
                  "validationMessages": [
                    {
                      "text": "<string>",
                      "severity": "info",
                      "detail": [
                        "<string>"
                      ]
                    }
                  ],
                  "schemeType": "<string>"
                },
                "credential": {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "type": "none",
                  "name": "<string>",
                  "usages": [
                    {
                      "connection": {
                        "id": "<string>",
                        "name": "<string>",
                        "connector": {
                          "id": "<string>",
                          "organisationId": "<string>",
                          "name": "<string>",
                          "protocol": "http",
                          "createdAt": "2023-11-07T05:31:56Z",
                          "updatedAt": "2023-11-07T05:31:56Z"
                        },
                        "createdAt": "2023-11-07T05:31:56Z",
                        "updatedAt": "2023-11-07T05:31:56Z"
                      }
                    }
                  ],
                  "errors": [
                    "<string>"
                  ],
                  "data": {},
                  "expiresAt": "2023-11-07T05:31:56Z"
                }
              }
            ],
            "trigger": [
              {
                "id": "<string>",
                "authSchemeConfig": {
                  "id": "<string>",
                  "description": "<string>",
                  "validationMessages": [
                    {
                      "text": "<string>",
                      "severity": "info",
                      "detail": [
                        "<string>"
                      ]
                    }
                  ],
                  "schemeType": "<string>"
                },
                "credential": {
                  "id": "<string>",
                  "organisationId": "<string>",
                  "type": "none",
                  "name": "<string>",
                  "usages": [
                    {
                      "connection": {
                        "id": "<string>",
                        "name": "<string>",
                        "connector": {
                          "id": "<string>",
                          "organisationId": "<string>",
                          "name": "<string>",
                          "protocol": "http",
                          "createdAt": "2023-11-07T05:31:56Z",
                          "updatedAt": "2023-11-07T05:31:56Z"
                        },
                        "createdAt": "2023-11-07T05:31:56Z",
                        "updatedAt": "2023-11-07T05:31:56Z"
                      }
                    }
                  ],
                  "errors": [
                    "<string>"
                  ],
                  "data": {},
                  "expiresAt": "2023-11-07T05:31:56Z"
                }
              }
            ]
          },
          "variables": [
            {
              "name": "<string>",
              "value": "<string>"
            }
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "versions": [
        {
          "id": "<string>",
          "name": "<string>",
          "description": "<string>",
          "isLatest": true,
          "isDefault": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "publishedAt": "2023-11-07T05:31:56Z",
          "messages": [
            {
              "text": "<string>",
              "severity": "info",
              "detail": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "baseUrl": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication used by the Versori Platform. External consumers must provide an API key, however internal consumers must provide a JWT id_token issued by our IdP.

Path Parameters

​
organisation_id
string<ulid>
required

Query Parameters

​
first
integer
default:20
​
after
string
​
before
string
​
sort
string
​
tags
string

Allows you to search using tags. The format needs to be like <key>:<?value>, with multiple tags separated by a ,. Each tag needs to have a key but value is optional.

Example: "category:e-commerce,business"

​
categories
enum<string>[]

Allows you to search connectors by category. You can search for connectors with multiple categories by providing an array of categories.

For example: "?categories=category1&categories=category2&categories=category3".

​
protocol
string

Protocol filters the returned Connectors using a case-insensitive substring-match.

​
name
string

Name filters the returned Connectors using a case-insensitive substring-match.

Response

200
application/json

OK

ConnectorPage is a page of Connectors.