Skip to main content
GET
List Employees

Authorizations

X-Api-Key
string
header
required

Your API key (yativo_pk_...) from Developers → API Keys. Send together with X-Api-Secret.

X-Api-Secret
string
header
required

Your API secret (yativo_sk_...), shown once when the key is created.

Query Parameters

customer_id
string

Only this customer's employees.

status
enum<string>

active, suspended or terminated.

Available options:
active,
suspended,
terminated
kyc_status
enum<string>

not_started, submitted, approved or rejected.

Available options:
not_started,
submitted,
approved,
rejected

Matches name or email.

has_cards
boolean

true for employees with at least one card, false for those without.

with_balance
boolean

Add each employee's card_balance. Slower.

page
integer
default:1

Page number.

per_page
integer
default:20

Records per page.

Response

Paginated list

status
string
Example:

"success"

status_code
integer
Example:

200

message
string
Example:

"Request successful"

data
object[]
pagination
object