No results
Search failed
No results
Narrow your search with type:list, type:token, #tag…↑↓ to move · Enter to open · Esc to close

Fetch all indexes

Fetch a page of indexes for a list.

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

Example

cURL
12curl https://api.jsonpad.io/lists/1d9ae598-d8ab-4da0-a2a3-0bca738ac481/indexes \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/af955706-00b2-41f6-8055-85b61a1901e4/indexes?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/230f0463-2aef-413a-b6cb-32191aa6e12d/indexes?limit=20The number of indexes to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/8cc23d78-e6d8-470e-a5d5-fba5c96d777c/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
    • guard
    • defaultOrderDirection
    • activated
  • optional
    directionstringhttps://api.jsonpad.io/lists/5c078b98-922f-418f-afa7-0806696eed7d/indexes?direction=asc

    The direction to order the indexes by.

    Valid values are:

    • asc
    • desc
  • optional
    namestringhttps://api.jsonpad.io/lists/da13b102-bd9a-4332-99bb-d73eb735f910/indexes?name=sampleFilter indexes by name (partial match).
  • optional
    pathNamestringhttps://api.jsonpad.io/lists/65a017b8-3eb0-4671-989c-fcaa9ba814c3/indexes?pathName=sampleFilter indexes by pathName (partial match).
  • optional
    valueTypestringhttps://api.jsonpad.io/lists/f86d93a0-dfa2-4eba-a238-9cab94654002/indexes?valueType=string

    Filter indexes by valueType.

    Valid values are:

    • string
    • number
    • date
  • optional
    aliasbooleanhttps://api.jsonpad.io/lists/bca1ac9a-7d89-497e-93d2-425bc154664a/indexes?alias=trueFilter for alias indexes. Can be true or false.
  • optional
    guardbooleanhttps://api.jsonpad.io/lists/a05f056b-fe04-4453-b1fa-4c70c2fa7cfe/indexes?guard=trueFilter for guard indexes. Can be true or false.
  • optional
    defaultOrderDirectionstringhttps://api.jsonpad.io/lists/ca022e10-4552-438c-84d3-4ee5dfb10d5c/indexes?defaultOrderDirection=asc

    Filter indexes by defaultOrderDirection.

    Valid values are:

    • asc
    • desc
  • optional
    taggedstringhttps://api.jsonpad.io/lists/191231ff-fb5a-41ae-a30e-0b0283d0cdfa/indexes?tagged=recipe-app

    Only fetch indexes with a tag.

    Separate tags with commas to fetch indexes with any of the tags (?tagged=recipe-app,cookbook-app), or repeat the parameter to fetch indexes with all of them (?tagged=recipe-app&tagged=production).

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: "048c6f6e-248c-4b2a-99c6-11a3050b50e3"
createdAt: "2026-11-02T13:23:24.512Z"
updatedAt: "2026-11-02T13:23:24.512Z"
name: "Sample Index"
description: ""
tags: [
0: "my-app"
]
pathName: "sample-index"
pointer: "/name"
valueType: "string"
alias: false
sorting: false
filtering: false
searching: false
guard: false
defaultOrderDirection: "asc"
activated: true
buildStatus: "ready"
}
]
}

Response headers

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