List entities

GET https://api.bookkeep.com/v1/entities

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

Responses

• 200
• 401

A dictionary with a data property that contains an array of entity object. If no entities are available, the resulting array will be empty.

• application/json

Schema

• object string
  Default value: list
  Example: list

• total_records integer
  Example: 1

• data object[]
  Array [
  object
  Default value: entity
  Example: entity

  • id string
    Unique identifier for the Entity object.
    Example: qLxe2xNDvgND

  • name stringnullable
    Name of Entity.
    Example: Ron's Flowers

  • reports string[]nullable
    Array of report names for this entity.
    Example:["square_summary","square_deposit"]
    ]

{
  "object": "list",
  "total_records": 1,
  "data": [
    {
      "object": "entity",
      "id": "qLxe2xNDvgND",
      "name": "Ron's Flowers",
      "reports": [
        "square_summary",
        "square_deposit"
      ]
    }
  ]
}

Authorization: http

name: basic_authtype: http  
description: The Bookkeep API uses API keys to authenticate requests. You can view and manage your API keys in the [Bookkeep Developer Dashboard](https://app.bookkeep.com/developers/api_keys).  
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

• nodejs

• python

• ruby

• csharp

• php

• CURL

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

Base URL

Edit

https://api.bookkeep.com

Auth

Username

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