Skip to main content
POST
/
reference-data
/
list
List rows from any reference dataset by key
curl --request POST \
  --url https://api.artu.ai/reference-data/list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "datasetKey": "<string>",
  "offset": 0,
  "limit": 20,
  "includeTotalCount": true,
  "filter": {},
  "sort": [
    {
      "field": "<string>"
    }
  ],
  "asOf": "2023-11-07T05:31:56Z"
}
'
{
  "data": [
    {}
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<string>",
    "totalCount": 0
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Body

application/json
datasetKey
string
required
Minimum string length: 1
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991
limit
integer
default:20
Required range: 1 <= x <= 200
includeTotalCount
boolean
filter
object
sort
object[]
asOf
string<date-time>

Response

200 - application/json

OK

data
object[]
required
pagination
object
required