Account

Current key and plan

GET /api/v1/me

Who the key belongs to, its scopes, and your plan’s API allowance.

API key access: Read only or read and write
Project permission: None — acts on your own account
Success: 200 — OK

Example request

Replace tk_live_YOUR_KEY with your API key.

curl 'https://trackerv2.marketingplanet.global/api/v1/me' \
  -H 'Authorization: Bearer tk_live_YOUR_KEY'

const response = await fetch('https://trackerv2.marketingplanet.global/api/v1/me', {
  headers: {
    Authorization: 'Bearer tk_live_YOUR_KEY',
  },
});

const result = await response.json();
if (!response.ok) throw new Error(`${result.error.code}: ${result.error.message}`);
console.log(result.data);

import requests

response = requests.get(
    "https://trackerv2.marketingplanet.global/api/v1/me",
    headers={"Authorization": "Bearer tk_live_YOUR_KEY"},
)
result = response.json()
if not response.ok:
    raise RuntimeError(f"{result['error']['code']}: {result['error']['message']}")
print(result["data"])

Example response

200 OK

{
  "data": {
    "user": {
      "id": "64b7f0c2a1e4d5f6a7b8c901",
      "name": "Alex Rivera",
      "email": "alex@acmeretail.com"
    },
    "apiKey": {
      "id": "66a1c3e5f7a9b1c3d5e7f901",
      "name": "Reporting script",
      "prefix": "tk_live_3f9a1c7e2b40",
      "scopes": [
        "read",
        "write"
      ],
      "expiresAt": "2027-01-04T09:00:00.000Z"
    },
    "plan": {
      "key": "growth",
      "maxApiKeys": 3,
      "requestsPerMinute": 300
    }
  }
}

Response fields

Field	Type	Notes
`data`	object
`data.user`	object
`data.user.id`	string
`data.user.name`	string or null
`data.user.email`	string
`data.apiKey`	object
`data.apiKey.id`	string
`data.apiKey.name`	string
`data.apiKey.prefix`	string
`data.apiKey.scopes`	array of "read" \| "write"
`data.apiKey.expiresAt`	string (date-time) or null
`data.plan`	object
`data.plan.key`	string
`data.plan.maxApiKeys`	integer
`data.plan.requestsPerMinute`	integer

Errors

Only the errors any request can return: a missing or invalid key, no API access on your plan, or the rate limit.

Errors always look like { "error": { "code": "…", "message": "…" } }. See Errors & limits.