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

# List Resources

> List all global resources in the workspace with optional filtering and pagination. Only returns global resources (workspace-wide), not entity-specific resources.



## OpenAPI

````yaml get /api/v2/resource/list
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/resource/list:
    get:
      tags:
        - Resource
      summary: List Resources
      description: >-
        List all global resources in the workspace with optional filtering and
        pagination. Only returns global resources (workspace-wide), not
        entity-specific resources.
      operationId: listResources
      parameters:
        - schema:
            type: number
            nullable: true
            default: 20
            description: 'Maximum number of resources to return (default: 20)'
            example: 20
          required: false
          name: limit
          in: query
        - schema:
            type: number
            nullable: true
            default: 0
            description: 'Pagination offset (default: 0)'
            example: 0
          required: false
          name: offset
          in: query
        - schema:
            type: string
            enum:
              - url
              - google_drive
              - text
            description: 'Filter by resource type: URL, GOOGLE_DRIVE, or TEXT'
          required: false
          name: resourceType
          in: query
        - schema:
            type: string
            description: Search resources by name (case-insensitive)
            example: landing page
          required: false
          name: search
          in: query
        - schema:
            type: string
            enum:
              - pending
              - uploading
              - indexed
              - failed
            description: 'Filter by resource status: PENDING, UPLOADING, INDEXED, or FAILED'
          required: false
          name: status
          in: query
      responses:
        '200':
          description: List of resources
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        oId:
                          type: string
                        sourceType:
                          type: string
                          enum:
                            - url
                            - google_drive
                            - text
                        name:
                          type: string
                          nullable: true
                        identifier:
                          type: string
                        metadata:
                          anyOf:
                            - allOf:
                                - type: object
                                  properties:
                                    ragTaskIdentifier:
                                      type: string
                                    taskStatus:
                                      type: string
                                      enum:
                                        - pending
                                        - processing
                                        - completed
                                        - failed
                                    externalFilePath:
                                      type: string
                                      description: >-
                                        File path in fieldwise, use this to
                                        download the file from fieldwise
                                    title:
                                      type: string
                                    description:
                                      type: string
                                    faviconUrl:
                                      type: string
                                    logoUrl:
                                      type: string
                                    statusCode:
                                      type: number
                                    isWorkspacePrimarySource:
                                      type: boolean
                                      default: false
                                      description: >-
                                        Whether the resource is the primary
                                        source for the workspace
                                    isMainResource:
                                      type: boolean
                                      default: false
                                      description: Entry point of resource tree
                                    asyncCrawlComplete:
                                      type: boolean
                                      description: >-
                                        Whether async crawl for child pages has
                                        completed (for main website resources)
                                    originalFileName:
                                      type: string
                                      description: Original file name for file uploads
                                    driveFileType:
                                      type: string
                                      enum:
                                        - file
                                        - folder
                                    driveFileUrl:
                                      type: string
                                    driveFileLastModifiedTime:
                                      type: string
                                - type: object
                                  additionalProperties:
                                    nullable: true
                            - nullable: true
                        settings:
                          anyOf:
                            - allOf:
                                - type: object
                                  properties:
                                    excludeFromReIndexing:
                                      type: boolean
                                      description: >-
                                        Whether the resource is excluded from
                                        re-indexing, can be used for entitlement
                                        limits
                                - type: object
                                  additionalProperties:
                                    nullable: true
                            - nullable: true
                        encodedData:
                          type: string
                          nullable: true
                        ragDocumentId:
                          type: string
                          nullable: true
                        status:
                          type: string
                          nullable: true
                          enum:
                            - pending
                            - uploading
                            - indexed
                            - failed
                        workspaceOId:
                          type: string
                        isParentResource:
                          type: boolean
                        lastIndexedAt:
                          type: string
                          nullable: true
                        createdAt:
                          type: string
                          nullable: true
                        updatedAt:
                          type: string
                          nullable: true
                        hasChildren:
                          type: boolean
                          description: >-
                            Whether the resource has children, if true use oId
                            to list children resources
                        totalChildren:
                          type: number
                          description: Total number of children resources
                        storageData:
                          type: object
                          properties:
                            taskStatus:
                              type: string
                              nullable: true
                              enum:
                                - pending
                                - processing
                                - completed
                                - failed
                            ragTaskIdentifier:
                              type: string
                              nullable: true
                            filePath:
                              type: string
                              nullable: true
                            ragDocumentId:
                              type: string
                              nullable: true
                        uploadedByUserOId:
                          type: string
                          nullable: true
                      required:
                        - oId
                        - sourceType
                        - identifier
                        - workspaceOId
                        - isParentResource
                        - createdAt
                        - updatedAt
                  total:
                    type: number
                  hasNext:
                    type: boolean
                required:
                  - _metadata
                  - data
                  - total
                  - hasNext
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          description: API usage
          example: 0
        requestId:
          type: string
          description: Request ID
          example: requestId
        message:
          type: string
          description: Message
          example: message
        timestamp:
          type: string
          description: Timestamp
          example: '2021-01-01T00:00:00.000Z'
      required:
        - requestId
        - timestamp
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````