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 identities

Fetch a page of identities.

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

Example

cURL
12curl https://api.jsonpad.io/identities \ -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 identities to fetch per page. Defaults to 20.
  • optional
    orderstringhttps://api.jsonpad.io/identities?order=createdAt

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

    Valid values are:

    • createdAt
    • updatedAt
    • name
    • displayNameIdentities without a display name are sorted last.
    • group
    • activated
  • optional
    directionstringhttps://api.jsonpad.io/identities?direction=asc

    The direction to order the identities by.

    Valid values are:

    • asc
    • desc
  • optional
    namestringhttps://api.jsonpad.io/identities?name=sampleFilter identities by name (partial match).
  • optional
    displayNamestringhttps://api.jsonpad.io/identities?displayName=sampleFilter identities by display name (partial match).
  • optional
    groupstringhttps://api.jsonpad.io/identities?group=sampleFilter identities by group (partial match).
  • optional
    taggedstringhttps://api.jsonpad.io/identities?tagged=recipe-app

    Only fetch identities with a tag.

    Separate tags with commas to fetch identities with any of the tags (?tagged=recipe-app,cookbook-app), or repeat the parameter to fetch identities 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: "d7acc294-b0e1-4aa0-a04e-20723dec77eb"
createdAt: "2026-09-23T21:08:42.194Z"
updatedAt: "2026-09-23T21:08:42.194Z"
user: {
id: "3699f998-361f-4436-bb69-d703b65b38aa"
createdAt: "2026-09-23T21:08:42.194Z"
updatedAt: "2026-09-23T21:08:42.194Z"
lastActiveAt: "2026-09-23T21:08:42.194Z"
activated: true
displayName: "Sample User"
description: "Sample user description"
}
group: "sample-group"
name: "Sample Identity"
displayName: "Sample Display Name"
tags: [
0: "my-app"
]
lastLoginAt: "2026-09-23T21:08:42.194Z"
activated: true
}
]
}

Response headers

  • x-total1The total number of results available.
  • x-pages1The total number of pages available.
2024-12-07