Entities
List all Entities
Entities
List all Entities
GET
/
entities
Returns all the Entities associated with your team, or an empty array if none have been created.
Query Parameters
type
string
The type of Entities to retrieve. One of individual or corporation
status
string
The status of Entities to retrieve. One of active, incomplete or disabled
from_date
string
ISO 8601 formatted date (YYYY-MM-DD) to filter for Entities created on and after the date provided.
to_date
string
ISO 8601 formatted date (YYYY-MM-DD) to filter for Entities created on and before the date provided.
page
string
The number of the page to return.
page_cursor
string
The ID of a resource from which a page should start or end. Mutually exclusive with page.
page_limit
string
The number of Entities to return per page.
expand
enum[]
Attributes that can be expanded into an object to provide additional information.
Returns
Returns a list of Entities.