Skip to navigation
API ReferenceStaff

List New Joinee Requests

Returns people who asked to join your company through its joining link or company code, newest first, as in New Joinee requests in the app. By default only requests waiting for a decision; use status for decided ones too.

  • Only requests where the person filled in their details are listed.
  • They are not staff yet, so there is no salarybox_id. Once approved, they appear in List Staff.
  • status is pending, approved or declined. joined_via is joining_link or company_code.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

statusenumOptionalDefaults to current

Which requests to return. Defaults to current.

  • current: waiting for a decision.
  • approved: approved.
  • declined: rejected.
  • all: every status.
Allowed values:
pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 500.

Response

datalist of objects
messagestring
statusboolean
countinteger
prevstring or null
nextstring or null

Errors

400
Bad Request Error