List entities

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

Responses

200

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

Schema

object stringrequired

Default value: list

total_records integerrequired
data object[]
Array [
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": "list",
  "total_records": 1,
  "data": [
    {
      "object": "entity",
      "id": "qLxe2xNDvgND",
      "name": "Ron's Flowers",
      "reports": [
        "square_summary",
        "square_deposit"
      ]
    }
  ]
}

401

HTTP Basic: Access denied.

Loading...