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

# Get Authenticated User

> Returns profile information, enabled features, and usage limits for the organization associated with the supplied API token.

Returns the profile, organization context, and feature limits associated with the supplied API token.

<Tip>
  The response mirrors the data that powers the ShortPen dashboard header. It is useful for confirming which workspace your automation will operate in and which plan limits are still available.
</Tip>

### Response fields

* `data.name` and `data.surname` — the contact name attached to the API key owner.
* `data.email` — email address of the key owner.
* `data.enabledFeatures` — a map keyed by feature slug. Each entry contains:
  * `name`: Human-readable label (for example `URLs`).
  * `enabled`: Whether the feature is active for the current plan.
  * `limit`, `used`, `remaining`: Numeric counters you can monitor to stay under plan quotas.

Use this endpoint before high-volume jobs to decide whether you need to queue or pause work when quotas are nearly exhausted.


## OpenAPI

````yaml POST /v1/me
openapi: 3.1.0
info:
  title: ShortPen API
  version: 1.0.0
  description: >-
    Create branded links, fetch organization resources, and pull analytics
    programmatically with the ShortPen REST API.
servers:
  - url: https://{environment}.shortpen.com
    description: ShortPen API host
    variables:
      environment:
        default: api
        enum:
          - api
          - staging-api
security: []
tags:
  - name: Core
    description: Utility endpoints for checking service health.
  - name: Authentication
    description: Endpoints that return identity, limits, and feature availability.
  - name: Links
    description: Create, edit, and list links and their auxiliary assets like QR codes.
  - name: Resources
    description: >-
      Lookup supporting entities such as domains, workspaces, folders, and
      pixels.
  - name: Analytics
    description: Retrieve click analytics and raw tracking events.
paths:
  /v1/me:
    post:
      tags:
        - Authentication
      summary: Get authenticated user context
      description: >-
        Returns profile information, enabled features, and usage limits for the
        organization associated with the supplied API token.
      operationId: getAuthenticatedUser
      responses:
        '200':
          description: Authenticated user context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfileResponse'
        '401':
          description: Missing or invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    UserProfileResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        status_code:
          type: integer
          example: 200
        message:
          type: string
          example: ''
        data:
          $ref: '#/components/schemas/UserProfile'
      required:
        - success
        - status_code
        - data
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        status_code:
          type: integer
          example: 401
        message:
          type: string
          example: There was an error while processing your request.
        data:
          description: Optional payload returned for additional context.
          nullable: true
      required:
        - success
        - status_code
        - message
    UserProfile:
      type: object
      properties:
        name:
          type: string
          example: Ada
        surname:
          type: string
          example: Lovelace
        email:
          type: string
          format: email
          example: ada@example.com
        enabledFeatures:
          type: object
          description: Feature flags and usage metrics keyed by feature slug.
          additionalProperties:
            $ref: '#/components/schemas/FeatureQuota'
      required:
        - name
        - surname
        - email
        - enabledFeatures
    FeatureQuota:
      type: object
      properties:
        name:
          type: string
          example: Links
        enabled:
          type: boolean
          example: true
        limit:
          type: integer
          example: 1000
        used:
          type: integer
          example: 312
        remaining:
          type: integer
          example: 688
      required:
        - name
        - enabled
        - limit
        - used
        - remaining
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Personal Access Token

````