Skip to main content
GET
/
api
/
v2
/
resource
/
list
List Resources
curl --request GET \
  --url https://app.octavehq.com/api/v2/resource/list \
  --header 'api_key: <api-key>'
{
  "_metadata": {
    "requestId": "requestId",
    "timestamp": "2021-01-01T00:00:00.000Z",
    "usage": 0,
    "message": "message"
  },
  "data": [
    {
      "oId": "<string>",
      "sourceType": "url",
      "identifier": "<string>",
      "workspaceOId": "<string>",
      "isParentResource": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "name": "<string>",
      "metadata": {
        "fieldwiseTaskIdentifier": "<string>",
        "taskStatus": "pending",
        "externalFilePath": "<string>",
        "title": "<string>",
        "description": "<string>",
        "faviconUrl": "<string>",
        "logoUrl": "<string>",
        "statusCode": 123,
        "isWorkspacePrimarySource": false,
        "isMainResource": false,
        "asyncCrawlComplete": true,
        "originalFileName": "<string>",
        "driveFileType": "file",
        "driveFileUrl": "<string>",
        "driveFileLastModifiedTime": "<string>"
      },
      "settings": {
        "excludeFromReIndexing": true
      },
      "encodedData": "<string>",
      "fieldwiseDocumentId": "<string>",
      "status": "pending",
      "lastIndexedAt": "<string>",
      "hasChildren": true,
      "totalChildren": 123,
      "storageData": {
        "taskStatus": "pending",
        "fieldwiseTaskIdentifier": "<string>",
        "filePath": "<string>",
        "fieldwiseDocumentId": "<string>"
      },
      "uploadedByUserOId": "<string>"
    }
  ],
  "total": 123,
  "hasNext": true
}

Authorizations

api_key
string
header
required

Query Parameters

limit
number | null
default:20

Maximum number of resources to return (default: 20)

Example:

20

offset
number | null
default:0

Pagination offset (default: 0)

Example:

0

resourceType
enum<string>

Filter by resource type: URL, GOOGLE_DRIVE, or TEXT

Available options:
url,
google_drive,
text

Search resources by name (case-insensitive)

Example:

"landing page"

status
enum<string>

Filter by resource status: PENDING, UPLOADING, INDEXED, or FAILED

Available options:
pending,
uploading,
indexed,
failed

Response

List of resources

_metadata
object
required
data
object[]
required
total
number
required
hasNext
boolean
required