Get a list of Individuals

The endpoint returns a list of all Individuals for a specific Business ID

SecuritybearerAuth
Request
path Parameters
Business-ID
required
string <uuid>

Business-ID

query Parameters
external_id
string

Query to search individuals by external ID

Example: external_id=ext-id
page_size
integer

Number of elements to be displayed on a page

Example: page_size=1
page
integer

Display page number

Example: page=1
sort_by
string

Sort individuals

Enum: "first_name" "last_name" "created_at"
Example: sort_by=created_at
sort_order
string

Sort order

Enum: "asc" "desc"
Example: sort_order=desc
Responses
200

Individuals list

401

Unauthorized

403

Forbidden

422

Error

500

Internal Error

503

Maintenance or Service unavailable

get/v1/businesses/{Business-ID}/individuals
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "meta": {
    },
  • "links": {
    }
}