Gajo Account API

Your plan, capabilities and usage. Available on every plan.

GitHub OpenAPI

Operations 2

GET /me Get your account #
GET /usage Get usage and limits #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/gajo-io:gajo-io-account-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gajo-io-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gajo Account API
  version: '1.0'
  summary: Short links, QR codes, click analytics, device routing, A/B split links and app deep links.
  description: 'Gajo is a URL shortener with QR codes, click analytics, device-based routing, A/B split links, and app deep links with an App Store / Google Play fallback. This REST API creates and manages short links and returns their click analytics.


    **Every Gajo account plan includes the core API, including Free (no credit card required).** Create an account, generate a key on the API Keys page, and send it in the `x-api-key` header on every request.


    ## Plans


    | | Free | Basic | Pro |

    |---|---|---|---|

    | Price | $0, no card | $4.99 / month | $9.99 / month |

    | New URLs per month | 50 | 500 | 10,000 |

    | API requests per minute | 10 | 30 | 60 |

    | Max link lifetime | 60 days | 120 days | Unlimited |

    | Generated short code length | 6 characters | 5 characters | 5 characters |

    | `GET /urls/{code}/stats` | Click totals + 7-day history | Full analytics: 90-day history, referrers, devices, countries, regions | Full analytics: full history since the link was created |

    | Batch shortening, editing destinations, routing rules, route & A/B templates, bindings, app deep links | — | — | Yes |


    Operations marked `x-gajo-plan: Pro` return `403` with a message such as `"A Pro plan is required for batch shortening"` on Free and Basic. The monthly URL allowance is shared with links created in the dashboard. Full plan details: gajo.io/pricing.


    ## Responses


    Every response uses the same JSON envelope: `{"success": true|false, "message": string|null, "data": ...}`. On errors `success` is `false` and `message` explains why.


    ## Rate limits


    Each API key may make the plan''s number of requests per 60-second sliding window. Responses carry `X-RateLimit-Limit` and `X-RateLimit-Remaining`; over the limit the API returns `429` with a `Retry-After` header (seconds). `POST /shorten` also returns `429` once the monthly URL allowance is used up.


    Guides and examples: gajo.io/docs.'
  termsOfService: https://gajo.io/terms
  contact:
    name: Gajo
    url: https://gajo.io
servers:
- url: https://gajo.io/api/v1
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Account
  description: Your plan, capabilities and usage. Available on every plan.
paths:
  /me:
    get:
      operationId: getMe
      tags:
      - Account
      summary: Get your account
      description: Returns your plan and its capabilities. A cheap way to check that an API key works.
      responses:
        '200':
          description: Your account.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MeResult'
              example:
                success: true
                message: null
                data:
                  plan: Free
                  email: you@example.com
                  urlCount: 12
                  apiAccess: true
                  customCodes: false
                  routingRules: false
                  memberSince: '2026-03-22T12:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountInactive'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
  /usage:
    get:
      operationId: getUsage
      tags:
      - Account
      summary: Get usage and limits
      description: This month's link creation against your plan's allowance, plus your API rate limit and maximum link lifetime. The monthly allowance is shared with links created in the dashboard.
      responses:
        '200':
          description: Usage for the current calendar month.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/X-RateLimit-Limit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/X-RateLimit-Remaining'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResult'
              examples:
                free:
                  summary: Free plan
                  value:
                    success: true
                    message: null
                    data:
                      plan: Free
                      urlsCreatedThisMonth: 8
                      urlsMonthlyLimit: 50
                      urlsRemaining: 42
                      requestsPerMinute: 10
                      maxLinkLifetimeDays: 60
                      totalUrls: 12
                      totalClicks: 318
                pro:
                  summary: Pro plan (unlimited lifetime)
                  value:
                    success: true
                    message: null
                    data:
                      plan: Pro
                      urlsCreatedThisMonth: 1240
                      urlsMonthlyLimit: 10000
                      urlsRemaining: 8760
                      requestsPerMinute: 60
                      maxLinkLifetimeDays: null
                      totalUrls: 5321
                      totalClicks: 182904
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/AccountInactive'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    Usage:
      type: object
      required:
      - plan
      - urlsCreatedThisMonth
      - urlsMonthlyLimit
      - urlsRemaining
      - requestsPerMinute
      - maxLinkLifetimeDays
      - totalUrls
      - totalClicks
      properties:
        plan:
          $ref: '#/components/schemas/Plan'
        urlsCreatedThisMonth:
          type: integer
          minimum: 0
          description: Links created since the start of the calendar month (UTC), via the API or dashboard.
        urlsMonthlyLimit:
          type: integer
          minimum: 1
          description: Monthly link allowance for the plan (50 Free, 500 Basic, 10,000 Pro).
        urlsRemaining:
          type: integer
          minimum: 0
          description: Links you can still create this month.
        requestsPerMinute:
          type: integer
          minimum: 1
          description: API requests allowed per 60-second window (10 Free, 30 Basic, 60 Pro).
        maxLinkLifetimeDays:
          type:
          - integer
          - 'null'
          minimum: 1
          description: Longest allowed link lifetime in days; `null` = unlimited (Pro).
        totalUrls:
          type: integer
          minimum: 0
          description: All links on the account.
        totalClicks:
          type: integer
          format: int64
          minimum: 0
          description: Human clicks across all links.
    Me:
      type: object
      required:
      - plan
      - email
      - urlCount
      - apiAccess
      - customCodes
      - routingRules
      - memberSince
      properties:
        plan:
          $ref: '#/components/schemas/Plan'
        email:
          type: string
          description: Account email address (empty string if it cannot be resolved).
        urlCount:
          type: integer
          format: int64
          minimum: 0
          description: Total links ever created on the account.
        apiAccess:
          type: boolean
          description: Whether the plan includes the API (always `true` for account plans).
        customCodes:
          type: boolean
          description: Whether the plan can create custom short codes (Pro).
        routingRules:
          type: boolean
          description: Whether the plan can use routing, templates, bindings and deep links (Pro).
        memberSince:
          type: string
          format: date-time
    Plan:
      type: string
      enum:
      - Free
      - Basic
      - Pro
      description: Gajo account plan.
    ApiResult:
      type: object
      description: Envelope shared by every response.
      required:
      - success
      properties:
        success:
          type: boolean
          description: '`true` when the request succeeded.'
        message:
          type:
          - string
          - 'null'
          description: Human-readable status or error message. Often `null` on reads.
        data:
          description: Operation-specific payload; `null` or absent when there is nothing to return.
    UsageResult:
      description: Envelope with usage details.
      allOf:
      - $ref: '#/components/schemas/ApiResult'
      - type: object
        required:
        - data
        properties:
          success:
            const: true
          data:
            $ref: '#/components/schemas/Usage'
    MeResult:
      description: Envelope with account details.
      allOf:
      - $ref: '#/components/schemas/ApiResult'
      - type: object
        required:
        - data
        properties:
          success:
            const: true
          data:
            $ref: '#/components/schemas/Me'
    ErrorResult:
      type: object
      description: Error envelope. `success` is always `false` and `message` explains the problem.
      required:
      - success
      - message
      properties:
        success:
          const: false
        message:
          type: string
        data:
          type: 'null'
          description: Always `null` (or absent) on errors.
  headers:
    X-RateLimit-Remaining:
      description: Requests left in the current 60-second window.
      schema:
        type: integer
        minimum: 0
    Retry-After:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        minimum: 1
    X-RateLimit-Limit:
      description: Requests allowed per 60-second sliding window for your plan (10 Free, 30 Basic, 60 Pro).
      schema:
        type: integer
        minimum: 1
  responses:
    AccountInactive:
      description: 'The key works, but its account isn''t active: it hasn''t been activated yet (open the emailed link, or sign in for a new one), or it was switched off. The message says which.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResult'
          examples:
            notActivated:
              summary: Account not activated yet
              value:
                success: false
                message: This Gajo account isn't activated yet. Open the link we emailed you, or sign in at gajo.io to get a new one.
            switchedOff:
              summary: Account switched off
              value:
                success: false
                message: This Gajo account is switched off. Contact support if you think that's a mistake.
    RateLimited:
      description: Per-minute rate limit exceeded. Wait `Retry-After` seconds.
      headers:
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResult'
          example:
            success: false
            message: Rate limit exceeded. Please try again later.
    Unauthorized:
      description: The `x-api-key` header is missing, or the key is unknown or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResult'
          examples:
            missingKey:
              summary: No x-api-key header
              value:
                success: false
                message: Missing x-api-key header
            invalidKey:
              summary: Unknown or revoked key
              value:
                success: false
                message: Invalid API key
    ServerError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResult'
          examples:
            internal:
              summary: Unexpected error
              value:
                success: false
                message: Internal server error
                data: null
            internalShort:
              summary: Missing record
              value:
                success: false
                message: Internal error
                data: null
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/X-RateLimit-Limit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/X-RateLimit-Remaining'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Your Gajo API key. Generate one on the API Keys page of your account (https://gajo.io/account/keys).
externalDocs:
  description: Gajo API documentation
  url: https://gajo.io/docs