entities

Fetch a list of entity resources associated with this client. Entities are ordered by created date with the most recently created party at index zero.

Log in to see full request history

Permissions

This method requires the scopeparty.read.pii_highto be granted to the calling API key.

This scope can be assigned by system admins through the API or Transact Portal. A PII high scope is required because responses contain sensitive information like names, addresses, tax identification numbers, and information about investor eligibility.

Filtering and sorting

For more information see

Working with List Endpoints

Query Params
int32
Defaults to 10

The maximum number of parties to return. Max value is 500.

int32
Defaults to 0

The row index at which to begin the query. Zero represents the first party in the list.

string
string
boolean
Defaults to false

Included deleted parties in response.

Headers
string
Defaults to Bearer

Bearer token in the format "Bearer clientId:apiKey"

Responses

Language
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json