---
title: "Show region fields"
method: GET
path: "/v1/cost-calculator/regions/{slug}/fields"
tags: ["Cost Calculator"]
---

# Show region fields

`GET /v1/cost-calculator/regions/{slug}/fields`

## Request

- Base URL: `https://gateway.remote.com`
- URL: `https://gateway.remote.com/v1/cost-calculator/regions/{slug}/fields`
- Auth: one of:
  - OAuth 2
    - Authorization code: `/auth/oauth2/authorize`
    - Token URL: `/auth/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token`
  - OAuth 2
    - Client credentials
    - Token URL: `/auth/oauth2/token`
  - HTTP bearer
  - HTTP bearer

Returns required fields JSON Schema for a given region. These are required in order to calculate
      the cost of employment for the region. These fields are based on employer contributions that are associated
      with the region or any of it's parent regions.

## 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, acting as the user who authorized it. 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).
- **Client credentials access token** (`OAuth2ClientCredentials`) — obtained through the Client Credentials flow or the Refresh Token flow. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).
- **Employee-scoped access token** (`OAuth2Assertion`) — obtained through the `urn:ietf:params:oauth:grant-type:jwt-bearer` grant. 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).
- **Client token** (`ClientToken`) — a partner `client_token`, accepted only on the endpoints that list it. See [Authentication for partners](https://developer.remote.com/docs/authentication-for-partners).

## Path parameters

- `slug` string, required

## Query parameters

- `include_premium_benefits` boolean

## Response `200`

Success

- JSONSchemaResponse: JSON Schema Response
  - `data` object: JSON Schema
    - `schema` object
      - `properties` object, required
      - `required` string[]
      - `x-jsf-order` string[]
    - `version` integer

## Other responses

- `401`: Unauthorized
- `500`: Internal Server Error

---

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