Sign in
Connector

List connectors

Retrieve all connector objects.

get/api/v1/connectors

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

namestring

Name of the connector filter

service_urlstring uri

Service URL of the connector filter

ordering'id' | '-id' | 'name' | '-name' | 'service_url' | '-service_url'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 1500,
      "name": "MyQ Connector",
      "url": "https://example.rossum.app/api/v1/connectors/1500",
      "queues": [
        "https://example.rossum.app/api/v1/queues/8199"
      ],
      "service_url": "https://myq.east-west-trading.com",
      "params": "strict=true",
      "client_ssl_certificate": "-----BEGIN CERTIFICATE-----\n...",
      "authorization_type": "secret_key",
      "authorization_token": "wuNg0OenyaeK4eenOovi7aiF",
      "asynchronous": true,
      "metadata": {
        "some_key": "some_value"
      },
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.