Forms / Entity
Get Form
This endpoint retrieves data of a specific Form based on JSON input. The API returns a single Form available to the user, according to the unique ID provided. If the specified Form does not exist, the response will be a "bad request".
You will only receive the Form after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
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 to retrieve data |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| dateCreated | String | Date and time when the Form was created |
| dateDeleted | String | Date and time when the Form was deleted |
| dateUpdated | String | Date and time when the Form was last updated |
| deleted | Boolean | If true, the Form has been deleted and archived |
| list | String | Form's lists specifications |
| detail | String | Form's fields specifications |
| jsonData | String | Form's general specifications |
| formTemplateId | String | he ID of the Template that Form belongs to (see Templates resource) |
| statusId | Integer | The ID of the State that Form belongs to (see States resource) |
| id | Integer | Unique identifier for the Form in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Form |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Form |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Form |
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 |
get/forms/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/forms/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Form
Changes
No recorded changes to this operation across all 1 revision of this API.