Fetch connection detail | Build with Bookkeep

Fetch connection detail

GET https://api.bookkeep.com/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.

Request

Path Parameters

entity_id string required
Unique identifier for the Entity object.

id string required
Unique identifier for the object.

Responses

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

Schema

object

Default value: connection

Example: connection

id string
Unique identifier for the Connection object.

Example: KVj1e7pGA85d

name string nullable
Name of Connection.

Example: ronsflowers.myshopify.com

provider string nullable
Name of connection provider.

Example: shopify

reports string[] nullable
Array of report names for this connection.

Example: [ "shopify_ecommerce", "shopify_payments_deposit", "shopify_cogs" ]

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

HTTP Basic: Access denied.

Returns an error if an invalid identifier was provided.

Schema

error object

message string

Example: Unrecognized request URL

type string

Example: invalid_request_error

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

Authorization: http

name: basic 
type: http 
description: The Bookkeep API uses API keys to authenticate requests. You can view and manage your API keys in the Bookkeep Developer Dashboard. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via HTTP Basic Auth. Provide your Publishable key as the basic auth username value and your Secret key as the basic auth password value. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

curl -L -X GET 'https://api.bookkeep.com/v1/entities' \
  -H 'Authorization: Basic ZGlsaXAuYmFpcmFnaUBib29ra2VlcC5jbzpXLlM4NVZGbkJyeEY2QmI='

curl -L 'https://api.bookkeep.com/v1/entities/:entity_id/connections/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

Base URL

https://api.bookkeep.com

Auth

Username

Password

Parameters

entity_id — path required

id — path required

Send API Request

Response Clear

Click the Send API Request button above and see the response here!