4b3471151a8b

latestOpenAPI 3.1.02026-08-1084336455.2 KB

Connections

Get Connections Types

Authorization scope: connection:list

Get all connection types entities as a paginated list

get/v1/connections_types

Query parameters

items_per_pageinteger

The number of items per page in the paginated list.

pageinteger

The current page number in the paginated list.

Response

Successful Response

next_pagestring nullable

The next page URL

previous_pagestring nullable

The previous page URL

pageinteger

The page number

current_page_sizeinteger required

The current page size

total_itemsinteger

The total number of entities fetched

Example response

{
  "current_page_size": 1,
  "items": [
    {
      "fields": {
        "_id": "5643062270ec07e624d4320d",
        "allowed_file_extensions": [],
        "connection_type": "spotx",
        "connection_type_name": "SpotX",
        "has_key_file": false,
        "is_test_connection": true,
        "oauth2": false,
        "properties": [
          {
            "id": "username",
            "type": "string",
            "ui_type": "text",
            "display_name": "Username",
            "row": 0
          },
          {
            "id": "password",
            "type": "password",
            "ui_type": "password",
            "display_name": "Password",
            "row": 1
          },
          {
            "id": "connection_name",
            "type": "string"
          },
          {
            "id": "connection_desc",
            "type": "string"
          }
        ]
      }
    }
  ],
  "next_page": "https://api.rivery.io/v1/connections_types?items_per_page=1&page=2",
  "page": 1,
  "total_items": 189
}