> ## Documentation Index
> Fetch the complete documentation index at: https://docs.urldn.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve account

> Returns your plan, usage and limits, and works with any key, whatever its scopes. A limit
of `-1` means unlimited. The `links` and `qrCodes` limits count what is in your account
now, not what you created this month.




## OpenAPI

````yaml /openapi.yaml get /me
openapi: 3.1.0
info:
  title: URLdn API
  version: 1.0.0
  description: >
    Create and manage short links, tags and custom domains, read click
    analytics, generate

    QR codes and ask the AI analyst. Included on every plan, with limits by
    plan. Limits apply

    to your whole account, across all its keys.


    Keep API keys on your server: anything in front-end code can be read by
    anyone.
servers:
  - url: https://api.urldn.com/v1
security:
  - apiKey: []
tags:
  - name: Links
  - name: Tags
  - name: Domains
  - name: Analytics
  - name: QR codes
  - name: AI analyst
  - name: Account
paths:
  /me:
    get:
      tags:
        - Account
      summary: Retrieve account
      description: >
        Returns your plan, usage and limits, and works with any key, whatever
        its scopes. A limit

        of `-1` means unlimited. The `links` and `qrCodes` limits count what is
        in your account

        now, not what you created this month.
      operationId: getMe
      responses:
        '200':
          description: The account the key belongs to
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  headers:
    RequestId:
      description: Quote this if you contact support. Sent on every response.
      schema:
        type: string
    RateLimitLimit:
      description: Requests allowed per minute for your account
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in this window
      schema:
        type: integer
    RateLimitReset:
      description: When the window resets, in Unix seconds
      schema:
        type: integer
  schemas:
    Me:
      type: object
      required:
        - plan
        - usage
        - limits
        - apiKey
      properties:
        plan:
          type: string
          enum:
            - free
            - pro
            - business
            - enterprise
        usage:
          type: object
          properties:
            links:
              allOf:
                - $ref: '#/components/schemas/Usage'
              description: Links in your account, not per month
            qrCodes:
              $ref: '#/components/schemas/Usage'
            aiQuestions:
              allOf:
                - $ref: '#/components/schemas/Usage'
                - type: object
                  properties:
                    resetsAt:
                      type: string
                      format: date-time
            requests:
              allOf:
                - $ref: '#/components/schemas/Usage'
                - type: object
                  properties:
                    resetsAt:
                      type: string
                      format: date-time
              description: API requests this period, across all your keys
        limits:
          type: object
          properties:
            requestsPerMinute:
              type: integer
            monthlyRequests:
              type: integer
              description: '-1 means unlimited'
            activeKeys:
              type: integer
            customDomains:
              type: integer
              description: '-1 means unlimited'
        apiKey:
          type: object
          properties:
            id:
              type: string
            name:
              type: string
            scopes:
              type: array
              items:
                type: string
                enum:
                  - links:read
                  - links:write
                  - domains:read
                  - domains:write
                  - analytics:read
                  - qr:write
                  - ai:ask
    Usage:
      type: object
      required:
        - used
        - limit
      properties:
        used:
          type: integer
        limit:
          type: integer
          description: '-1 means unlimited'
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: A stable machine-readable code
          examples:
            - quota_exceeded
        message:
          type: string
        details:
          type: object
          additionalProperties: true
  responses:
    Unauthorized:
      description: '`missing_api_key`, `invalid_api_key` or `revoked_api_key`'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: '`plan_required`, `insufficient_scope` or `domain_not_allowed`'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: >-
        `rate_limited`, `monthly_quota_exceeded` or `too_many_auth_failures`.
        Wait for `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer urldn_live_...`'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.