Returns a record of the dynamic forms table.
Request
Request URI
| Method | Request URI |
|---|---|
| GET | https://{company-name}.helloid.com/api/v1/forms?search={text-to-search}&skip={number-to-skip}&take={number-to-take} |
Request parameters
| Parameter | Description | Required/Optional | Default |
|---|---|---|---|
| {company-name} | The company name of the target company | Required | None |
| {text-to-search} | Searches for forms containing this text. | Optional | Empty |
| {number-to-skip} | Number of results to skip (for paging) | Optional | 0 |
| {number-to-take} | Number of results to take (for paging) | Optional | 20 |
Request headers
No request headers
Request body
No request body
Request body parameters
No request body parameters
Response
Response status
| Code | Description |
|---|---|
| 200(OK) | Indicates that the operation was successful. |
| 400(BAD REQUEST) | Indicates that the operation was not successful. There were validation errors or the request body was malformed. |
| 401(UNAUTHORIZED) | Indicates that no authentication header was given or the api key and secret were invalid. If the api key and secret were valid check the configuration in your portal, it is possibilty these were IP restricted or are disabled. |
Please also see error result.
Please also see common HTTP status codes.
Sample response body
{
"total": 10,
"data": [
{
"version": 1,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "69ff80fd-f875-4c2c-9a30-ae433ed1d3eb",
"name": "api test"
},
{
"version": 1,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "00063687-9b3f-45bb-94b3-bace619dee24",
"name": "api test 2"
},
{
"version": 2,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "7d6317b0-cb23-40e1-3c41-08d7c1b0087d",
"name": "api test 3"
},
{
"version": 5,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "d225d08d-9cfe-4df1-3d60-08d7c663b5c6",
"name": "api test 4"
},
{
"version": 30,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "6e15253f-841e-41b7-e746-08d777d00b10",
"name": "api test 5"
},
{
"version": 1,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "c3a28b97-b077-41e2-8c0c-d99f874ba5c8",
"name": "api test 6"
},
{
"version": 97,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "c04a476e-2a00-4d43-85c3-08d7bf643380",
"name": "api test 7"
},
{
"version": 2,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "569813f7-3f08-445d-b300-08d7a01286bf",
"name": "api test 8"
},
{
"version": 158,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "b314fe9d-c034-466a-5f06-08d7677f341d",
"name": "api test 9"
},
{
"version": 5,
"isPendingDelete": false,
"isUpdated": false,
"dynamicFormGUID": "c143da41-afbf-478d-f622-08d7b90cccf9",
"name": "api test 10"
}
]
}
Example request with cURL
Replace placeholder values surrounded by { } with the actual values.
curl -u {api-key}:{api-secret} -X GET https://{company-name}.helloid.com/api/v1/forms?search={text-to-search}&skip={number-to-skip}&take={number-to-take} -H "Content-Type:application/json"