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/91204ba3-877d-4572-b9ac-b02683e51bd6/indexes \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/f320832b-208e-4dd4-b405-62e7c4a2d60b/indexes?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/3bf42704-3ed5-4688-ae7b-6555bfaf3164/indexes?limit=20The number of indexes to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/9b1b1209-10c8-4a93-a92b-b6d40718eeeb/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/0d39c238-aad8-48c9-a33e-e2546e905eb9/indexes?direction=asc

    The direction to order the indexes by.

    Valid values are:

    • asc
    • desc
  • optional
    namestringhttps://api.jsonpad.io/lists/b668bf4b-1e9a-43c1-87ac-6a340f0fdce5/indexes?name=sampleFilter indexes by name (partial match).
  • optional
    pathNamestringhttps://api.jsonpad.io/lists/b9462acc-1158-4540-9e07-f08cc0fd45ef/indexes?pathName=sampleFilter indexes by pathName (partial match).
  • optional
    valueTypestringhttps://api.jsonpad.io/lists/1eb2572a-dd65-4379-aef5-035c4faa8541/indexes?valueType=string

    Filter indexes by valueType.

    Valid values are:

    • string
    • number
    • date
  • optional
    aliasbooleanhttps://api.jsonpad.io/lists/540fa77f-cd38-4a9f-bff1-c456d5544532/indexes?alias=trueFilter for alias indexes. Can be true or false.
  • optional
    guardbooleanhttps://api.jsonpad.io/lists/fc13898d-a638-43af-9322-d1c5672f103d/indexes?guard=trueFilter for guard indexes. Can be true or false.
  • optional
    defaultOrderDirectionstringhttps://api.jsonpad.io/lists/7bd8319d-d64c-4da3-992e-ec4cd63b50d9/indexes?defaultOrderDirection=asc

    Filter indexes by defaultOrderDirection.

    Valid values are:

    • asc
    • desc
  • optional
    taggedstringhttps://api.jsonpad.io/lists/f9993a17-5541-42d7-b813-eba5f7633ffc/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: "281d3d42-94c9-422a-b4f4-0516d841f448"
createdAt: "2026-09-23T21:08:33.151Z"
updatedAt: "2026-09-23T21:08:33.151Z"
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