GET
/
v0
/
documents
/
folders
List document folders
curl --request GET \
  --url https://api.avidoai.com/v0/documents/folders \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2024-01-05T12:34:56.789Z",
      "modifiedAt": "2024-01-05T12:34:56.789Z",
      "orgId": "org_123456789",
      "name": "API Documentation",
      "description": "Folder containing all API-related documentation",
      "color": "#10B981",
      "tagIds": [
        "456e4567-e89b-12d3-a456-426614174000",
        "789e4567-e89b-12d3-a456-426614174000"
      ],
      "documentCount": 15
    }
  ],
  "pagination": {
    "skip": 0,
    "limit": 25,
    "total": 100,
    "totalPages": 4
  }
}

Authorizations

​
x-api-key
string
header
required

Your unique Avido API key

Query Parameters

​
skip
integer
default:0

Number of items to skip

Required range: x >= 0
Example:

0

​
limit
integer
default:25

Number of items per page

Required range: 1 <= x <= 100
Example:

25

​
search
string

Search in folder name and description

Example:

"API"

Response

Successfully retrieved folders

Paginated response containing folders