latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Data Sets

List all data set records

Returns a list of data set records for the given query. The results are returned 20 at a time, sorted in order of data set record ID. You must use the links section to get the next 20 results.

get/data-sets/{dataSetId}/records

Path parameters

dataSetIdstring required

The ID of the Data Set

Query parameters

columnsobject

The values of columns to search for. It will match them exactly in a case-insensitive manner. If there are multiple columns, then the records that match all of them will be returned.

Example (before being URL-encoded): ?columns[lD7FTF9R63xNCLn8w_xMdw]=value_1&columns[iJozi9Lbu_vC2igAV1NLWQ]=value_2

_string

Opaque pagination cursor. Take this value from the previous response's links[] entry whose name is "next" (typically just follow that link's href instead of reading this value). Omit on the first page. If the previous response had no next link, there are no more pages.

Response

Example response

{
  "records": [
    {
      "audit": {
        "createdBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        },
        "updatedBy": {
          "id": "naAJxoDIuwdgNsQHGRRGqA",
          "email": "jane.doe@example.com",
          "username": "Jane Doe"
        }
      }
    }
  ],
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}