GET
/
o
/
{organisation_id}
/
connectors

Authorizations

Authorization
string
headerrequired

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
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".

Available options:
Development & IT,
ERP,
Supply Chain & Logistics,
Communication,
Accounting,
Hospitality,
Productivity,
HR,
CRM,
AI/LLMs,
eCommerce,
Business Operations
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

ConnectorPage is a page of Connectors.

totalCount
integer
required
connectors
object[]
required
connectors.id
string
required

ID is the unique identifier of the Connector.

connectors.organisationId
string
required

OrganisationID is the unique identifier of the Organisation that owns the Connector.

connectors.name
string
required

Name is the user-provided name of the Connector

connectors.public
boolean
required
connectors.documentationURL
string

Hold an optional link to the documentation for the API.

connectors.imageURL
string

The URL for the icon for the connector

connectors.tags
object
connectors.protocol
enum<string>
required

ProtocolType denotes the set of all valid connector types.

Available options:
http,
bigquery
connectors.authSchemeConfigs
object[]
required
connectors.connectionVariables
object[]

Connection Variables is a list of default variables initialised in every connector connection.

connectors.connections
object[]
required

Connections is a list of all the connections this Connector has.

connectors.versions
object[]
required

Versions is a list of all the versions this Connector has.

connectors.createdAt
string
required

CreatedAt is the time at which the ConnectorVersion was created.

connectors.updatedAt
string
required

UpdatedAt is the time at which the ConnectorVersion was last updated, including any changes to child resources.

connectors.baseUrl
string
required

BaseURL is the base URL of all HTTP Actions within the Connector.

next
string
prev
string