REST API · Account

Get the account and key

The Apogee account and the API key in use

GEThttps://api.apogee.ad/api/v1/me

Scope: any valid key Pro and Scale plans Credits: Free*

What it does

Any valid key may call it, whatever its scopes.

Request

GET /me on https://api.apogee.ad/api/v1.

Headers

Authorization string header required

Bearer apk_…: an API key with the scope of this route.

Response

200.

user object
Fields (3)
- id string
- email string or null
- name string or null
key object
Fields (4)
- id string
- scopes array of strings
  
  One of read, launch, actions
- name string or null
- expires_at string (date-time) or null
api_version string
platforms array of strings

Every answer carries X-Request-Id (give it to support), Apogee-Version: 2026-10-06, and the RateLimit and RateLimit-Policy headers.

Errors

Errors are application/problem+json with a stable code to switch on (all the codes).

Status	Possible codes
400 Bad request	`idempotency_key_required`, `not_supported`, `request_refused`, `validation_failed`
401 Unauthorized	`invalid_api_key`
403 Forbidden	`account_not_connected`, `forbidden`, `insufficient_scope`, `meta_permission_denied`, `platform_permission_denied`, `upgrade_required`
404 Not found	`not_found`
429 Too many requests	`daily_read_cap`, `meta_rate_limited`, `platform_rate_limited`, `quota_exceeded`, `rate_limited`
500 Internal server error	`internal_error`

Example

With your key in APOGEE_API_KEY (create one):

Request

curl 'https://api.apogee.ad/api/v1/me' \
  -H "Authorization: Bearer $APOGEE_API_KEY"

Response 200 (shape)

{
  "user": {
    "id": "0c6f4b2e-8a1d-4f37-9e25-7b3d1a9c5e80",
    "email": "alex@example.com",
    "name": "Alex Martin"
  },
  "key": {
    "id": "a4e1c7b9-3d52-4f86-8b0e-6c2a9f5d1e73",
    "name": "Reporting script",
    "scopes": [
      "read"
    ],
    "expires_at": "2026-10-23T09:00:00.000Z"
  },
  "api_version": "2026-10-06",
  "platforms": [
    "meta"
  ]
}

Access and cost

Plans	Pro and Scale.
Scope	`any valid key` (scopes).
Credits	Free up to the daily free reads (5,000 a day on Pro, 10,000 on Scale), then 1 credit per read. A request that fails costs nothing, a replayed one neither (credits).
Rate limit	Read: 600 per 15 minutes on Pro, 1,200 on Scale (rate limits).

In the MCP

An AI assistant does the same with this tool of the MCP server:

whoami: The Apogee account this connection acts as, the credential used (an assistant's connection or an API key) and its scopes.