Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Recurring Incentives

List Recurring Incentive

List all Recurring 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/recurring

Query parameters

statusstring

Filter by recurring incentive status: active or deactive.

typestring

Filter by recurring incentive type.

notestring

Filter by recurring incentives that contain the value in their notes.

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,
  "recurring_incentives": [
    {
      "amount": 50000,
      "amount_tax_type": "net",
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "end_date": "2022-12-20",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "note": "Monthly stipend to buy food",
      "start_date": "2021-12-20",
      "status": "active",
      "type": "meal_allowance"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}