Get all projects with filtering
Retrieves a paginated list of projects with comprehensive filtering options.
Filtering Options:
- status: Filter by one or more statuses
- priority: Filter by priority levels
- clientId: Filter by linked client
- category: Filter by category
- tags: Filter by tags (any match)
- search: Search in name and description
- includeDeleted: Include soft-deleted projects
Pagination:
- page: Page number (default: 1)
- limit: Items per page (default: 20)
- sortBy: Sort field (name, status, createdAt, startDate, etc.)
- sortOrder: ASC or DESC
Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.
In: header
Query Parameters
Page number (1-indexed)
1 <= value1Items per page
1 <= value <= 10020Sort by field(s). Format: "field:asc" or "field:desc". Multiple: "field1:asc,field2:desc"
Free-text search query
Filter by client
Filter by category
Search in name and description
Include deleted projects
Sort field
"createdAt"Sort order
"DESC"Response Body
application/json
curl -X GET "https://example.com/projects"{ "items": [ { "id": "string", "name": "string", "status": "draft", "priority": "low", "clientName": "string", "startDate": "string", "endDate": "string", "estimatedValue": "string", "actualValue": "string", "currency": "string", "documentsCount": 0, "createdAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "limit": 0}
