increase-test
GET/entities

List entities

Lists legal entities that own accounts, including people, corporations, joint accounts, trusts, and government authorities. Use the status, validation status, creation-time, and idempotency filters to narrow the results; use cursor and limit to navigate the paginated list.

9 parameters
cursorstringoptional
Return the page of entities after this cursor.
limitintegeroptional
Maximum number of entities to return, from 1 to 100. Defaults to 100 when omitted.
Default:100
status.inarray<string>optional
Filter entities by status. Supply a comma-delimited list containing active, archived, or disabled.
validation_status.inarray<string>optional
Filter entities by validation status. Supply a comma-delimited list containing pending, valid, or invalid.
created_at.afterstringoptional
Return entities created after this ISO 8601 timestamp.
created_at.beforestringoptional
Return entities created before this ISO 8601 timestamp.
created_at.on_or_afterstringoptional
Return entities created at or after this ISO 8601 timestamp.
created_at.on_or_beforestringoptional
Return entities created at or before this ISO 8601 timestamp.
idempotency_keystringoptional
Filter for the entity with this idempotency key. Must contain 1 to 200 characters.

3 status codes
200Returns a page of entity objects in `data` and a `next_cursor` for retrieving the next page, or null when there is no next page.
dataarray<Entity>required
The contents of the list.
next_cursorstringrequired
A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
4XXReturned when the request encounters a client-side error.
5XXReturned when the server encounters an error.

Error handling

The limit query parameter must be at least 1 and cannot exceed 100; it defaults to 100 when omitted. status.in accepts active, archived, or disabled, and validation_status.in accepts pending, valid, or invalid. The created_at filters must be ISO 8601 timestamps, and idempotency_key must contain 1 to 200 characters.