GET /elements/{keyOrId}/instances

GET /elements/{keyOrId}/instances

Retrieve all authenticated adapter instances of an adapter specified by adapter key or adapter id.

Path Parameters

keyOrIdThe adapter key is a unique alphanumeric identifier for the adapter, while the adapter id is a unique numeric identifier for the adapter. Replace keyOrId with either identifier.

Response Fields

The table below shows an abbreviated list of response fields.

idThe adapter instance id is a unique numeric identifier for the authenticated adapter instance.
nameThe display name of the authenticated adapter instance.
tokenThe adapter instance token returned upon authenticating an adapter instance. You must include the adapter instance token in the Authorization header of requests to the adapter instance.
elementInformation about the adapter.
configurationObject containing the configuration of the adapter.
eventsEnabled
Indicates whether events are configured for the instance.
userAn object containing details about the user.

Example Request

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

Example Response


{  
  "id":436470,
  "name":"Instance Name",
  "token":"+s9zKQa+1EQB9BPfVR1WqaPJfg9UQFwMxeHh+ZcXDiE=",
  "element":{  },
  "tags":[  ],
  "valid":true,
  "disabled":false,
  "configuration":{  },
  "eventsEnabled":false,
  "externalAuthentication":"none",
  "user":{  }
}