No results

Fetch all indexes

Fetch a page of indexes for a list.

GET https://api.jsonpad.io/lists/{listId}/indexes

Example

cURL
123curl https://api.jsonpad.io/lists/ceed67c4-2d79-4c00-8e8e-d86306603eed/indexes \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/c56bf462-abde-450b-8717-79249a16d458/indexes?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/0912a98f-930f-4d82-9616-91802e9afeb8/indexes?limit=20The number of indexes to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/d3b29b72-d0ed-43af-a231-733c743d5745/indexes?order=createdAt

    The field to order the indexes by. Defaults to createdAt.

    Valid values are:

    • createdAt
    • updatedAt
    • name
    • pathName
    • valueType
    • alias
    • sorting
    • filtering
    • searching
    • defaultOrderDirection
    • activated
  • optional
    directionstringhttps://api.jsonpad.io/lists/4515b2be-c516-4656-9647-a3dd312a654e/indexes?direction=asc

    The direction to order the indexes by.

    Valid values are:

    • asc
    • desc
  • optional
    namestringhttps://api.jsonpad.io/lists/0c5792a4-34aa-4af0-a15a-bd852ac0c78a/indexes?name=sampleFilter indexes by name (partial match).
  • optional
    pathNamestringhttps://api.jsonpad.io/lists/ab565d7c-35d1-4128-ad8f-1f993d629b26/indexes?pathName=sampleFilter indexes by pathName (partial match).
  • optional
    valueTypestringhttps://api.jsonpad.io/lists/e96e53db-842b-467d-bb14-6f997a48ffec/indexes?valueType=string

    Filter indexes by valueType.

    Valid values are:

    • string
    • number
    • date
  • optional
    aliasbooleanhttps://api.jsonpad.io/lists/36ce46b0-2d6a-4178-9e77-5a92a1c49bc6/indexes?alias=trueFilter for alias indexes. Can be true or false.
  • optional
    defaultOrderDirectionstringhttps://api.jsonpad.io/lists/5611c381-9f4c-43fd-9de4-699d4957eb2d/indexes?defaultOrderDirection=asc

    Filter indexes by defaultOrderDirection.

    Valid values are:

    • asc
    • desc

Request headers

  • required
    x-api-tokenstringYour API token.

Request body

No request body

Response body

200 OK
{
page: 1
limit: 20
total: 1
data: [
0: {
id: "a95ff15b-be6e-47ff-8ddb-07e594893dae"
createdAt: "2026-09-05T11:30:18.065Z"
updatedAt: "2026-09-05T11:30:18.065Z"
name: "Sample Index"
description: ""
pathName: "sample-index"
pointer: "/name"
valueType: "string"
alias: false
sorting: false
filtering: false
searching: false
defaultOrderDirection: "asc"
activated: true
}
]
}

Response headers

  • x-total1The total number of results available.
  • x-pages1The total number of pages available.
2024-10-29