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

# Retrieve

> Get a pool by id



## OpenAPI

````yaml /renderflow/api-reference/openapi.json get /pools/{id}
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /pools/{id}:
    get:
      tags:
        - Pools
      summary: Retrieve
      description: Get a pool by id
      operationId: getPool
      parameters:
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          required: true
          name: id
          in: path
      responses:
        '200':
          description: The pool
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pool'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    Pool:
      type: object
      properties:
        id:
          type: string
          pattern: ^[a-fA-F0-9]{24}$
          example: 68b1f0c2a4d3e5f6a7b8c9d0
        name:
          type: string
        color:
          type: string
          default: ''
        icon:
          type: string
          default: ''
        description:
          type: string
          default: ''
        priority:
          type: integer
          default: 0
        node_limit:
          type: integer
          default: 0
        order:
          $ref: '#/components/schemas/DistributionOrder'
        readonly:
          type: boolean
          default: false
        lend:
          $ref: '#/components/schemas/LendMode'
        lend_to:
          type:
            - array
            - 'null'
          items:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            example: 68b1f0c2a4d3e5f6a7b8c9d0
          default: null
        reserve:
          type: integer
          default: 0
        borrow:
          type: boolean
          default: true
        borrow_limit:
          type: integer
          default: 0
        accept_types:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/TaskType'
          default: null
        max_priority:
          type:
            - integer
            - 'null'
          default: null
        max_node_limit:
          type:
            - integer
            - 'null'
          default: null
        cleanup:
          $ref: '#/components/schemas/JobCleanup'
        created_at:
          type: integer
          default: 0
          example: 1785846207000
      required:
        - id
        - name
        - color
        - icon
        - description
        - priority
        - node_limit
        - readonly
        - lend_to
        - reserve
        - borrow
        - borrow_limit
        - accept_types
        - max_priority
        - max_node_limit
        - created_at
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
    DistributionOrder:
      type: string
      enum:
        - pool_priority_date
        - pool_priority_balanced
      default: pool_priority_date
    LendMode:
      type: string
      enum:
        - none
        - idle
        - surplus
      default: none
    TaskType:
      type: string
      enum:
        - renderflow.test
        - 3dsmax.render
        - 3dsmax.scene_manager.render
        - arnold.render
        - after.render
        - blender.render
        - cinema4d.render
        - houdini.batch
        - houdini.mantra
        - houdini.husk
        - imager
        - ffmpeg
        - denoise
        - autograph.render
        - fusion.render
        - harmony.render
        - keyshot.render
        - maya.render
        - nuke.render
        - renderman.render
        - premiere.render
        - media_encoder.encode
        - davinci.render
        - shell
        - python
        - unreal
        - vray.dr.spawner
        - redshift.render
        - sketchup.render
        - rhino.render
        - vray_standalone
        - vantage.render
        - vred.render
        - comfyui.render
        - agentic
        - 3dsmax.script
        - blender.script
        - cinema4d.script
        - maya.script
        - houdini.script
        - nuke.script
        - fusion.script
        - 3dsmax.export
        - maya.export
        - blender.export
        - cinema4d.export
        - renderflow.custom_plugin
        - renderflow.benchmark
    JobCleanup:
      type:
        - object
        - 'null'
      properties:
        type:
          type: string
          default: none
        delay:
          type: integer
          default: 0
      default: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

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