GET /elements

GET /elements

Retrieve a list of adapter.

Query Parameters

nextPageThe next page token. Found in the header of the previous search.
pageSizeThe page size for the paginated results, defaults to 200. Maximum 200.

Response Fields

The table below shows an abbreviated list of response fields.

idThe adapter id is a unique numeric identifier for the adapter, distinct from the adapter key, which is alphanumeric. In our documentation, the placeholder {elementId} should be replaced with an adapter id value.
nameThe display name of the adapter.
keyThe key is a unique alphanumeric identifier for the , distinct from the id which is numeric.
descriptionA brief description of the adapter.
imageThe branded image associated with the adapter.
configurationObject containing the configuration of the adapter.
transformationsEnabled
Indicates whether resources at the API provider can be mapped to a common resource.
bulkDownloadEnabled/
bulkUploadEnabled
Indicates whether the adapter supports bulk.
extendableIndicates whether you can extend the adapter by adding resources.
authentication
Identifies the type of authentication used.
extended
Identifies whether you have added resources to the adapter or not.
hubThe hub in which the adapter is categorized.
privateIndicates whether the adapter is part of the public adapter catalog or not.

Example Request

curl -X GET \
  https://api-us.integrate.sugarapps.com/elements/api-v2/elements \
  -H 'authorization: User sAfK7LJGNz5ZHcNrvdJvLI=f03WbTbH6aRKc0HJ3oOIi, Organization 58168435e3b9959a929eb04b6218b9a2' \ \
  -H 'Content-Type: application/json' \

Example Response

[
  {
    "id": 3128,
    "name": "Recurly",
    "key": "recurly",
    "description": "Add a Recurly Instance to connect your existing recurly account to the Billing Hub, allowing you to manage customers, invoices, and transactions across multiple adapters. You will need your Recurly account to add an instance.",
    "image": "https://cloud.githubusercontent.com/assets/4119349/24875787/7ff95a3a-1de6-11e7-86c4-b844167212c1.png",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "configuration": [],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": true,
    "extendable": false,
    "beta": false,
    "authentication": {
      "type": "custom"
    },
    "extended": false,
    "hub": "billing",
    "protocolType": "http",
    "private": false
  }
]