List related parties

List related parties in the credential-bound company. Results use cursor pagination; pass the returned cursor to request the next page. Requires the related-parties:read OAuth scope.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
length ≤ 191

The whole phrase, as typed, matched as one piece of the name; % and _ match themselves.

integer
1 to 100
Defaults to 25

Number of resources per cursor page (1-100).

string

Opaque cursor returned by the preceding collection response.

string

Comma-separated allowlisted sort fields; prefix descending fields with a minus sign.

string

Comma-separated allowlisted relationships.

string

Comma-separated allowlisted sparse response fields. The id field is always retained.

string

Allowlisted exact or bounded collection filter.

string
enum

active (the default): not archived; archived; or all.

Allowed:
string
enum

Allowlisted exact or bounded collection filter.

Allowed:
string

Allowlisted exact or bounded collection filter.

string
enum

The party's own status, active or inactive (filter[status] is the archive). Owner's money takes active directors and shareholders.

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*