---
title: "Get your account"
method: GET
path: "/me"
tags: ["Account"]
---

# Get your account

`GET /me`

## Request

- Base URL: `https://gajo.io/api/v1`
- URL: `https://gajo.io/api/v1/me`
- Auth: API key in header `x-api-key`

Returns your plan and its capabilities. A cheap way to check that an API key works.

## Response `200`

Your account.

- MeResult: Envelope shared by every response.
  - `success` true, required: `true` when the request succeeded.
  - `message` string, nullable: Human-readable status or error message. Often `null` on reads.
  - `data` object, required: Operation-specific payload; `null` or absent when there is nothing to return.
    - `plan` 'Free' | 'Basic' | 'Pro', required: Gajo account plan.
    - `email` string, required: Account email address (empty string if it cannot be resolved).
    - `urlCount` integer, required: Total links ever created on the account.
    - `apiAccess` boolean, required: Whether the plan includes the API (always `true` for account plans).
    - `customCodes` boolean, required: Whether the plan can create custom short codes (Pro).
    - `routingRules` boolean, required: Whether the plan can use routing, templates, bindings and deep links (Pro).
    - `memberSince` string, date-time, required

## Other responses

- `401`: The `x-api-key` header is missing, or the key is unknown or revoked.
- `429`: Per-minute rate limit exceeded. Wait `Retry-After` seconds.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/gajo/apis/gajo-api.md) · [All operations](https://skmtc.dev/gajo/apis/gajo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gajo/apis/gajo-api/revisions/de6fe920cc26?raw)