Get API key identity

Return the API key ID, team scope, creation time and organization. The secret key value is never returned.

Request

Base URL: https://customer.rillavoice.com. Send your API key value in the Authorization header without a Bearer prefix. No parameters or request body are required.

Request example

curl --request GET \
  --url 'https://customer.rillavoice.com/me' \
  --header 'Authorization: YOUR_API_KEY'

Response

Field	Type	Description
`apiKeyId`	string	The authenticated API key's identifier, not its secret value.
`scope`	"organization" \| "teams"	Whether the key has organization-wide access or is scoped to specific teams. A key remains team-scoped even if all its configured teams are deleted.
`teams`	{ id: UUID, name?: string, deleted: boolean }[]	The teams the key is scoped to, without expanding descendants. Found teams include their current name and deleted: false, sorted by name then ID. IDs not found in the key’s organization are returned as { id, deleted: true }, without a name, after found teams in ID order. Organization-wide keys return an empty array.
`createdAt`	string · date-time	When the API key record was created, as an ISO 8601 timestamp in UTC.
`organization.id`	string · UUID	The organization the key belongs to.
`organization.name`	string	The organization's current name.

Key scope and creation time follow the authentication cache and may take up to five minutes to reflect mapping changes. Organization and team names are looked up on each request. A deleted: true entry means the ID could not be found in this organization; it does not distinguish deletion from an invalid stored ID.

200 · application/json

{
  "apiKeyId": "abc123def4",
  "scope": "teams",
  "teams": [
    {
      "id": "22222222-2222-4222-8222-222222222222",
      "name": "Sales",
      "deleted": false
    },
    {
      "id": "33333333-3333-4333-8333-333333333333",
      "deleted": true
    }
  ],
  "createdAt": "2026-11-01T14:30:00.000Z",
  "organization": {
    "id": "11111111-1111-4111-8111-111111111111",
    "name": "Example Company"
  }
}

Organization-wide and team-scoped keys return their owning organization. This does not grant access beyond the key's scope.

Missing, invalid or disabled keys return 401. If the authenticated key's organization cannot be found, the endpoint returns 404.

On this page

← Authentication Response types