v

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0926150111.7 MB
Identities

Retrieve an identity

Retrieves detailed information about a specific identity using their identity ID or external ID from your system.

get/v2/identities/{id}

Path parameters

idstring required

Identity ID to retrieve.

Query parameters

include_metricsboolean

Include aggregate usage metrics on the returned identity.

include_budgetboolean

When true, embed the identity-scoped budget (config and limits only, no live usage) on the returned record.

Response

OK