---
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`

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`) |

## Path parameters

- `benefit_renewal_request_id` string, uuid, required — Identifier of the employment being terminated.

## 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.net/remote-com/apis/remote.md) · [All operations](https://skmtc.net/remote-com/apis/remote/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/remote-com/remote/revisions/7e6a0c61ac82/schema)