---
title: "Show benefit renewal request schema"
method: GET
path: "/v1/benefit-renewal-requests/{benefit_renewal_request_id}/schema"
tags: ["Benefit Renewals"]
---

# Show benefit renewal request schema

`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: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `https://gateway.remote.com/company.manage`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `benefit_renewal:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `benefit_renewal:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:read`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token` scopes: `all:write`
  - HTTP bearer

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 by a company manager through the Authorization Code flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/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](https://developer.remote.com/docs/authorization-method-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](https://developer.remote.com/docs/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 type | Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|---|
| Company-scoped access token | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) |
| Company-scoped access token (assertion) | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) |
| Customer API token | Manage company resources (`company_admin`) | View benefit renewals (`benefit_renewal:read`) | Manage benefit renewals (`benefit_renewal:write`) |

## Path parameters

- `benefit_renewal_request_id` string, uuid, required: A unique identifier in UUID v4 format.

## Query parameters

- `json_schema_version` union
  - integer: Specific version number
  - 'latest': Use latest version

## Headers

- `Authorization` string, required

## Response `200`

Success

- BenefitRenewalRequestsBenefitRenewalRequestFormResponse: Benefit Renewal Request Form Response, an object with required and optional fields, its descriptions and suggested presentation.
  - `data` object

## Other responses

- `401`: Unauthorized
- `404`: Not Found
- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/remote-com/apis/benefits.md) - [All operations](https://skmtc.dev/remote-com/apis/benefits/llms.txt) - [OpenAPI document](https://skmtc.dev/remote-com/apis/benefits/revisions/fca458a33455?raw)