Skip to main content
GET
List company recipients

Authorizations

Authorization
string
header
required

API key authentication. Include your access token as: Authorization: Basic <ACCESS_TOKEN>

Query Parameters

company_id
string
required

Search by name or email.

role
enum<string>
Available options:
contractor,
employee,
vendor
recipient_type
enum<string>
Available options:
user,
company
status
enum<string>
Available options:
active,
pending,
inactive
country
string

2-letter ISO country code.

sort_by
enum<string>
Available options:
name,
email,
created
sort_by_dir
enum<string>
Available options:
asc,
desc
page
integer

Page number.

Required range: x >= 1
per_page
integer

Number of items per page.

Required range: x >= 1

Response

200 - application/json

Recipient list returned.

data
object[]
meta
object | null