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

# API usage meters

> Returns the workspace's cycle usage as used/limit meter pairs for unlocks, searches (structured + AI combined), and candidate messages. `cycleEndsOn` is when usage resets; `planExpiresOn` is when the subscription ends (non-free plans). Check before spending unlocks or messages. No special scope — any valid API key.



## OpenAPI

````yaml /openapi/public-api-v1.json get /usage
openapi: 3.1.0
info:
  title: Cutshort Public API v1
  version: 1.0.0
  description: >-
    Programmatic access to Cutshort's tech talent database. All endpoints
    require `Authorization: Bearer cs_live_<key>`.


    **Core flow:** search candidates → get candidate details (auto-unlock) →
    post a job → invite to apply (first contact) → list applications → send
    message (in-thread follow-up).
servers:
  - url: https://cutshort.io/api/v1
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Search
    description: Talent database search
  - name: Candidates
    description: Candidate detail with auto-unlock (contact info + resume)
  - name: Jobs
    description: Job posting and listing
  - name: Outreach
    description: >-
      Candidate outreach: first-contact invite to apply, and in-thread follow-up
      messages
  - name: Usage
    description: Cycle usage meters and quotas
  - name: Stages
    description: Job pipeline stages and counts
  - name: Applications
    description: List applications and move them between pipeline stages
paths:
  /usage:
    get:
      tags:
        - Usage
      summary: API usage meters
      description: >-
        Returns the workspace's cycle usage as used/limit meter pairs for
        unlocks, searches (structured + AI combined), and candidate messages.
        `cycleEndsOn` is when usage resets; `planExpiresOn` is when the
        subscription ends (non-free plans). Check before spending unlocks or
        messages. No special scope — any valid API key.
      operationId: getUsage
      responses:
        '200':
          description: Usage snapshot
          content:
            application/json:
              schema:
                type: object
                properties:
                  workspaceId:
                    type: string
                  apiUnlocks:
                    $ref: '#/components/schemas/UsageMeter'
                  searches:
                    $ref: '#/components/schemas/UsageMeter'
                  messages:
                    $ref: '#/components/schemas/UsageMeter'
                  cycleEndsOn:
                    type: string
                    nullable: true
                    description: When usage meters reset
                  planExpiresOn:
                    type: string
                    nullable: true
                    description: Subscription expiry (non-free plans)
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    UsageMeter:
      type: object
      properties:
        used:
          type: integer
          description: Consumed in the current cycle
        limit:
          type: integer
          description: Cycle limit (workspace default or grant)
    ApiError:
      type: object
      properties:
        error_code:
          type: string
        error_description:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: >-
        Workspace-scoped API key. Prefix: `cs_live_`. Eval keys (self-serve from
        Cutshort → Settings → Integrations → API Key) can search and get
        candidate details within small quotas; production keys add job posting
        and candidate messaging with higher limits.

````