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

# Get the account

> Returns the authenticated user and the available credit balance. Requires the `user:read` ability.



## OpenAPI

````yaml /en/openapi.yaml get /api/user
openapi: 3.1.0
info:
  title: Paperjoy API
  version: '2026-10-19'
  description: >-
    Create, preview, and track real handwritten postcards. The API key decides
    whether a request runs in test or live mode.
  termsOfService: https://paperjoy.co/regulamin
  license:
    name: Proprietary
    url: https://paperjoy.co/regulamin
servers:
  - url: https://paperjoy.co
security:
  - bearerAuth: []
tags:
  - name: Account
    description: The authenticated account and its credit balance.
  - name: Postcards
    description: Create, preview, list, and retrieve postcards.
  - name: Signatures
    description: Custom handwritten signatures available to your organization.
paths:
  /api/user:
    get:
      tags:
        - Account
      summary: Get the account
      description: >-
        Returns the authenticated user and the available credit balance.
        Requires the `user:read` ability.
      operationId: getUser
      responses:
        '200':
          description: The authenticated user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserResponse'
              example:
                data:
                  id: user_abc123
                  name: Marta Nowak
                  email: marta@example.com
                  available_credit_balance: 48
                  email_verified_at: '2026-10-01T10:00:00+00:00'
                  created_at: '2026-10-01T09:58:00+00:00'
                  updated_at: '2026-10-01T10:00:00+00:00'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    UserResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/User'
    User:
      type: object
      required:
        - id
        - name
        - email
        - available_credit_balance
        - email_verified_at
        - created_at
        - updated_at
      properties:
        id:
          type: string
          examples:
            - user_abc123
        name:
          type: string
          examples:
            - Marta Nowak
        email:
          type: string
          format: email
          examples:
            - marta@example.com
        available_credit_balance:
          type: number
          description: Credits available for live postcards. Test mode never changes it.
          examples:
            - 48
        email_verified_at:
          type:
            - string
            - 'null'
          format: date-time
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        updated_at:
          type:
            - string
            - 'null'
          format: date-time
    Error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthorized:
      description: The API key is missing, invalid, revoked, or expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Unauthenticated.
    Forbidden:
      description: >-
        The API key lacks the required ability, or the resource belongs to
        someone else.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: This action is unauthorized.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Paperjoy API key. Keys starting with `pj_test_` use test mode; keys
        starting with `pj_live_` use live mode.

````

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