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

# Get Team Usage

> Retrieves usage statistics for the current billing period including rows processed, credits used, and credits remaining.



## OpenAPI

````yaml /openapi-v0.1.json get /v0.1/team/usage
openapi: 3.0.0
info:
  title: PromptLoop API
  version: 0.1.0
  description: >-
    Run PromptLoop research tasks, manage asynchronous batches, and create
    company-list exports.
  contact:
    name: PromptLoop Support
    email: help@promptloop.com
    url: https://promptloop.com
servers:
  - url: https://api.promptloop.com
    description: Production
security: []
tags:
  - name: Tasks
    description: Create, inspect, test, and run research tasks.
  - name: Batches
    description: Run and manage asynchronous JSONL workloads.
  - name: Company Lists
    description: Search for companies and create downloadable dataset exports.
  - name: Team
    description: Inspect team usage and plan limits.
paths:
  /v0.1/team/usage:
    get:
      tags:
        - Team
      summary: Get Team Usage
      description: >-
        Retrieves usage statistics for the current billing period including rows
        processed, credits used, and credits remaining.
      operationId: getUsage
      parameters: []
      responses:
        '200':
          description: Successfully retrieved usage data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponseDto'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
      security:
        - x-api-key: []
components:
  schemas:
    UsageResponseDto:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - error
          example: success
        data:
          $ref: '#/components/schemas/UsageDataDto'
        message:
          type: string
        error:
          allOf:
            - $ref: '#/components/schemas/ErrorDetailsDto'
          nullable: true
        request_id:
          type: string
          description: Correlation identifier for support and request tracing.
      required:
        - status
        - data
        - message
    ErrorResponseDto:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
            - error
          example: error
        data:
          type: object
          nullable: true
        message:
          type: string
        error:
          allOf:
            - $ref: '#/components/schemas/ErrorDetailsDto'
          nullable: true
        request_id:
          type: string
          description: Correlation identifier for support and request tracing.
      required:
        - status
        - data
        - message
    UsageDataDto:
      type: object
      properties:
        rows_processed:
          type: number
          description: Number of rows processed in the current billing period
          example: 150
        credits_used:
          type: number
          description: Total credits used in the current billing period
          example: 150
        credits_remaining:
          type: number
          description: Credits remaining in the current billing period
          example: 100
        bonus_credits_remaining:
          type: number
          description: Additional bonus credits available
          example: 50
        total_usage:
          type: number
          description: Total all-time usage across all periods
          example: 1500
        period:
          type: string
          description: Current billing period (e.g., "2024-02")
          example: 2024-02
      required:
        - rows_processed
        - credits_used
        - credits_remaining
        - bonus_credits_remaining
        - total_usage
        - period
    ErrorDetailsDto:
      type: object
      properties:
        code:
          type: number
        details:
          type: string
      required:
        - code
        - details
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````