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

# Show the current user

> Returns the profile of the token's user: name, locale, display currency, effective plan, and active space. Requires the `pfm:read` scope. It never returns the CPF, the phone, or a token.



## OpenAPI

````yaml /openapi.json get /v1/me
openapi: 3.0.3
info:
  description: >-
    Personal REST API for Visor Pro and Premium users. Authenticate with a
    personal API token created in Visor Settings, sent as `Authorization: Bearer
    visor_pat_...`, or with an OAuth access token from the Visor CLI browser
    login.
  title: Visor Personal API
  version: 1.0.0
servers:
  - url: https://api.visorfinance.app
    variables: {}
security:
  - personal_api_token: []
  - visor_cli_oauth:
      - pfm:read
tags: []
paths:
  /v1/me:
    get:
      tags:
        - User
      summary: Show the current user
      description: >-
        Returns the profile of the token's user: name, locale, display currency,
        effective plan, and active space. Requires the `pfm:read` scope. It
        never returns the CPF, the phone, or a token.
      operationId: VisorWeb.Api.V1.MeController.show
      parameters: []
      responses:
        '200':
          content:
            application/json:
              example:
                data:
                  active_space_id: 6f1c2a9e-1d7b-4c55-9a3e-2b8f0c4d5e61
                  created_at: '2026-03-14T12:30:00Z'
                  display_currency_code: BRL
                  email: maria@example.com
                  id: a4d1b6c2-7e30-4f9a-8c15-3b2e6f0d9a47
                  locale: pt-BR
                  name: Maria Souza
                  plan: premium
              schema:
                $ref: '#/components/schemas/MeResponse'
          description: The current user
          headers:
            x-ratelimit-limit:
              description: Requests allowed for this token per minute
              schema:
                example: 60
                type: integer
              style: simple
            x-ratelimit-remaining:
              description: Requests left for this token in the current minute
              schema:
                example: 59
                type: integer
              style: simple
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '401':
          content:
            application/json:
              example:
                errors:
                  - code: INVALID_TOKEN
                    details: {}
                    message: The personal API token is not valid.
                    request_id: F8x2kQ9vXc1AAAAB
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Missing, invalid, expired, or revoked token
          headers:
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '403':
          content:
            application/json:
              example:
                errors:
                  - code: INSUFFICIENT_SCOPE
                    details:
                      required_scope: pfm:read
                    message: The personal API token does not grant this operation.
                    request_id: F8x2kQ9vXc1AAAAB
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Pro or Premium plan required, or insufficient scope
          headers:
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '406':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: The client does not accept JSON
          headers:
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
        '429':
          content:
            application/json:
              example:
                errors:
                  - code: RATE_LIMITED
                    details:
                      retry_after_seconds: 42
                    message: >-
                      Too many requests. Retry after the number of seconds in
                      Retry-After.
                    request_id: F8x2kQ9vXc1AAAAB
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Rate limit exceeded
          headers:
            retry-after:
              description: Seconds until the current window ends
              schema:
                example: 42
                type: integer
              style: simple
            x-ratelimit-limit:
              description: Requests allowed for this token per minute
              schema:
                example: 60
                type: integer
              style: simple
            x-ratelimit-remaining:
              description: Requests left for this token in the current minute
              schema:
                example: 59
                type: integer
              style: simple
            x-request-id:
              description: Request identifier, also returned as `request_id` in errors
              schema:
                type: string
              style: simple
      callbacks: {}
components:
  schemas:
    MeResponse:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/Me'
      required:
        - data
      title: MeResponse
      type: object
    ErrorResponse:
      additionalProperties: false
      properties:
        errors:
          items:
            $ref: '#/components/schemas/Error'
          minItems: 1
          type: array
      required:
        - errors
      title: ErrorResponse
      type: object
    Me:
      additionalProperties: false
      properties:
        active_space_id:
          description: >-
            The space the user has active in the app; null when the user has no
            space yet
          format: uuid
          nullable: true
          type: string
        created_at:
          format: date-time
          type: string
        display_currency_code:
          description: The ISO 4217 currency in which the app shows totals
          example: BRL
          type: string
        email:
          format: email
          type: string
        id:
          format: uuid
          type: string
        locale:
          description: The interface language
          enum:
            - pt-BR
            - en
          type: string
        name:
          description: The full name, or the email when the user has no name
          type: string
        plan:
          description: >-
            The effective plan: the highest of the own, sponsored, and granted
            plans
          enum:
            - free
            - basic
            - pro
            - premium
          type: string
      required:
        - id
        - name
        - email
        - locale
        - display_currency_code
        - plan
        - active_space_id
        - created_at
      title: Me
      type: object
    Error:
      additionalProperties: false
      properties:
        code:
          description: Stable machine-readable code
          example: INVALID_TOKEN
          type: string
        details:
          additionalProperties: true
          description: Code-specific context
          type: object
        message:
          description: English text for developers
          type: string
        request_id:
          description: The x-request-id response header of the request
          nullable: true
          type: string
      required:
        - code
        - message
        - details
        - request_id
      title: Error
      type: object
  securitySchemes:
    personal_api_token:
      bearerFormat: visor_pat_<public_id>_<secret>
      description: Personal API token created in Visor Settings
      scheme: bearer
      type: http
    visor_cli_oauth:
      description: >-
        OAuth 2.0 access token of the Visor CLI browser login (authorization
        code with PKCE). Only the first-party Visor CLI client can use it on
        this API.
      flows:
        authorizationCode:
          authorizationUrl: https://dashboard.visorfinance.app/oauth/authorize
          refreshUrl: https://dashboard.visorfinance.app/oauth/token
          scopes:
            pfm:read: Read financial data
            pfm:transactions:write: Create, edit, and delete transactions
            pix:payments:write: Start Pix payments that you confirm with biometrics at your bank
          tokenUrl: https://dashboard.visorfinance.app/oauth/token
      type: oauth2

````

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