No results

Fetch all lists

Fetch a page of lists.

GET https://api.jsonpad.io/lists

Example

cURL
123curl https://api.jsonpad.io/lists \
  -H "Content-Type: application/json" \
  -H "x-api-token: <YOUR TOKEN>"

Parameters

  • optional
    pagenumberhttps://api.jsonpad.io/lists?page=1The page number to fetch. Defaults to 1.
  • optional
    limitnumberhttps://api.jsonpad.io/lists?limit=20The number of lists to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/lists?order=createdAt

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

    Valid values are:

    • createdAt
    • updatedAt
    • name
    • pathName
    • pinned
    • readonly
    • realtime
    • indexable
    • protected
    • activated
  • optional
    directionstringhttps://api.jsonpad.io/lists?direction=asc

    The direction to order the lists by.

    Valid values are:

    • asc
    • desc
  • optional
    namestringhttps://api.jsonpad.io/lists?name=sampleFilter lists by name (partial match).
  • optional
    pathNamestringhttps://api.jsonpad.io/lists?pathName=sampleFilter lists by pathName (partial match).
  • optional
    pinnedbooleanhttps://api.jsonpad.io/lists?pinned=trueFilter for pinned lists. Can be true or false.
  • optional
    readonlybooleanhttps://api.jsonpad.io/lists?readonly=trueFilter for readonly lists. Can be true or false.
  • optional
    realtimebooleanhttps://api.jsonpad.io/lists?realtime=trueFilter for realtime-enabled lists. Can be true or false.
  • optional
    indexablebooleanhttps://api.jsonpad.io/lists?indexable=trueFilter for indexable lists. Can be true or false.
  • optional
    protectedbooleanhttps://api.jsonpad.io/lists?protected=trueFilter for protected lists. Can be true or false.

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: "ddad52a8-1b29-4021-8402-e1f66efa7565"
createdAt: "2026-09-05T11:29:40.572Z"
updatedAt: "2026-09-05T11:29:40.572Z"
user: {
id: "5fbb1294-36e2-4d3c-9f07-6d22a3d0905e"
createdAt: "2026-09-05T11:29:40.572Z"
updatedAt: "2026-09-05T11:29:40.572Z"
lastActiveAt: "2026-09-05T11:29:40.572Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
name: "Sample List"
pathName: "sample-list"
description: "Sample list description"
schema: null
pinned: false
readonly: false
realtime: false
protected: false
indexable: true
activated: true
itemCount: 0
}
]
}

Response headers

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