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

# Get the current user

> Retrieves the current user's information.



## OpenAPI

````yaml /openapi/adm.openapi.en-0.2.2.json get /users/me
openapi: 3.1.0
info:
  description: >
    ## Introduction

    The Data Management APIs comprehensively oversees the **diverse data** used
    by advertising and recommendation systems, ensuring that the Decision API
    runs accurately and efficiently.


    From registering, updating, and deleting campaigns and placements to **log
    and statistics analysis**, it provides the insights necessary for effective
    system operation.


    The resulting data and metrics are used by the Decision API to **optimize ad
    and content decisions**, ultimately boosting the overall performance of the
    advertising and recommendation system.
  title: Data Management APIs
  version: 0.1.3
servers: []
security: []
tags:
  - name: Audience Targeting
  - description: >

      The Audience Management APIs to seamlessly integrate Audience-related
      data.  


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Audience
  - description: >
      APIs for collecting user activity data to enhance ad targeting and
      performance optimization.


      Activity Data captures actual user behavior data like product views,
      searches, cart additions, and purchases across all users, regardless of ad
      interactions.


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Activity Log
  - description: >

      The Audience Attribute API provides access to audience attribute data.


      References:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Attribute
  - description: >

      The Audience Segment API provides access to audience segment data.


      References:

      - [Audience
      Targeting](https://docs.aiderx.io/guides/about-a2/en/audience-targeting)
    name: Audience Segment
  - description: The Analytic API provides access to dashboard and A2 metric data.
    name: Analytic
  - description: >

      The Billing API manages billing information.

      A2 is configured to work with the payment systems used by your retail
      platform.


      To integrate payments, first you need to register an external channel.

      For more information about integrating A2 with external channels, check
      out [the External channels
      page](https://docs.aiderx.io/guides/about-a2/en/external-channel).
    name: Billing
  - description: |

      The Campaign API allows you to manage data related to campaigns.

      References:
      - [Campaign](https://docs.aiderx.io/guides/about-a2/en/campaign)
    name: Campaign
  - description: >

      The Creative API provides comprehensive functionalities for managing
      creative assets and related resources.


      References:

      - [Creative](https://docs.aiderx.io/guides/about-a2/en/creative)
    name: Creative
  - description: >

      The Allocation API provides comprehensive functionalities for managing
      allocation and related resources.


      References:

      - [Allocation](https://docs.aiderx.io/guides/about-a2/en/allocation)
    name: Allocation
  - description: >

      The Media Library API provides comprehensive functionalities for managing
      media library and related resources.


      References:

      - [Media Library](https://docs.aiderx.io/guides/about-a2/en/media-library)
    name: Media Library
  - description: >

      The Catalog Management API provides functionalities for managing catalogs
      and related resources.


      References:

      - [First-Party
      Data](https://docs.aiderx.io/guides/about-a2/en/first-party-data)
    name: Catalog
  - description: >

      The Placement Management API provides comprehensive functionalities for
      managing placements and related resources.


      References:

      - [Placement](https://docs.aiderx.io/guides/about-a2/en/placement)
    name: Placement
  - description: >

      Placement Catalog transforms the placement information into a structured
      “advertising product” that can be easily showcased to advertisers.


      References:

      - To be updated
    name: Placement Catalog
  - description: >

      The System APIs allow you to access and manage system-level settings and
      assets, such as logos and configuration values.


      References:

      - [Yield Optimization
      Settings](https://docs.aiderx.io/guides/about-a2/en/yield-optimization)
    name: System
  - description: >

      The Auth and User API provides authentication and user management
      functionalities.


      References:

      - [Account and
      Budget](https://docs.aiderx.io/guides/about-a2/en/account-and-budget)
    name: Auth and User
  - description: |

      The License API provides license management functionalities.
    name: License
paths:
  /users/me:
    get:
      tags:
        - Auth and User
      summary: Get the current user
      description: Retrieves the current user's information.
      operationId: users_current_user_users_me_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserRead'
          description: Successful Response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPExceptionResponse'
          description: Bad Request
        '401':
          description: Missing token or inactive user.
      security:
        - OAuth2PasswordBearer: []
components:
  schemas:
    UserRead:
      description: Represents a read command for a user.
      properties:
        budget:
          description: The total budget currently available to the user.
          title: Budget
          type: number
        campaign_count:
          description: The number of campaigns owned by the user.
          minimum: 0
          title: Campaign Count
          type: integer
        creative_count:
          description: The number of creatives owned by the user.
          minimum: 0
          title: Creative Count
          type: integer
        credit:
          description: The total credit currently available to the user.
          title: Credit
          type: number
        email:
          description: The email of the user.
          format: email
          title: Email
          type: string
        id:
          description: The id of the user.
          format: uuid
          title: Id
          type: string
        is_active:
          description: Is the user active.
          title: Is Active
          type: boolean
        is_superuser:
          description: Is the user admin.
          title: Is Superuser
          type: boolean
        is_verified:
          description: Is the user email is verified.
          title: Is Verified
          type: boolean
        name:
          anyOf:
            - type: string
            - type: 'null'
          description: The name of the user.
          title: Name
        permissions:
          description: The permissions information of the user.
          examples:
            - {}
            - admin: []
              advertiser:
                - permission
              analytic:
                - campaign
              audience: []
              audience_attribute:
                - r
              audience_segment:
                - r
                - w
              campaign:
                - r
                - w
              creative:
                - r
                - w
              placement:
                - r
              retailer: []
            - admin:
                - list_advertisers
                - budget
              advertiser: []
              analytic:
                - placement
              audience:
                - r
              audience_attribute:
                - r
                - w
              audience_segment:
                - r
                - w
              campaign:
                - r
              creative:
                - r
                - w
              placement:
                - r
                - w
              retailer:
                - approval
                - permission
          title: Permissions
          type: object
        placement_count:
          description: The number of placements owned by the user.
          minimum: 0
          title: Placement Count
          type: integer
        preferences:
          anyOf:
            - $ref: '#/components/schemas/UserPreferences'
            - type: 'null'
        role:
          $ref: '#/components/schemas/UserRole'
      required:
        - id
        - email
        - is_active
        - is_superuser
        - is_verified
        - role
        - permissions
        - budget
        - credit
        - preferences
        - campaign_count
        - creative_count
        - placement_count
      title: UserRead
      type: object
    HTTPExceptionResponse:
      description: HTTPException response model.
      properties:
        detail:
          description: Detailed explanation for the exception
          title: Detail
          type: string
      required:
        - detail
      title: HTTPExceptionResponse
      type: object
    UserPreferences:
      description: Represents a user preferences.
      properties:
        etc:
          description: Extra user preferences.
          examples:
            - language: ko
          title: Etc
          type: object
        notification_methods:
          additionalProperties:
            type: boolean
          description: Accepted notification methods.
          examples:
            - email: true
              slack: false
              sms: false
          propertyNames:
            $ref: '#/components/schemas/NotificationMethod'
          title: Notification Methods
          type: object
        notification_methods_data:
          additionalProperties:
            type: string
          description: Data used for notification methods.
          examples:
            - slack: <SLACK_WEBHOOK_URL>
              sms: ''
          propertyNames:
            $ref: '#/components/schemas/NotificationMethod'
          title: Notification Methods Data
          type: object
        notifications:
          additionalProperties:
            type: boolean
          description: Accepted notification event types.
          examples:
            - attribute_deleted: true
              campaign_finished: true
              publish_approval: true
              publish_request: true
          propertyNames:
            $ref: '#/components/schemas/NotificationEvent'
          title: Notifications
          type: object
      required:
        - notification_methods
        - notification_methods_data
        - notifications
        - etc
      title: UserPreferences
      type: object
    UserRole:
      description: User role enum.
      enum:
        - advertiser
        - retailer
        - admin
      title: UserRole
      type: string
  securitySchemes:
    OAuth2PasswordBearer:
      flows:
        password:
          scopes: {}
          tokenUrl: auth/jwt/login
      type: oauth2

````