---
title: "Get Form State"
method: GET
path: "/forms/{ID}/state"
tags: ["Forms / States"]
---

# Get Form State

`GET /forms/{ID}/state`

## Request

- Base URL: `https://api.forcemanager.com/api/v4`
- URL: `https://api.forcemanager.com/api/v4/forms/{ID}/state`
- Auth: API key in header `X-Session-Key`

This endpoint retrieves data of a specific Form State based on JSON input. The API returns a single Form State available to the user, according to the unique ID provided. If the specified Form State does not exist, the response will be a "bad request".

You will only receive the Form State after first providing the Session Key. 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 |

**REQUEST**

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| id | Integer | The unique and specific identifier for the Form State to retrieve data |

**RESPONSE**

| **Attribute** | **Type** | **Description** |
| --- | --- | --- |
| id | Integer | Unique identifier for the Form State in ForceManager |
| intOrder | Integer | 	The order in which the State has to appear in the Form States list |
| idParent | Integer | Unique identifier of the parent |
| blnEndState | Boolean | Set to 1 if the Form is fullfilled 0 otherwise |
| strIDEnvironment | String | IDs of the Branches (see [Branches](#) resource) associated to the Form State |
| dateCreated | String | Date and time when the Form State was created |
| dateDeleted | String | Date and time when the Form State was deleted |
| dateUpdated | String | Date and time when the Form State was last updated |
| deleted | Boolean | If true, the Form State has been deleted and archived |
| description | String | Form State name |
| descriptionBR | String | Form State name in Brasilian Portuguese |
| descriptionDE | String | Form State name in German |
| descriptionDK | String | Form State name in Dutch |
| descriptionEN | String | Form State name in English |
| descriptionES | String | Form State name in Spanish |
| descriptionFR | String | Form State name in French |
| descriptionIT | String | Form State name in Italian |
| descriptionPT | String | Form State name in Portuguese |
| descriptionRU | String | Form State name in Russian |
| descriptionUS | String | Form State name in American English |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Form State |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Form State |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Form State |

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

Get Form State

---

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