Fetch entity detail

GET 
/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. Authentication

Request

Path Parameters

id stringrequired

Unique identifier for the object.

Responses

200

Returns an entity

application/json

Schema

Schema

object required

Default value: entity

id stringrequired

Unique identifier for the Entity object.

name stringnullablerequired

Name of Entity.

reports string[]nullablerequired

Array of report names for this entity.

Example (from schema)

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

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