REremote-com
Incentives

List Incentives

Lists all Incentives of a company

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage expenses (employment_payments)View incentives (incentive:read)Manage incentives (incentive:write)
Company-scoped access token (assertion)Manage expenses (employment_payments)View incentives (incentive:read)Manage incentives (incentive:write)
Customer API tokenManage expenses (employment_payments)View incentives (incentive:read)Manage incentives (incentive:write)
get/v1/incentives

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/incentives
  • Auth
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: incentive:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: incentive:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

Query parameters

employment_idstring

Filter by Employment ID

statusstring

Filter by Incentive status

recurring_incentive_idstring

Filter by Recurring Incentive id

typestring

Filter by Incentive type. Defaults to all self-serve incentive types (the types creatable through this API) when omitted. Pass this explicitly (e.g. severance) to also retrieve types that are entered outside of self-serve, such as severance. Pass all to retrieve every incentive type, including those types.

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

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

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",
      "payroll_output_category": "incentive",
      "recurring_incentive_id": "1c130827-f95c-4495-b7cb-5876dce686b8",
      "status": "pending",
      "type": "signing_bonus",
      "type_label": "Signing bonus"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.