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

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

Retrieve an identity either by identityId or by externalId.

The response will include the identity as well as its configured rate limits.

​
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

​
identityId
string

The id of the identity to fetch, use either identityId or externalId, if both are provided, identityId takes precedence.

Minimum length: 1
Example:

"id_1234"

​
externalId
string

The externalId of the identity to fetch, use either identityId or externalId, if both are provided, identityId takes precedence.

Minimum length: 1
Example:

"id_1234"

Response

200
application/json

The configuration for an api

The response is of type object.