GET
/
v1
/
identities.listIdentities
curl --request GET \
  --url https://api.unkey.dev/v1/identities.listIdentities \
  --header 'Authorization: Bearer <token>'
{
  "identities": [
    {
      "id": "<string>",
      "externalId": "<string>",
      "ratelimits": [
        {
          "name": "tokens",
          "limit": 10,
          "duration": 1000
        }
      ]
    }
  ],
  "cursor": "eyJrZXkiOiJrZXlfMTIzNCJ9",
  "total": 123
}

Identities are in public beta. Please report any issues to support@unkey.dev

List all identities in the system. This will return a paginated list of identities.

​
Changelog

DateChanges
Jul 17 2024Introduced endpoint

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
environment
string
default:
default

This is not yet used but here for future compatibility.

​
limit
integer
default:
100

The maximum number of identities to return

Required range: 1 <= x <= 100
​
cursor
string

Use this to fetch the next page of results. A new cursor will be returned in the response if there are more results.

Response

200
application/json
A list of identities.
​
identities
object[]
required

A list of identities.

​
total
integer
required

The total number of identities for this environment

​
cursor
string

The cursor to use for the next page of results, if no cursor is returned, there are no more results

Was this page helpful?

Suggest editsRaise issue
Get an identityUpdate an identity