---
title: "Extra Fields schema by Resource"
method: GET
path: "/extrafields/VALUE/schema"
tags: ["Extra Fields / Entity"]
---

# Extra Fields schema by Resource

`GET /extrafields/VALUE/schema`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/extrafields/VALUE/schema`
- Auth: API key in header `X-Session-Key`

The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for an Extra Field object.

You will only receive the Extra Field's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.  
To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).

**HEADERS**

| **Parameter** | **Value** | **Description** |
| --- | --- | --- |
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | \*/\* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |

**REQUEST**

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| resource | String | The unique and specific identifier for the Entity you to retrieve data. The allowed values are: `accounts`, `activities`, `calendar`, `contacts`, `opportunities`, `products`, `rates`, `salesorders`, `users` |

**RESPONSE**

The Extra Field Schema is a fields structure with the resource. For each property the API Schema will provide you some information:

*   Description of each property
*   Definition of the data type for each property
*   Whether each property is required or optional
    

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| Field name | Object | Name of the attribute in ForceManager Schema |
| Properties | Object | Definition of the entity |
| Id | Object | Identifier of the value of field name |
| Value | Object | The value of the field name |
| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |
| Required | Array | If it’s a mandatory field or not |

**RESPONSE CODES**

| **Status** | **Description** |
| --- | --- |
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |

## Headers

- `Accept` string

## Response `200`

Extra Fields schema by Resource

---

[API](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer.md) · [All operations](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/llms.txt) · [OpenAPI document](https://skmtc.dev/forcemanager/apis/sage-sales-management-public-api-documentation-for-developer/revisions/87db17204e2f?raw)