Bulk URL Checker Users API

openapi: 3.2.0
info:
  title: Reception Desk Users API
  description: API Gateway for URL Checker Engine
  version: 1.0.0
tags:
- name: Users
paths:
  /users/me:
    get:
      summary: Get Current User Profile
      description: 'Get current user''s billing profile and usage stats.


        Proxied to Billing Service. Forwards X-Real-Client-IP so the

        billing-service lazy signup-credit grant has a trusted IP for the

        24h abuse throttle (Caddy populates X-Forwarded-For at our edge,

        which we read here and re-emit as a dedicated header).'
      operationId: get_current_user_profile_users_me_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Users
  /users/me/quota:
    get:
      summary: Get Current User Quota
      description: 'Get current user''s quota information (usage, limits, trial info).


        Proxied to Billing Service. Forwards X-Real-Client-IP so the

        lazy signup-credit grant in billing-service has the IP needed to

        run the abuse throttle.'
      operationId: get_current_user_quota_users_me_quota_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Users
  /users/me/fingerprint:
    post:
      summary: Post Current User Fingerprint
      description: 'Persist the current user''s device fingerprint AND, on first call,

        trigger the deferred signup-bonus grant in billing-service.


        The IP we forward here is the abuse-defense source of truth — Caddy

        populates X-Forwarded-For with {remote_host} (the real client

        socket), so we read that rather than the Clerk-webhook IP, which

        can be a different value.


        Frontend posts {os, device_type, screen_size, attribution}; any

        field can be null if detection failed in that browser.


        NOTE (2026-08-31): `attribution` was previously dropped here. The

        frontend sent it and billing-service was ready to persist it, but

        this handler rebuilt the payload field-by-field and simply omitted

        it, so 1,057 users accumulated zero first-touch attribution. Keep

        it in the forwarded dict.'
      operationId: post_current_user_fingerprint_users_me_fingerprint_post
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              title: Request
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Users
  /users/me/credits:
    get:
      summary: Get Current User Credits
      description: 'Get current user''s credit balance and info.


        `credit_balance` is the single available-credit number under the

        unified ledger. `available_credits` is kept as an alias for backward

        compatibility with frontend code that reads it (paywalls, auto-

        resume); both fields hold the same value.


        Forwards X-Real-Client-IP so the lazy signup-credit grant in

        billing-service has the IP needed to run the abuse throttle.'
      operationId: get_current_user_credits_users_me_credits_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Users
  /users/me/period-usage:
    get:
      summary: Get Period Usage
      description: Per-period subscription usage stats (proxied to billing-service).
      operationId: get_period_usage_users_me_period_usage_get
      parameters:
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Users
  /users/me/credit-transactions:
    get:
      summary: Get Credit Transactions
      description: Get credit transaction history for current user.
      operationId: get_credit_transactions_users_me_credit_transactions_get
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          default: 20
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          default: 0
          title: Offset
      - name: authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Users
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError