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

# List pools

> > ⚠️ This endpoint is in [public preview](/preview/roadmap).

List all pools.



## OpenAPI

````yaml /preview/openapi.json get /preview/v2/pools
openapi: 3.1.0
info:
  title: sfc-api
  description: >-
    Public preview API - subject to change. See
    https://docs.sfcompute.com/preview/roadmap for details.
  version: 0.1.0
servers:
  - url: https://api.sfcompute.com
security:
  - bearer_auth: []
tags:
  - name: Account
    description: The authenticated account and logged-in user.
  - name: Pools
    description: A bucket of owned compute balance over time.
  - name: Orders
    description: >-
      Place orders targeting a capacity to increase your reserved compute
      balance during some time period.
  - name: Instance Templates
    description: Reusable instance configuration.
  - name: Images
    description: Custom machine images for instances.
  - name: Roles
    description: TOML-based permission role definitions.
  - name: Grants
    description: Bind principals (users or tokens) to roles on a workspace.
  - name: Tokens
    description: Workspace-scoped API tokens.
  - name: Instances
    description: Spin up instances in a capacity to use your available compute.
  - name: Instance SKU Catalog
    description: Browse available instance SKU property definitions.
  - name: Procurements
    description: Market automations that maintain capacity by placing buy/sell orders.
  - name: Deployments
    description: Deployment automations that maintain a fleet of instances on a capacity.
  - name: Spot Deployments
    description: >-
      Spot deployment automations that buy capacity up to a maximum price and
      run instances on secured capacity.
  - name: Users
    description: Read-only access to users within the caller's organization.
  - name: Workspaces
    description: Resource containers scoped to an account.
  - name: Permissions
    description: Inspect what the caller is allowed to do.
  - name: Billing
    description: Billing profile, contacts, and auto top-up settings.
  - name: Orderbook
    description: >-
      Read-only orderbook visibility: bid/ask spread, depth of book, and
      historical fills, keyed on hardware requirements + delivery window.
  - name: Orders
    description: >-
      Estimate an order before placing it: filled price, fee, and operational
      notices.
paths:
  /preview/v2/pools:
    get:
      tags:
        - Pools
      summary: List pools
      description: |-
        > ⚠️ This endpoint is in [public preview](/preview/roadmap).

        List all pools.
      operationId: list_pools
      parameters:
        - name: workspace
          in: query
          description: Filter by workspace.
          required: true
          schema:
            $ref: '#/components/schemas/ResourcePathOrId_WorkspaceId'
        - name: id
          in: query
          description: Filter by pool ID, resource path, or name (repeatable).
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ResourcePathOrId_PoolId'
          style: form
          explode: true
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            format: u-int32
            default: 50
            maximum: 200
            minimum: 1
        - name: starting_after
          in: query
          description: Set to the response's `cursor` to fetch the next page.
          required: false
          schema:
            $ref: '#/components/schemas/PoolsCursor'
        - name: ending_before
          in: query
          description: Set to the response's `cursor` to fetch the previous page.
          required: false
          schema:
            $ref: '#/components/schemas/PoolsCursor'
        - name: schedule_history_minutes
          in: query
          description: How many minutes of past schedule to include.
          required: false
          schema:
            type: integer
            format: u-int64
            default: 0
            maximum: 1440
            minimum: 0
        - name: tag
          in: query
          description: >-
            Filter by tag key-value pair (repeatable). Format: `key=value` (the
            `=` between key and value must be percent-encoded in the URL).
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
        - name: tag_key
          in: query
          description: >-
            Filter by tag key existence (repeatable). Returns resources that
            have a tag with this key, regardless of the value.
          required: false
          schema:
            type: array
            items:
              type: string
          style: form
          explode: true
      responses:
        '200':
          description: Paginated list of pools.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPoolsResponse'
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ForbiddenError'
        '422':
          description: Validation failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnprocessableEntityError'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
components:
  schemas:
    ResourcePathOrId_WorkspaceId:
      type: string
      description: >-
        A resource path like 'sfc:workspace:acme:my-workspace' _or_ an ID.
        Resource paths are human-readable but not stable - they change when
        resources are renamed or moved. IDs are stable and permanent.
      examples:
        - wksp_k3R-nX9vLm7Qp2Yw5Jd8F
      pattern: >-
        (wksp_[0-9a-zA-Z_-]{1,21})|(sfc:workspace:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){1,1})
    ResourcePathOrId_PoolId:
      type: string
      description: >-
        A resource path like 'sfc:pool:acme:prod:my-pool' _or_ an ID. Resource
        paths are human-readable but not stable - they change when resources are
        renamed or moved. IDs are stable and permanent.
      examples:
        - pool_k3R-nX9vLm7Qp2Yw5Jd8F
      pattern: >-
        (pool_[0-9a-zA-Z_-]{1,21})|(sfc:pool:[a-zA-Z0-9._-]+(:[a-zA-Z0-9._-]+){2,2})
    PoolsCursor:
      type: string
      examples:
        - poolc_gqXR7s0Kj5mHvE2wNpLc4Q
      pattern: ^poolc_[A-Za-z0-9_-]+$
    ListPoolsResponse:
      type: object
      required:
        - object
        - has_more
        - data
      properties:
        object:
          type: string
          const: list
          default: list
          readOnly: true
        cursor:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/PoolsCursor'
              description: Pass as `starting_after` or `ending_before` to paginate.
        has_more:
          type: boolean
        data:
          type: array
          items:
            $ref: '#/components/schemas/PoolResponse'
    UnauthorizedError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              const: authentication_error
              default: authentication_error
              readOnly: true
            message:
              type: string
              x-speakeasy-error-message: true
    ForbiddenError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              const: forbidden
              default: forbidden
              readOnly: true
            message:
              type: string
              x-speakeasy-error-message: true
    UnprocessableEntityError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              const: unprocessable_entity
              default: unprocessable_entity
              readOnly: true
            message:
              type: string
              x-speakeasy-error-message: true
            details:
              type: array
              items:
                $ref: '#/components/schemas/ErrorDetail'
    InternalServerError:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - message
          properties:
            type:
              type: string
              const: api_error
              default: api_error
              readOnly: true
            message:
              type: string
              x-speakeasy-error-message: true
    PoolResponse:
      allOf:
        - $ref: '#/components/schemas/PoolScope'
        - type: object
          required:
            - object
            - allocation_schedule
            - created_at
          properties:
            object:
              type: string
              description: Discriminator for `/pools` responses.
              const: pool
              default: pool
              readOnly: true
            allocation_schedule:
              $ref: '#/components/schemas/AllocationSchedule'
              description: >-
                Allocation schedule of this pool. Add to the schedule by placing
                buy orders into this pool.
            procurements:
              type: array
              items:
                $ref: '#/components/schemas/ProcurementSummary'
              description: Active procurements targeting this pool.
            deployments:
              type: array
              items:
                $ref: '#/components/schemas/DeploymentSummary'
              description: Active deployments targeting this pool.
            created_at:
              $ref: '#/components/schemas/UnixEpoch'
            tags:
              oneOf:
                - type: 'null'
                - $ref: '#/components/schemas/Tags'
                  description: Metadata tags attached to this pool.
      description: A pool — a container of owned compute allocation over time.
    ErrorDetail:
      type: object
      required:
        - code
        - message
      properties:
        field:
          type:
            - string
            - 'null'
          description: The field that caused the error (for validation errors)
        code:
          type: string
          description: Specific error code for this detail
        message:
          type: string
          description: Human-readable error message
    PoolScope:
      type: object
      description: >-
        A pool's scope: its identifiers (`pool_` / `sfc:pool:` forms), owner,
        workspace, and kind, as the `/pools` endpoints present it.
      required:
        - id
        - resource_path
        - owner
        - workspace
        - workspace_id
        - name
        - kind
      properties:
        id:
          $ref: '#/components/schemas/PoolId'
        resource_path:
          $ref: '#/components/schemas/poolResourcePath_PoolId'
        owner:
          $ref: '#/components/schemas/Name'
        workspace:
          $ref: '#/components/schemas/Name'
        workspace_id:
          $ref: '#/components/schemas/WorkspaceId'
        name:
          $ref: '#/components/schemas/Name'
        kind:
          $ref: '#/components/schemas/v2.PoolKind'
    AllocationSchedule:
      type: object
      required:
        - total
        - by_instance_sku
      properties:
        total:
          $ref: '#/components/schemas/Schedule'
          description: >-
            Combined allocation schedule across all instance SKUs. Only includes
            current and future schedule.
        by_instance_sku:
          type: object
          description: >-
            Allocation schedule keyed by instance SKU. Only includes current and
            future schedule.
          additionalProperties:
            $ref: '#/components/schemas/Schedule'
          propertyNames:
            oneOf:
              - type: string
                examples:
                  - isku_k3R-nX9vLm7Qp2Yw5Jd8F
                pattern: isku_[0-9a-zA-Z_-]{1,21}
              - type: string
                description: Legacy alias prefix; accepted on read, never emitted on write.
                pattern: clus_[0-9a-zA-Z_-]{1,21}
            description: >-
              Accepts the canonical prefix below; additional legacy prefixes are
              aliased for read compatibility. Writes always emit the canonical
              form.
    ProcurementSummary:
      type: object
      required:
        - id
        - name
      properties:
        id:
          $ref: '#/components/schemas/ProcurementId'
        name:
          $ref: '#/components/schemas/Name'
    DeploymentSummary:
      type: object
      required:
        - id
        - name
      properties:
        id:
          $ref: '#/components/schemas/DeploymentId'
        name:
          $ref: '#/components/schemas/Name'
    UnixEpoch:
      type: integer
      format: int64
      description: Unix timestamp.
      example: 1738972800
    Tags:
      type: object
      additionalProperties:
        type: string
        examples:
          - prod
        maxLength: 256
        pattern: ^[^,=]{0,256}$
      propertyNames:
        type: string
        examples:
          - env
        maxLength: 128
        minLength: 1
        pattern: ^[^_,= ][^,= ]{0,127}$
      examples:
        - env: prod
          team: infra
      maxProperties: 50
    PoolId:
      type: string
      examples:
        - pool_k3R-nX9vLm7Qp2Yw5Jd8F
      pattern: pool_[0-9a-zA-Z_-]{1,21}
    poolResourcePath_PoolId:
      type: string
      description: >-
        A resource path for a pool resource. Format:
        sfc:pool:<account>:<workspace>:<name>.
      examples:
        - sfc:pool:<account_id>:<workspace>:<name>
      pattern: sfc:pool:([a-zA-Z0-9._-]+:){2}[a-zA-Z0-9._-]+
    Name:
      type: string
      examples:
        - my-resource-name
      maxLength: 255
      minLength: 1
      pattern: '[a-zA-Z0-9][a-zA-Z0-9._-]{0,254}'
    WorkspaceId:
      type: string
      examples:
        - wksp_k3R-nX9vLm7Qp2Yw5Jd8F
      pattern: wksp_[0-9a-zA-Z_-]{1,21}
    v2.PoolKind:
      type: string
      description: >-
        Pool kind determines what operations are allowed on a pool.


        - `Market`: User-created pools. - `Originating`: Provider pools for
        selling compute. Cannot add compute   (buy orders/procurements). -
        `ReadOnly`: System-managed pools used for legacy compute, bare metal  
        contracts, and other. Cannot be modified through the API.
      enum:
        - market
        - originating
        - read_only
    Schedule:
      type: array
      items:
        $ref: '#/components/schemas/ScheduleEntry'
      description: >-
        Node count over time, as a list of `[start_at, end_at)` time ranges.


        Example: 5 nodes from t=0 to t=3600 is `[{"start_at": 0, "end_at": 3600,
        "node_count": 5}]`.


        `start_at` and `end_at` must be 60-second aligned, `node_count` must be
        non-negative. On non-final entries, `end_at` may be omitted (inferred
        from the next entry's `start_at`); gaps fill with `node_count: 0`.
    ProcurementId:
      type: string
      examples:
        - proc_k3R-nX9vLm7Qp2Yw5Jd8F
      pattern: proc_[0-9a-zA-Z_-]{1,21}
    DeploymentId:
      type: string
      examples:
        - depl_k3R-nX9vLm7Qp2Yw5Jd8F
      pattern: depl_[0-9a-zA-Z_-]{1,21}
    ScheduleEntry:
      type: object
      description: >-
        A `[start_at, end_at)` time range with a fixed `node_count`. `end_at` is
        `null` only on the final entry, marking an unbounded tail.
      required:
        - start_at
        - node_count
      properties:
        start_at:
          $ref: '#/components/schemas/UnixEpoch'
        end_at:
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/UnixEpoch'
        node_count:
          type: integer
          format: int32
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Create an API token using `sf tokens create` or at
        https://sfcompute.com/account/api-keys.

````