API ReferenceReference
Get an end user
The identity plus every subscription (with credit usage) and access grant.
Requires the end_users:read scope.
Authorization
apiKey AuthorizationBearer <token>
An organization API key, created from a Storefront's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
endUserId*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/end-users/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "endUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "fullName": "string", "authMethod": "string", "emailVerifiedAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "lastSeenAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "subscriptions": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "tierPlanId": "5e2e90db-0903-4f92-af9a-07e1540bc709", "tierPlanName": "string", "status": "string", "creditAllowance": 0, "creditsUsed": 0, "creditsResetAt": "2019-08-24T14:15:22Z", "provisionedBy": "string", "isComped": true, "bonusCredits": 0 } ], "grants": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "targetKind": "app", "targetId": "cbca1126-180e-4334-9df8-cf82289d378b", "effect": "allow", "deploymentId": "a73c85a1-d857-491e-a6b2-51dce05de7a2", "source": "string", "expiresAt": "2019-08-24T14:15:22Z" } ] }}