Fetch connection detail

GET 
/v1/entities/:entity_id/connections/:id

Retrieves the details of a connection that has previously been created. Supply the unique connection ID that was returned from your previous request, and Bookkeep will return the corresponding connection information. Authentication

Request

Path Parameters

entity_id stringrequired

Unique identifier for the Entity object.

id stringrequired

Unique identifier for the object.

Responses

200

Returns a connection if a valid identifier was provided, and returns an error otherwise.

application/json

Schema

Schema

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": "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...