Skip to content
/Employees

List all employees

Request

Security
form_session or user_session or component_session or component_token or api_token
Query
pagestring(page)

1-based page number. There is no upper bound; values below 1 are clamped to 1.

per_pagestring(between(1, 100))

a number between 1 and 100

custom_attributesstring
updated_at_ltestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

updated_at_gtestring(DateTimeUtc)

a string to be decoded into a DateTime.Utc

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/employees?page=string&per_page=string&custom_attributes=string&updated_at_lte=string&updated_at_gte=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
dataArray of objects(Employee)required
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}