Incentives
List incentives for the authenticated employee
Returns all incentives for the authenticated employee.
Authentication
This endpoint accepts any one of the following token types:
- Employee-scoped access token (OAuth2Assertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant. See OAuth Assertion.
- Company-scoped access token (OAuth2AuthorizationCode) — obtained by the employee through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Scopes
Any one of the scopes in a token type's row is enough. all:read and all:write work too.
| Token type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Employee-scoped access token | Manage expenses (employment_payments) | View incentives (incentive:read) | - |
| Company-scoped access token | Manage expenses (employment_payments) | View incentives (incentive:read) | Manage incentives (incentive:write) |
get/v1/employee/incentives
Request
- Base URLhttps://gateway.remote.com
- URLhttps://gateway.remote.com/v1/employee/incentives
- Auth
- OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: incentive:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Client credentialsToken URL: /auth/oauth2/token scopes: all:write
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: https://gateway.remote.com/employment.manage
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: incentive:read
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:read
- or OAuth 2Authorization code: /auth/oauth2/authorizeToken URL: /auth/oauth2/token scopes: all:write
Response
Success
Example response
{
"data": {
"status": "ok"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.