No results

View an index

Fetch a specific index.

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

Example

cURL
123curl https://api.jsonpad.io/lists/38d8cf96-24cc-4c68-8255-5ec6b8abbc50/indexes/b4a50118-275a-4d2f-9934-80165b1b77fc \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • required
    listIdstringA list id or path name.
  • required
    indexIdstringAn index id or path name.

Request headers

  • required
    x-api-tokenstringYour API token.
  • optional
    if-modified-since

    An ISO 8601 date.

    If the index hasn't been updated since this date, we return an empty 304 ("Not modified") response, and the request will not be counted towards any active rate limits.

Request body

No request body

Response body

200 OK
{
id: "cf388670-97a0-485b-8f6d-29d19cfe6351"
createdAt: "2026-09-05T11:30:20.603Z"
updatedAt: "2026-09-05T11:30:20.603Z"
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

  • last-modified2026-09-05T11:30:20.603ZThe date this index was last modified.
2024-10-29