List Parties

get

https://connect.digits.com/v1/ledger/parties

List ledger parties.

Query Params

name

string

Optional, case-insensitive name filter

kinds

array of strings

Party kinds to include, empty returns all kinds

kinds

Allowed:

roles

array of strings

Filter by accounting role. Parties must match at least one requested role and all other supplied filters.
Omit to include parties regardless of role. UnknownRole and unrecognized values are not accepted.
Vendors span multiple accounting roles; include all vendor-related roles to retrieve the full vendor list.

roles

limit

int32

The number of items to return per request. Default and max size is 100.

cursor

string

Cursor for pagination

createdBefore

date-time

Filter to parties created before this timestamp

createdAfter

date-time

Filter to parties created after this timestamp

updatedBefore

date-time

Filter to parties updated before this timestamp

updatedAfter

date-time

Filter to parties updated after this timestamp

Responses

200OK

defaultDefault error response