Sign in

v1

latestOpenAPI 3.0.32026-07-24411867.5 KB

List entities

Returns entities accessible to the requesting firm user. Supports optional filters.

Notes:

  • show_inactive=false (default) excludes inactive entities.
  • name is an exact match on the entity name.
  • external_entity_id is an exact match on the external ID.
  • user_id filters entities by the primary contact user ID.
get/entities

Query parameters

show_inactiveboolean

If true, include inactive entities as well.

namestring

Exact match on entity name (e.g., Acme Corp).

external_entity_idstring

Exact match on the external entity ID.

user_idinteger

Filter entities by user ID. Returns only entities belonging to the specified user.

pageinteger

Page number (1-based). Defaults to 1.

per_pageinteger

Number of records per page. Defaults to 50. Maximum 500.

Response

Array of entities

idinteger required
entity_typestring required
namestring required
streetstring nullable
statestring nullable
citystring nullable
zipstring nullable
countrystring nullable
tax_return_namestring required
created_atstring date-time required
upload_linkstring uri required
business_emailstring nullable
other_emailstring nullable
external_entity_idstring nullable
deleted_atstring date-time nullable
hash_idstring required