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

# Retrieves a User resource.

> Retrieves a User resource.



## OpenAPI

````yaml /openapi.json get /api/users/me
openapi: 3.1.0
info:
  title: AnyIP.io API documentation
  description: >-
    The anyIP REST API allows you to programmatically manage proxy accounts,
    monitor traffic, and access geographic data. Authenticate using your API
    key.
  version: 1.0.0
servers:
  - url: https://dashboard.anyip.io
    description: anyIP Production API
security:
  - apiHeader: []
tags: []
paths:
  /api/users/me:
    get:
      tags:
        - User
      summary: Retrieves a User resource.
      description: Retrieves a User resource.
      operationId: api_usersme_get
      parameters: []
      responses:
        '200':
          description: User resource
          content:
            application/ld+json:
              schema:
                $ref: '#/components/schemas/User.jsonld-read'
            application/json:
              schema:
                $ref: '#/components/schemas/User-read'
            text/html:
              schema:
                $ref: '#/components/schemas/User-read'
        '404':
          description: Resource not found
      deprecated: false
components:
  schemas:
    User.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        apps:
          type: array
          items:
            $ref: '#/components/schemas/App.jsonld-read'
        email:
          format: email
          externalDocs:
            url: https://schema.org/email
          type: string
        enabled:
          type: boolean
        api_key:
          type:
            - string
            - 'null'
        id:
          readOnly: true
          type: string
        past_subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription.jsonld-read'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment.jsonld-read'
        roles:
          type: array
          items:
            type: string
        subscription:
          anyOf:
            - $ref: '#/components/schemas/Subscription.jsonld-read'
            - type: 'null'
        try_at:
          type:
            - string
            - 'null'
          format: date-time
        utm_tags:
          type:
            - array
            - 'null'
          items:
            type: string
        bento_hash:
          type:
            - string
            - 'null'
        intercom_hash:
          type:
            - string
            - 'null'
        auto_topup_setting:
          anyOf:
            - $ref: '#/components/schemas/AutoTopupSetting.jsonld-read'
            - type: 'null'
        is_subscription_expired:
          readOnly: true
          default: true
          example: true
          type: boolean
      required:
        - email
    User-read:
      type: object
      description: ''
      deprecated: false
      properties:
        apps:
          type: array
          items:
            $ref: '#/components/schemas/App-read'
        email:
          format: email
          externalDocs:
            url: https://schema.org/email
          type: string
        enabled:
          type: boolean
        api_key:
          type:
            - string
            - 'null'
        id:
          readOnly: true
          type: string
        past_subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/Subscription-read'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment-read'
        roles:
          type: array
          items:
            type: string
        subscription:
          anyOf:
            - $ref: '#/components/schemas/Subscription-read'
            - type: 'null'
        try_at:
          type:
            - string
            - 'null'
          format: date-time
        utm_tags:
          type:
            - array
            - 'null'
          items:
            type: string
        bento_hash:
          type:
            - string
            - 'null'
        intercom_hash:
          type:
            - string
            - 'null'
        auto_topup_setting:
          anyOf:
            - $ref: '#/components/schemas/AutoTopupSetting-read'
            - type: 'null'
        is_subscription_expired:
          readOnly: true
          default: true
          example: true
          type: boolean
      required:
        - email
    App.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        api_token:
          type: string
        app_name:
          type: string
        app_dev_name:
          type:
            - string
            - 'null'
        enabled:
          type: boolean
        id:
          readOnly: true
          type: string
        max_dau:
          type: integer
        sdk_key:
          type: string
      required:
        - app_name
    Subscription.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        cancelled_at:
          type:
            - string
            - 'null'
          format: date-time
        gateway:
          default: paddle
          example: paddle
          type: string
        paused_at:
          type:
            - string
            - 'null'
          format: date-time
        plan:
          $ref: '#/components/schemas/SubscriptionPlan.jsonld-read'
        status:
          type: string
        subscription_id:
          type: string
        topups:
          type: array
          items:
            $ref: '#/components/schemas/Topup.jsonld-read'
        update_url:
          type:
            - string
            - 'null'
        valid_from:
          type: string
          format: date-time
        valid_until:
          type: string
          format: date-time
        current_quota:
          readOnly: true
          type: integer
        current_proxy_account_quota:
          readOnly: true
          type: integer
        current_quota_str:
          readOnly: true
          type: string
        bytes_recv:
          type: integer
        bytes_sent:
          type: integer
        consumption:
          readOnly: true
          type: integer
        consumption_str:
          readOnly: true
          type: string
    Payment.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        payment_id:
          type:
            - string
            - 'null'
        subscription_id:
          type: string
        gateway:
          type: string
        price:
          type: number
        product_name:
          type: string
        quantity:
          type: integer
        receipt_url:
          type:
            - string
            - 'null'
        status:
          type: string
    AutoTopupSetting.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        enabled:
          type: boolean
        threshold:
          minimum: 1
          default: 1
          example: 1
          type: integer
        extra_gb:
          minimum: 1
          default: 2
          example: 2
          type: integer
    App-read:
      type: object
      description: ''
      deprecated: false
      properties:
        api_token:
          type: string
        app_name:
          type: string
        app_dev_name:
          type:
            - string
            - 'null'
        enabled:
          type: boolean
        id:
          readOnly: true
          type: string
        max_dau:
          type: integer
        sdk_key:
          type: string
      required:
        - app_name
    Subscription-read:
      type: object
      description: ''
      deprecated: false
      properties:
        cancelled_at:
          type:
            - string
            - 'null'
          format: date-time
        gateway:
          default: paddle
          example: paddle
          type: string
        paused_at:
          type:
            - string
            - 'null'
          format: date-time
        plan:
          $ref: '#/components/schemas/SubscriptionPlan-read'
        status:
          type: string
        subscription_id:
          type: string
        topups:
          type: array
          items:
            $ref: '#/components/schemas/Topup-read'
        update_url:
          type:
            - string
            - 'null'
        valid_from:
          type: string
          format: date-time
        valid_until:
          type: string
          format: date-time
        current_quota:
          readOnly: true
          type: integer
        current_proxy_account_quota:
          readOnly: true
          type: integer
        current_quota_str:
          readOnly: true
          type: string
        bytes_recv:
          type: integer
        bytes_sent:
          type: integer
        consumption:
          readOnly: true
          type: integer
        consumption_str:
          readOnly: true
          type: string
    Payment-read:
      type: object
      description: ''
      deprecated: false
      properties:
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        payment_id:
          type:
            - string
            - 'null'
        subscription_id:
          type: string
        gateway:
          type: string
        price:
          type: number
        product_name:
          type: string
        quantity:
          type: integer
        receipt_url:
          type:
            - string
            - 'null'
        status:
          type: string
    AutoTopupSetting-read:
      type: object
      description: ''
      deprecated: false
      properties:
        enabled:
          type: boolean
        threshold:
          minimum: 1
          default: 1
          example: 1
          type: integer
        extra_gb:
          minimum: 1
          default: 2
          example: 2
          type: integer
    SubscriptionPlan.jsonld-read:
      type: object
      description: ''
      deprecated: false
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        description:
          type: string
        name:
          type: string
        price:
          type: integer
        price_per_extra_gb:
          type: integer
        price_per_extra_proxy_account:
          type: integer
        proxy_account_quota:
          type: integer
        quota:
          type: integer
        trial:
          type: boolean
        paddle_product_id:
          type: integer
      required:
        - name
    Topup.jsonld-read:
      type: object
      description: ''
      deprecated: false
      required:
        - kind
      properties:
        '@context':
          readOnly: true
          oneOf:
            - type: string
            - type: object
              properties:
                '@vocab':
                  type: string
                hydra:
                  type: string
                  enum:
                    - http://www.w3.org/ns/hydra/core#
              required:
                - '@vocab'
                - hydra
              additionalProperties: true
        '@id':
          readOnly: true
          type: string
        '@type':
          readOnly: true
          type: string
        kind:
          type: string
        quantity:
          type: integer
        description:
          type: string
        payment_kind:
          default: purchase
          example: purchase
          type: string
    SubscriptionPlan-read:
      type: object
      description: ''
      deprecated: false
      properties:
        description:
          type: string
        name:
          type: string
        price:
          type: integer
        price_per_extra_gb:
          type: integer
        price_per_extra_proxy_account:
          type: integer
        proxy_account_quota:
          type: integer
        quota:
          type: integer
        trial:
          type: boolean
        paddle_product_id:
          type: integer
      required:
        - name
    Topup-read:
      type: object
      description: ''
      deprecated: false
      required:
        - kind
      properties:
        kind:
          type: string
        quantity:
          type: integer
        description:
          type: string
        payment_kind:
          default: purchase
          example: purchase
          type: string
  securitySchemes:
    apiHeader:
      type: apiKey
      description: Value for the api-key header parameter.
      name: api-key
      in: header

````