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

# Get Workspace Capacity

> Returns how much of each workspace Capacity pool is occupied, how much may be occupied and how much is left, together with the plan state those numbers were resolved under. Capacity is a property of the workspace, not of the caller: every member reads the same values. This is the authoritative source of occupancy and remainder — no consumer computes them from its own data. The composition of the limit and any monetary figure are not part of this contract.



## OpenAPI

````yaml https://api.goextrovert.com/client/v2/docs-json get /client/v2/workspace/get-capacity
openapi: 3.1.0
info:
  title: Extrovert Client API
  description: >-
    Public API for Extrovert platform integration. Use your API key for
    authentication.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.goextrovert.com/
    description: API Server
security: []
tags: []
paths:
  /client/v2/workspace/get-capacity:
    get:
      tags:
        - Workspace
      summary: Get Workspace Capacity
      description: >-
        Returns how much of each workspace Capacity pool is occupied, how much
        may be occupied and how much is left, together with the plan state those
        numbers were resolved under. Capacity is a property of the workspace,
        not of the caller: every member reads the same values. This is the
        authoritative source of occupancy and remainder — no consumer computes
        them from its own data. The composition of the limit and any monetary
        figure are not part of this contract.
      operationId: WorkspaceClientApiController_getCapacity
      parameters:
        - description: >-
            Campaign the call is being planned for. Optional. While `planState`
            is `TRIAL` the limits are stated per campaign owner, so naming the
            campaign measures the pools for that campaign's owner — the same
            scope the operation itself will be admitted in. Omit it to measure
            your own scope; an API key, which names no user, then reads the
            workspace's busiest owner. The campaign must belong to your
            workspace.
          examples:
            example1:
              value: 8d256aa6-9b12-49a7-93ee-bf41634b5b60
          required: false
          name: campaignId
          in: query
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCapacityResponseDto'
        '401':
          description: Invalid or missing API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientApiErrorResponseDto'
      security:
        - api-key: []
components:
  schemas:
    GetCapacityResponseDto:
      type: object
      properties:
        status:
          type: string
          const: success
          description: Response status
        data:
          type: object
          properties:
            planState:
              type: string
              enum:
                - TRIAL
                - FREE
                - FULL
                - INACTIVE
              description: >-
                Plan state the pools were resolved under. `TRIAL` states its
                limits per campaign owner; `FREE` and `FULL` state them for the
                whole workspace; `INACTIVE` means an expired or missing plan,
                which admits nothing while reads and clean-up keep working.
            pools:
              type: array
              items:
                type: object
                properties:
                  pool:
                    type: string
                    enum:
                      - PROSPECT
                      - TOPIC
                    description: >-
                      Which pool this entry reports. `PROSPECT` counts visible
                      direct prospects; `TOPIC` counts topics attached to a
                      visible topic campaign. The pools are independent — an
                      operation must fit its own.
                  used:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Units of this pool the workspace occupies right now.
                      Identical for every member of the workspace.
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: >-
                      Units this workspace may occupy. It is the cap new
                      positive actions are admitted against, so a planned
                      reduction lowers it while everything already stored is
                      kept.
                  available:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                    description: Units still free — `total - used`, never below zero.
                  isOverLimit:
                    type: boolean
                    description: >-
                      `true` when `used` already exceeds `total`. Nothing is
                      removed, hidden or trimmed because of it; only further
                      positive actions on this pool are refused until room is
                      freed.
                required:
                  - pool
                  - used
                  - total
                  - available
                  - isOverLimit
              description: Both Capacity pools of the workspace.
          description: >-
            Capacity pools of the workspace and the plan state they were
            resolved under.
          required:
            - planState
            - pools
        message:
          type: string
          description: Success message
          examples:
            - Operation completed successfully
      required:
        - status
        - data
        - message
    ClientApiErrorResponseDto:
      type: object
      properties:
        status:
          type: string
          description: Response status
          example: error
          enum:
            - error
        data:
          type: object
          description: Response data
          example: null
          nullable: true
        message:
          type: string
          description: Error message
          example: An error occurred while processing the request
      required:
        - status
        - data
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key for authentication

````

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