Who am I — API — Awrora Docs

GET/api/v1/me

No scope required

Returns the organization and the API key behind the request. Use it to verify a key before building anything else. No scope required.

Example request#

bash

curl -X GET "https://your-site.awrora.app/api/v1/me" \
  -H "Authorization: Bearer $AWRORA_API_KEY"

Responses#

200The organization and the key.
401Missing, invalid, revoked or expired API key — codes "api_key_missing", "api_key_invalid", "api_key_revoked", "api_key_expired".
403The API app is off, the plan does not include the API, or the key lacks the required scope — codes "app_not_enabled", "plan_upgrade_required", "insufficient_scope" (the last carries "required_scope").
404No such resource. The same response is returned for a resource that belongs to another organization — code "not_found".
429Rate limit exceeded — code "rate_limited". See the x-ratelimit-* headers.
500Something went wrong on our side — code "internal_error".

Response 200

Field Type Description

organizationrequired

object

The organization this API key belongs to.

Field	Type	Description
`id`required	string	Awrora id (UUID) for the organization.
`slug`required	string	Organization slug.
`name`required	string	Organization display name.
`timezone`required	string	IANA timezone. All timestamps use this offset.
`default_currency`required	string	ISO 4217 code amounts are reported in.

keyrequired

object

The API key used for this request. The secret itself is never returned.

Field	Type	Description
`id`required	string	Awrora id (UUID) for the API key.
`name`required	string \| null	The name the merchant gave the key.
`prefix`required	string	First 12 characters of the key, safe to display.
`scopes`required	string[]	Scopes granted to this key.
`created_at`required	string	ISO 8601 timestamp with offset.

200 response

{
  "organization": {
    "id": "res_8f2k3n",
    "slug": "string",
    "name": "string",
    "timezone": "string",
    "default_currency": "string"
  },
  "key": {
    "id": "res_8f2k3n",
    "name": "string",
    "prefix": "string",
    "scopes": [
      "string"
    ],
    "created_at": "string"
  }
}