List Records

API endpoint that will return the list of records, with support for general search and basic filters.

Note: This API documentation is intended to give the reader an overview of the APIs capabilities and how to access them. When trying to write API calls, we strongly recommend you use the API documentation directly associated with the specific API key you will be calling. That documentation includes examples with the actual IDs of the form and form elements, includes examples for each field available in the associated forms etc. This will allow direct copy-paste of the code snippets from the documentation into your code. If you were to try and use the examples in this documentation, you would have to modify them for the fields, form ID, etc.

HTTP request

GET https://api.gwapps.com/v1/forms/formId/records

Parameters

ParameterDescriptionTypeDefault
Optional query parameters
fieldsComma separated list of fields (See the Overview section to get the list of available fields)string
maxResultMaximum number of entries returned in one result page. By default the value is set to 100. Valid range is 1 – 200.number100
pageNumberThe page number, the response will return the flag hasNext that can be used to check if there are more pages and increment the pageNumber until there are no more pages to return.number1
orderByA field list comma separated. e.g. stage to sort the list in ascending order and -stage to sort the list in descending order.string
qA string to search against the record fields.string

Example Request

GET https://api.gwapps.com/v1/forms/66b18359dc7659dc4cb98d15/records

Response

The response returned will have an array of records, where

AttributeDescriptionType
countTotal usersnumber
currentCurrent page numbernumber
totalPagesTotal pagesnumber
hasNextHas a next pageboolean
recordsList of recordsArray
records._idThe record IDstring
records.stageThe record’s stageStage
records.shortCodeDepends on field typeEach value is different depending on the field type

Example Response

{
  "kind": "form#records",
  "count": 5,
  "current": 1,
  "hasNext": false,
  "totalPages": 1,
  "records": [
    {
      "_id": "recordId",
      "meta": {
        "appId": "6266db8cbd86d9001a70c9ea",
        "formId": "66b18359dc7659dc4cb98d15"
      },
      "stage": "stg0"
    }
  ]
}

This article covers details for a specific API call/endpoint. Details of the overall Records API structure and calls/endpoints can be found in the GW Apps Records API article. Information on creating API Keys can be found within the API section of the Platform Settings, and in the Security > API Keys section of Edit App within each application.

Updated on August 27, 2024
Was this article helpful?

Related Articles