Skip to main content
Skip table of contents

Get account connectors

Call the GET /v1.0/account/connectors endpoint to retrieve a list of the installed Account Connectors in a particular Account. You can then use the data in the Response to identify which Account Connector to work with.

For more information about the endpoint, see the Interactive API reference page.

Example Request

CODE
GET https://{CyclrAPIDomain}/v1.0/account/connectors
Authorization: Bearer {access_token}
X-Cyclr-Account: {accountID}

Request Parameters

Parameter

Description

{CyclrAPIDomain}

Replace with the appropriate API domain for your Partner Console.

{access_token}

A Cyclr API Access Token.

{accountID}

The API ID of the Cyclr Account to work in.

For more information on access tokens, see the page on API Authentication.

Example Response

CODE
[
    {
        "Id": 123,
        "Name": "Salesforce",
        "Description": "",
        "Connector": {
            "Id": 1,
            "Name": "Salesforce"
        }
    },
    {
        "Id": 456,
        "Name": "Salesforce 2",
        "Description": "",
        "Connector": {
            "Id": 1,
            "Name": "Salesforce"
        }
    }
]

Response Explanation

Property

Description

Id

The unique ID of an Account Connector.

Name

The Account Connector’s Name.

Description

The Account Connector’s Description.

Connector

This property contains details of the underlying Connector the Account Connector is using.

Connector.Id

The unique ID of the Connector Release of the underlying Connector the Account Connector is using.

If an Account Connector is upgraded, this value will change to reflect the new Connector Release it’s using.

Connector.Name

The Name of the underlying Connector the Account Connector is using.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.