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

# Get Procedures



## OpenAPI

````yaml GET /procedures
openapi: 3.1.0
info:
  version: 1.0.0
  title: Proced AI API
servers: []
security:
  - Bearer: []
paths:
  /procedures:
    get:
      summary: Get Procedures
      parameters:
        - schema:
            type: string
            description: Search query
            example: Proced AI create procedure
          required: false
          name: q
          in: query
        - schema:
            type: string
            description: 'Size by page '
            example: '50'
          required: false
          name: size
          in: query
        - schema:
            type: string
            description: Page for pagination results
            example: '1'
          required: false
          name: page
          in: query
        - schema:
            type: string
            enum:
              - createdAt
              - dueAt
              - project.name
              - name
            description: Sort by
            example: dueAt
          required: false
          name: sortBy
          in: query
        - schema:
            type: string
            description: filter by categoryId
            example: cm2uqwcpd002s7xta3b1j8q3p
          required: false
          name: categoryId
          in: query
        - schema:
            type: string
            description: filter by doerId
            example: cm2uqwcpd002s7xta3b1j8q3p
          required: false
          name: doerId
          in: query
        - schema:
            type: string
            description: startedAt filter by started date
            example: '2023-03-15T00:00:00.000Z'
          required: false
          name: startedAt
          in: query
        - schema:
            type: string
            description: dueAt filter by ended date
            example: '2023-03-15T00:00:00.000Z'
          required: false
          name: dueAt
          in: query
      responses:
        '200':
          description: Retrieve procedures
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProceduresSchema'
        '400':
          description: Returns an error
          content:
            application/json:
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: disconnected
                  message:
                    type: string
                    example: >-
                      The login details of this item have changed (credentials,
                      MFA, or required user action) and a user login is required
                      to update this information.
                  requestId:
                    type: string
                    example: 123e4567-e89b-12d3-a456-426655440000
                required:
                  - code
                  - message
                  - requestId
components:
  schemas:
    ProceduresSchema:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ProcedureSchema'
        meta:
          type: object
          properties:
            total:
              type: number
              description: Meta data
              example: 50
          required:
            - total
      required:
        - data
        - meta
    ProcedureSchema:
      type: object
      properties:
        id:
          type: string
          example: cm0upgshc000rwf5eop1u2awr
        shortId:
          type: string
          nullable: true
          example: cm0upgshc000rwf5eop1u2awr
        name:
          type: string
          example: Proced AI title
        priority:
          type: string
          enum:
            - LOW
            - MEDIUM
            - HIGH
          example: MEDIUM
        state:
          type: string
          enum:
            - TODO
            - IN_PROGRESS
            - COMPLETED
            - WAITING
          example: TODO
        content:
          type: string
          nullable: true
          example: Procedure content goes here.
        categoryId:
          type: string
          nullable: true
          example: cm2uqwcpd002s7xta3b1j8q3p
        doerId:
          type: string
          nullable: true
          example: cm2uj5ffn001x7xtag73jmpx0
        creatorId:
          type: string
          example: cm2uj5ffn001x7xtag73jmpx0
        position:
          type: number
          example: 1
        dueAt:
          type: string
          example: '2024-09-22T22:00:00.000Z'
        createdAt:
          type: string
          example: '2024-09-22T22:00:00.000Z'
        updatedAt:
          type: string
          example: '2024-09-22T22:00:00.000Z'
        projectId:
          type: string
          example: cm2uj5ffn001x7xtag73jmpx0
        workspaceId:
          type: string
          example: cm2uj5ffn001x7xtag73jmpx0
        captureId:
          type: string
          nullable: true
          example: cm2uqwcpd002s7xta3b1j8q3p
        displayVideo:
          type: boolean
          example: true
        isFineTunedData:
          type: boolean
          example: false
        category:
          $ref: '#/components/schemas/CategorySchema'
        doer:
          $ref: '#/components/schemas/UserSchema'
        project:
          $ref: '#/components/schemas/ProjectSchema'
        comments:
          type: array
          nullable: true
          items:
            $ref: '#/components/schemas/ProcedureCommentSchema'
      required:
        - id
        - name
        - priority
        - state
        - creatorId
        - position
        - dueAt
        - createdAt
        - updatedAt
        - projectId
        - workspaceId
        - displayVideo
        - isFineTunedData
    CategorySchema:
      type: object
      nullable: true
      properties:
        id:
          type: string
        name:
          type: string
      required:
        - id
        - name
    UserSchema:
      type: object
      nullable: true
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
      required:
        - id
        - name
        - email
    ProjectSchema:
      type: object
      nullable: true
      properties:
        id:
          type: string
        name:
          type: string
      required:
        - id
        - name
    ProcedureCommentSchema:
      type: object
      properties:
        id:
          type: string
        text:
          type: string
        createdAt:
          type: string
      required:
        - id
        - text
        - createdAt
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````