Gajo App Links API

Pro: one short link that sends iPhones and iPads to the App Store, Android devices to Google Play, and shows every other device a page with a QR code.

GitHub OpenAPI

Operations 3

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-app-links-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-app-links-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Gajo App Links 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: App Links
  description: 'Pro: one short link that sends iPhones and iPads to the App Store, Android devices to Google Play, and shows every other device a page with a QR code.'
paths:
  /app-links:
    post:
      operationId: createAppLink
      tags:
      - App Links
      summary: Create an app link
      description: Pro. Creates one short link that sends iPhones and iPads to the App Store (or TestFlight), Android devices to Google Play, and shows every other device (desktops, link previews) a page in the `otherwise` style with a QR code of the link. iPads that report a desktop browser are sent to the App Store by the page. Counts against the monthly link allowance like `POST /shorten`. Each URL is an app's store page or, before release, a TestFlight or Google Play test link; the official badges (`store_badges`) are only for apps published in both stores.
      x-gajo-plan: Pro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/AppLinkRequest'
              - required:
                - iosUrl
                - androidUrl
                - otherwise
            example:
              iosUrl: https://apps.apple.com/us/app/acme/id123456789
              androidUrl: https://play.google.com/store/apps/details?id=com.acme
              otherwise: store_badges
              appName: Acme
      responses:
        '200':
          description: The app link.
          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/ShortUrlResult'
              example:
                success: true
                message: App link created
                data:
                  shortCode: Xk4mP
                  originalUrl: https://apps.apple.com/us/app/acme/id123456789
                  fallbackUrl: null
                  active: true
                  clickCount: 0
                  isCustomCode: false
                  createdDate: '2026-10-23T14:03:11.482Z'
                  expiresDate: null
                  appLink:
                    iosUrl: https://apps.apple.com/us/app/acme/id123456789
                    androidUrl: https://play.google.com/store/apps/details?id=com.acme
                    otherwise: store_badges
                    appName: Acme
                    iconUrl: https://img.gajo.io/u/2f1c/acme-icon.jpg
                    qrCodeUrl: https://img.gajo.io/u/2f1c/xk4mp-qr.png
        '400':
          description: 'Invalid input: a URL that isn''t a store page or test link, an unknown `otherwise`, or `store_badges` with a test link or no app name.'
          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/ErrorResult'
              example:
                success: false
                message: iosUrl must be an https App Store app link (apps.apple.com/.../id...) or TestFlight link (testflight.apple.com/join/...)
                data: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Your plan is not Pro. Also when the account isn't active (not activated yet, or switched off).
          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/ErrorResult'
              example:
                success: false
                message: A Pro plan is required for app links
                data: null
        '409':
          description: The requested custom code is taken, released, or already linked to a URL.
          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/ErrorResult'
              example:
                success: false
                message: Custom code 'acme' is already taken
                data: null
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
  /urls/{code}/app-link:
    parameters:
    - $ref: '#/components/parameters/ShortCode'
    get:
      operationId: getAppLink
      tags:
      - App Links
      summary: Get an app link's settings
      description: Pro. 404 when the link isn't an app link (or isn't yours).
      x-gajo-plan: Pro
      responses:
        '200':
          description: The app link's settings.
          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/AppLinkResult'
              example:
                success: true
                message: null
                data:
                  iosUrl: https://apps.apple.com/us/app/acme/id123456789
                  androidUrl: https://play.google.com/store/apps/details?id=com.acme
                  otherwise: store_badges
                  appName: Acme
                  iconUrl: https://img.gajo.io/u/2f1c/acme-icon.jpg
                  qrCodeUrl: https://img.gajo.io/u/2f1c/xk4mp-qr.png
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Your plan is not Pro. Also when the account isn't active (not activated yet, or switched off).
          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/ErrorResult'
              example:
                success: false
                message: A Pro plan is required for app links
                data: null
        '404':
          description: No such link on your account, or it isn't an app link.
          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/ErrorResult'
              example:
                success: false
                message: This link isn't an app link
                data: null
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    put:
      operationId: updateAppLink
      tags:
      - App Links
      summary: Change an app link
      description: Pro. Changes only the fields given. A new `iosUrl` also becomes the link's `originalUrl` and refreshes the looked-up icon (and the name, unless `appName` is given).
      x-gajo-plan: Pro
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AppLinkRequest'
            example:
              otherwise: mobile_only
      responses:
        '200':
          description: The updated app link.
          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/ShortUrlResult'
              example:
                success: true
                message: App link updated
                data:
                  shortCode: Xk4mP
                  originalUrl: https://apps.apple.com/us/app/acme/id123456789
                  fallbackUrl: null
                  active: true
                  clickCount: 0
                  isCustomCode: false
                  createdDate: '2026-10-23T14:03:11.482Z'
                  expiresDate: null
                  appLink:
                    iosUrl: https://apps.apple.com/us/app/acme/id123456789
                    androidUrl: https://play.google.com/store/apps/details?id=com.acme
                    otherwise: mobile_only
                    appName: Acme
                    iconUrl: https://img.gajo.io/u/2f1c/acme-icon.jpg
                    qrCodeUrl: https://img.gajo.io/u/2f1c/xk4mp-qr.png
        '400':
          description: Invalid input.
          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/ErrorResult'
              example:
                success: false
                message: otherwise must be one of mobile_only, store_links, store_badges (got fancy)
                data: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: Your plan is not Pro. Also when the account isn't active (not activated yet, or switched off).
          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/ErrorResult'
              example:
                success: false
                message: A Pro plan is required for app links
                data: null
        '404':
          description: No such link on your account, or it isn't an app link.
          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/ErrorResult'
              example:
                success: false
                message: This link isn't an app link
                data: null
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  schemas:
    ShortUrl:
      type: object
      description: 'A short link. Generated codes redirect at `https://gajo.io/{shortCode}`; custom codes (`isCustomCode: true`, created in the Pro dashboard) redirect at `https://gajo.io/c/{shortCode}`. All redirects are HTTP 302.'
      required:
      - shortCode
      - originalUrl
      - fallbackUrl
      - active
      - clickCount
      - isCustomCode
      - createdDate
      - expiresDate
      properties:
        shortCode:
          type: string
          description: The short code. Generated codes are never reassigned.
        originalUrl:
          type: string
          description: Destination URL (may be an app deep link on Pro).
        fallbackUrl:
          type:
          - string
          - 'null'
          description: Web fallback used when `originalUrl` is an app deep link and the app is not installed (e.g. the App Store listing). `null` otherwise.
        active:
          type: boolean
          description: '`false` once the link has been deactivated.'
        clickCount:
          type: integer
          format: int64
          minimum: 0
          description: Human clicks (bot and link-preview traffic excluded).
        isCustomCode:
          type: boolean
          description: '`true` for Pro custom codes (served under `/c/`).'
        createdDate:
          type: string
          format: date-time
        expiresDate:
          type:
          - string
          - 'null'
          format: date-time
          description: When the link stops redirecting; `null` = never expires.
        appLink:
          $ref: '#/components/schemas/AppLink'
          description: 'App links only (returned by `GET /urls/{code}` and the app-link endpoints): where iOS and Android go, and the page other devices see.'
    AppLinkRequest:
      type: object
      description: Create an app link (`iosUrl`, `androidUrl`, and `otherwise` required) or change one (only the fields given change; `customCode` is ignored).
      properties:
        iosUrl:
          type: string
          description: The app's App Store page (`https://apps.apple.com/.../id...`) or, for a beta, its TestFlight link (`https://testflight.apple.com/join/...`).
        androidUrl:
          type: string
          description: The app's Google Play page (`https://play.google.com/store/apps/details?id=...`) or a Google Play test link (`https://play.google.com/apps/internaltest/...` or `/apps/testing/...`).
        otherwise:
          $ref: '#/components/schemas/AppLinkStyle'
        appName:
          type: string
          maxLength: 100
          description: Optional; looked up from the App Store when omitted. Required for `store_badges` when the lookup can't find the app.
        customCode:
          type: string
          description: 'Create only: a custom code (3-50 letters, digits, or hyphens) for a `https://gajo.io/c/{code}` link.'
    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.
    AppLinkStyle:
      type: string
      enum:
      - mobile_only
      - store_links
      - store_badges
      description: 'The page every device that isn''t iOS or Android (desktops, link previews) sees, always with a QR code of the short link to scan with a phone: `mobile_only` says the link must be opened in a mobile browser; `store_links` lists both store URLs in full; `store_badges` shows the official App Store and Google Play badges under "Click below to download {appName}", so it needs both apps published: TestFlight and Google Play test links use `store_links` (which says they are test builds) or `mobile_only`.'
    AppLink:
      type: object
      description: An app link's stores and page. iPhones and iPads go to `iosUrl`, Android devices to `androidUrl`, and every other device sees the `otherwise` page.
      required:
      - iosUrl
      - androidUrl
      - otherwise
      properties:
        iosUrl:
          type: string
          description: The app's App Store page (`https://apps.apple.com/.../id...`) or, for a beta, its TestFlight link (`https://testflight.apple.com/join/...`). Also the link's `originalUrl`.
        androidUrl:
          type: string
          description: The app's Google Play page (`https://play.google.com/store/apps/details?id=...`) or a Google Play test link (`https://play.google.com/apps/internaltest/...` or `/apps/testing/...`).
        otherwise:
          $ref: '#/components/schemas/AppLinkStyle'
        appName:
          type:
          - string
          - 'null'
          description: Shown on the page. Looked up from the App Store when not given.
        iconUrl:
          type:
          - string
          - 'null'
          description: The App Store icon, copied to img.gajo.io; `null` when the lookup found none.
        qrCodeUrl:
          type:
          - string
          - 'null'
          description: QR code of the short link, shown on the page.
    AppLinkResult:
      description: Envelope with an app link's settings.
      allOf:
      - $ref: '#/components/schemas/ApiResult'
      - type: object
        required:
        - data
        properties:
          success:
            const: true
          data:
            $ref: '#/components/schemas/AppLink'
    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.
    ShortUrlResult:
      description: Envelope with one short link.
      allOf:
      - $ref: '#/components/schemas/ApiResult'
      - type: object
        required:
        - data
        properties:
          success:
            const: true
          data:
            $ref: '#/components/schemas/ShortUrl'
  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
  parameters:
    ShortCode:
      name: code
      in: path
      required: true
      description: Short code of one of your links (the part after `https://gajo.io/` or `https://gajo.io/c/`).
      schema:
        type: string
        pattern: ^[A-Za-z0-9-]{3,50}$
      example: Xk4mPq
  responses:
    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