UNunkeyed
identities

Get Identity

Changed on

Retrieve an identity by external ID. Returns metadata, rate limits, and other associated data.

Use this to check if an identity exists, view configurations, or build management dashboards.

Important Requires identity.*.read_identity permission

post/v2/identities.getIdentity

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/identities.getIdentity
  • Auth
    HTTP bearer

Request body

identitystring required

The ID of the identity to retrieve. This can be either the externalId (from your own system that was used during identity creation) or the identityId (the internal ID returned by the identity service).

Example request

{
  "identity": "user_abc123"
}

Response

Successfully retrieved the identity information

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": {
    "ratelimits": [
      {
        "id": "rl_1234567890abcdef",
        "name": "api_requests",
        "limit": 1000,
        "duration": 3600000,
        "autoApply": true
      }
    ]
  }
}

Changes