Benefits
Benefit Renewals

Show benefit renewal request schema

Returns the json schema of the benefit_renewal_request form for a specific request. This endpoint requires a company access token, as forms are dependent on certain properties of companies and their current employments.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View benefit renewals (benefit_renewal:read)Manage benefit renewals (benefit_renewal:write)
get/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema
  • Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, benefit_renewal:read, benefit_renewal:write, company_admin, all:write, all:read)

Path parameters

benefit_renewal_request_idstring uuid required

A unique identifier in UUID v4 format.

Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5

Benefit Renewal Request Id

Query parameters

integer

Specific version number

OR
'latest'

Use latest version

Version of the form schema

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

dataobject

Changes

No recorded changes to this operation across all 65 revisions of this API.