List connections

GET 
/v1/entities/:entity_id/connections

Returns a list of connections you've previously created. The connections are returned in sorted order, with the most recent connections appearing first. Authentication

Request

Path Parameters

entity_id stringrequired

Unique identifier for the Entity object.

Responses

200

A dictionary with a data property that contains an array of objects. Each entry in the array is a separate connection object. If no more connections are available, the resulting array will be empty.

application/json

Schema

Schema

object stringrequired

Default value: list

data object[]
Array [
object required
Default value: connection
id stringrequired
Unique identifier for the Connection object.
name stringnullablerequired
Name of Connection.
provider stringnullablerequired
Name of connection provider.
reports string[]nullablerequired
Array of report names for this connection.
]

Example (from schema)

{
  "object": "list",
  "data": [
    {
      "object": "connection",
      "id": "KVj1e7pGA85d",
      "name": "ronsflowers.myshopify.com",
      "provider": "shopify",
      "reports": [
        "shopify_ecommerce",
        "shopify_payments_deposit",
        "shopify_cogs"
      ]
    }
  ]
}

401

HTTP Basic: Access denied.

404

Returns an error if a invalid identifier was provided.

application/json

Schema

Schema

error object
message stringrequired
type stringrequired

Example (from schema)

{
  "error": {
    "message": "Unrecognized request URL",
    "type": "invalid_request_error"
  }
}

Loading...