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/405aeb07-4899-4a45-b5c7-4b2f9c473a75/indexes \ -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • optional
    pagenumberhttps://api.jsonpad.io/lists/3963e186-63eb-4197-9124-d6f6152eec28/indexes?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists/c280714b-ebbc-442b-b74c-961d54c95a33/indexes?limit=20The number of indexes to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists/712dc162-efae-402d-be59-e2e002db5512/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/7236cddd-d27b-409d-83b5-9d77210a958e/indexes?direction=asc

    The direction to order the indexes by.

    Valid values are:

    • asc
    • desc
  • optional
    namestringhttps://api.jsonpad.io/lists/1679e818-31e3-41b4-8a34-480253c82ded/indexes?name=sampleFilter indexes by name (partial match).
  • optional
    pathNamestringhttps://api.jsonpad.io/lists/c3df49b4-9ea8-45b4-81e5-87c20444102a/indexes?pathName=sampleFilter indexes by pathName (partial match).
  • optional
    valueTypestringhttps://api.jsonpad.io/lists/eaefccb7-8d86-4c47-90d7-586b9453e0f9/indexes?valueType=string

    Filter indexes by valueType.

    Valid values are:

    • string
    • number
    • date
  • optional
    aliasbooleanhttps://api.jsonpad.io/lists/6a58d1df-b2d5-4fd6-95e7-20f55505ce2f/indexes?alias=trueFilter for alias indexes. Can be true or false.
  • optional
    guardbooleanhttps://api.jsonpad.io/lists/7fb69bad-a778-454f-a60c-5a25dc802f07/indexes?guard=trueFilter for guard indexes. Can be true or false.
  • optional
    defaultOrderDirectionstringhttps://api.jsonpad.io/lists/6521f17c-129c-42c4-adc2-007c2fd64364/indexes?defaultOrderDirection=asc

    Filter indexes by defaultOrderDirection.

    Valid values are:

    • asc
    • desc
  • optional
    taggedstringhttps://api.jsonpad.io/lists/90240fbd-dbb2-417e-a029-12a8b77f8fd3/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: "384a4161-6a28-4b24-b7a0-3a711b875d1b"
createdAt: "2026-10-07T22:12:28.094Z"
updatedAt: "2026-10-07T22:12:28.094Z"
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