Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Incentives

List Incentives

Lists all Incentives of a company

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage expenses (employment_payments)View incentives (incentive:read)Manage incentives (incentive:write)
get/v1/incentives

Query parameters

employment_idstring

Filter by Employment ID

statusstring

Filter by Incentive status

recurring_incentive_idstring

Filter by Recurring Incentive id

pageinteger

Starts fetching records after the given page

page_sizeinteger

Change the amount of records returned per page, defaults to 20, limited to 100

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "current_page": 1,
  "incentives": [
    {
      "amount": 50000,
      "amount_tax_type": "net",
      "effective_date": "2021-12-20",
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "expected_payout_date": "2021-12-31",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "note": "Signing bonus",
      "recurring_incentive_id": "1c130827-f95c-4495-b7cb-5876dce686b8",
      "status": "pending",
      "type": "signing_bonus"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}