Skip to main content
GET
List legal entities
Archived legal entities are excluded unless you set include_archived=true. This also applies when you filter by ID.

Authorizations

X-API-Key
string
header
required

Your organization API key. Some operations also need a key that is associated with a user; their pages say so.

Query Parameters

IDs to return, separated by commas. The other filters also apply.

Required array length: 1 - 100 elements
Minimum string length: 1
include_archived
boolean

Include archived legal entities. Defaults to false. An explicit status filter takes precedence.

sort_by
enum<string>

Field to sort by. Defaults to created_at. Use created_at or name to page through all records. With updated_at, a record that changes during paging can be skipped.

Available options:
name,
created_at,
updated_at
sort_direction
enum<string>

Sort direction. Defaults to desc (newest first).

Available options:
asc,
desc

Case-insensitive substring match on the legal entity name.

include_count
boolean

Include the total number of matching records. If the count cannot be calculated, the request fails.

Filter to one or more entity types. Repeat the parameter for each value.

currencies
string[]

Filter to one or more base currencies (ISO 4217). Repeat the parameter for each value.

statuses
enum<string>[]

Filter by active or archived status. Repeat the parameter for multiple values, or use a comma-separated list. Values are case-insensitive.

Available options:
active,
archived
limit
integer
default:25

Maximum number of records to return.

Required range: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page. Keep the other filters unchanged.

status
enum<string>

Filter by status.

Available options:
active,
archived

Response

The matching records.

data
object[]
required

The records.

has_more
boolean
required

Whether another page is available.

next_cursor
string | null
required

Cursor for the next page, or null on the last page.

total_count
integer

Total matching records across all pages. Present when include_count=true.

Required range: x >= 0