Fetch entity detail | Build with Bookkeep

Fetch entity detail

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

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

Request

Path Parameters

id string required
Unique identifier for the object.

Responses

Schema

object

Default value: entity

Example: entity

id string
Unique identifier for the Entity object.

Example: qLxe2xNDvgND

name string nullable
Name of Entity.

Example: Ron's Flowers

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

Example: [ "square_summary", "square_deposit" ]

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

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_authtype: http
description: The Bookkeep API uses API keys to authenticate requests. 
Your API keys carry many privileges, so be sure to keep them secure!

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

Authentication Requirements