v1
latestOpenAPI 3.1.02026-07-242735131.1 MBBenefit 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.
Scopes
| Category | Read only Scope | Write 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
Path parameters
benefit_renewal_request_idstring uuid required
Identifier of the employment being terminated.
Example:663e0b79-c893-45ff-a1b2-f6dcabc098b5
Benefit Renewal Request Id
Query parameters
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