API Reference
  1. PCE Boarding APIs
  2. Individuals

List individuals

get
https://sandbox-api.prioritycommerce.com/v1/individuals

Returns a page of individuals. Each row contains the name and a uri to fetch the full record. Filter by externalId to find a person using your own reference.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 250
Defaults to 25

Maximum number of records to return. Defaults to 25; the largest allowed value is 250.

integer
≥ 0
Defaults to 0

Number of records to skip before the first record returned. Use it with limit to page through results.

string
enum
Defaults to -createdAt

Field to sort by. Add a leading - for descending order, for example -createdAt.

Allowed:
string

Return only the record with this externalId.

Responses

Updated about 19 hours ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 19 hours ago

Did this page help you?
.readme-logo { display: none !important; }