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

# Get Team Usage

> Returns the current team's credit summary plus a per-project breakdown of scheduled credit usage. The breakdown lists projects that currently reserve credits or have consumed one-off credits this calendar month.



## OpenAPI

````yaml /openapi.json get /api/v1/team/usage
openapi: 3.1.0
info:
  title: Surfacd Public API
  version: 1.0.0
  description: >-
    Public API for Surfacd. Team-scoped operations live under
    `/api/v1/team/...`; project collections live under `/api/v1/projects`;
    project-scoped operations live under `/api/v1/projects/{project}/...`. All
    endpoints require a Bearer team API key created in Team Settings. The API
    key selects the team for team-level and collection endpoints.
servers:
  - url: https://app.surfacd.com
    description: Production
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Project management endpoints. Reads only in this version.
  - name: Prompts
    description: Prompt management endpoints. Reads only in this version.
  - name: Team
    description: Team settings and plan details for the current team.
  - name: Reporting
    description: >-
      Read-only reporting endpoints for projects (brand rankings, mentions,
      visibility, matrix analysis, source data).
  - name: Reference
    description: Reference data used by create, update, and reporting filters.
  - name: Tags
    description: Project tag management endpoints.
paths:
  /api/v1/team/usage:
    get:
      tags:
        - Team
      summary: Get Team Usage
      description: >-
        Returns the current team's credit summary plus a per-project breakdown
        of scheduled credit usage. The breakdown lists projects that currently
        reserve credits or have consumed one-off credits this calendar month.
      operationId: v1TeamUsage
      responses:
        '200':
          description: Team usage.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TeamUsage'
components:
  schemas:
    TeamUsage:
      type: object
      properties:
        credits:
          $ref: '#/components/schemas/UsageCredits'
        projects:
          type: array
          items:
            $ref: '#/components/schemas/UsageProject'
      required:
        - credits
        - projects
    UsageCredits:
      type: object
      properties:
        monthly_allowance:
          type:
            - integer
            - 'null'
          description: Monthly credit allowance, or null for unlimited teams.
        reserved:
          type: integer
          description: Credits currently reserved by active scheduled projects.
        one_off_used:
          type: integer
          description: One-off credits consumed so far this calendar month.
        available:
          type:
            - integer
            - 'null'
          description: Remaining credits this month, or null for unlimited teams.
      required:
        - monthly_allowance
        - reserved
        - one_off_used
        - available
    UsageProject:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
        name:
          type: string
        schedule:
          $ref: '#/components/schemas/CheckFrequency'
        active_prompts:
          type: integer
        prompt_limit:
          type: integer
        service_count:
          type: integer
        credits_per_run:
          type: integer
          description: >-
            Credit cost of a single run at the current prompt/service
            configuration.
        credits_reserved:
          type: integer
        credits_used_this_month:
          type: integer
        credit_multiplier:
          type: integer
          description: >-
            Runs per month implied by the schedule (daily=30, weekly=5,
            monthly=1, manual=0).
        archived:
          type: boolean
          description: >-
            True if the project is archived or deleted but still incurred usage
            this month.
      required:
        - uuid
        - name
        - schedule
        - active_prompts
        - prompt_limit
        - service_count
        - credits_per_run
        - credits_reserved
        - credits_used_this_month
        - credit_multiplier
        - archived
    CheckFrequency:
      type: string
      enum:
        - manual
        - monthly
        - weekly
        - daily
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: token
      description: >-
        Team API key created in Team Settings. Use it with URLs for the same
        team.

````