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

# Get Current User

> Returns information about the authenticated team, subscription, and API key.
This is typically the first endpoint to call to verify your API key is working.




## OpenAPI

````yaml GET /v1/users/me
openapi: 3.1.0
info:
  title: North Reports API
  description: >
    The North Reports API allows you to programmatically access and manage your
    North reports.


    Use this API to:

    - Create and update property reports

    - Manage comparable properties

    - Track showings and open houses

    - Import social media engagement data

    - Generate AI-powered summaries


    Perfect for integrations with Zapier, n8n, Make.com, or custom applications.
  version: 1.0.1
  contact:
    name: North Support
    url: https://northreports.com/support
  termsOfService: https://northreports.com/terms
servers:
  - url: https://api.northreports.com
    description: Production API
security:
  - BearerAuth: []
tags:
  - name: Users
    description: User and team information
  - name: Reports
    description: Create and manage North reports
  - name: Comparables
    description: Manage comparable properties
  - name: Showings
    description: Track showings and open houses
  - name: Social Media
    description: Import and track social media engagement
  - name: Webhooks
    description: Subscribe to real-time events
paths:
  /v1/users/me:
    get:
      tags:
        - Users
      summary: Get current user
      description: >
        Returns information about the authenticated team, subscription, and API
        key.

        This is typically the first endpoint to call to verify your API key is
        working.
      operationId: getCurrentUser
      responses:
        '200':
          description: Successfully retrieved user information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
              example:
                data:
                  team:
                    id: 550e8400-e29b-41d4-a716-446655440000
                    name: Acme Realty
                    created_at: '2024-01-15T10:30:00Z'
                    member_count: 3
                    reports_count: 25
                  subscription:
                    plan: professional
                    status: active
                    api_usage:
                      calls_this_month: 150
                      resets_at: '2024-02-01T00:00:00Z'
                  api_key:
                    name: Production Key
                    prefix: north_sk_live_abc12345
                    permissions:
                      reports:
                        - read
                        - create
                        - update
                      comps:
                        - read
                    rate_limit_tier: standard
                    last_used_at: '2024-01-20T15:45:00Z'
                    created_at: '2024-01-15T12:00:00Z'
                  rate_limit:
                    tier: standard
                    remaining: 985
                    resets_at: '2024-01-20T17:00:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
components:
  schemas:
    UserResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            team:
              type: object
              properties:
                id:
                  type: string
                  format: uuid
                name:
                  type: string
                created_at:
                  type: string
                  format: date-time
                member_count:
                  type: integer
                reports_count:
                  type: integer
            subscription:
              type: object
              properties:
                plan:
                  type: string
                status:
                  type: string
                api_usage:
                  type: object
                  properties:
                    calls_this_month:
                      type: integer
                    resets_at:
                      type: string
                      format: date-time
            api_key:
              type: object
              properties:
                name:
                  type: string
                prefix:
                  type: string
                permissions:
                  type: object
                rate_limit_tier:
                  type: string
                last_used_at:
                  type: string
                  format: date-time
                created_at:
                  type: string
                  format: date-time
            rate_limit:
              type: object
              properties:
                tier:
                  type: string
                remaining:
                  type: integer
                resets_at:
                  type: string
                  format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            status:
              type: integer
  responses:
    Unauthorized:
      description: Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              message: Invalid API key
              status: 401
    RateLimitExceeded:
      description: Too many requests
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Request limit per hour
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Remaining requests in current window
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix timestamp when the rate limit resets
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              message: Rate limit exceeded. Please try again later.
              status: 429
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >
        API key authentication. Include your API key in the Authorization
        header:

        ```

        Authorization: Bearer north_sk_live_xxxxxxxxxxxx

        ```

````