WhiteboardService
List Whiteboards
List collaborative whiteboards visible to the caller in most-recently-updated order.
Request
curl --request GET \ \ --url 'https://api.testnet.polyester.com/v1/collab/whiteboards?includeArchived=false&limit=100&pageToken=eyJvZmZzZXQiOjEwMH0' \ --header 'Accept: */*' \ --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \ --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \ --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'
Responses
{
"boards": [
{
"access": {
"permissions": {
"canEdit": false,
"canManage": false,
"canView": false
},
"role": "VIEWER"
},
"board": {
"accessVersion": "1",
"archivedAt": "2025-01-01T00:00:00Z",
"audience": "PRIVATE",
"boardId": "123e4567-e89b-42d3-a456-426614174000",
"createdAt": "2025-01-01T00:00:00Z",
"defaultRole": "VIEWER",
"initialSnapshot": {
"elements": [],
"version": 1
},
"ownerAccountId": "7563897446546",
"title": "My Trading Board",
"updatedAt": "2025-01-01T00:00:00Z"
}
}
],
"nextPageToken": "eyJvZmZzZXQiOjIwMH0"
}When true, include archived boards in the response.
Maximum number of boards to return. Defaults to 100 when omitted; maximum is 500.
Opaque keyset cursor from a previous response. The cursor is exclusive and bound to the authenticated caller, archive filter, and newest-updated sort order.
Stable board identifier as a UUID string.
123e4567-e89b-42d3-a456-426614174000Board owner account public ID.
7563897446546Human-readable board title, max 200 characters and 400 bytes.
My Trading BoardDefault audience policy used when no explicit ACL entry matches.
PRIVATEDefault role granted by the audience policy. This is always VIEWER or EDITOR.
VIEWERMonotonic access version incremented when audience, default role, ACL, or archive state changes.
1TODO: description pending
TODO: description pending
Creation time in UTC.
2025-01-01T00:00:00ZLast update time in UTC.
2025-01-01T00:00:00ZArchive time in UTC. Unset when the board is active.
2025-01-01T00:00:00ZHighest resolved role for the caller.
VIEWERWhether the caller may view metadata and join the room.
falseWhether the caller may edit board content in the room.
falseWhether the caller may manage sharing and board settings.
falseOpaque cursor for the next page. Empty when no more results exist.
eyJvZmZzZXQiOjIwMH0| Key | Status | Error | When |
|---|---|---|---|
| unauthenticated | 401 | Unauthenticated | Authentication required. |
| permission-denied | 403 | Permission Denied | Permission denied. |
| invalid-argument | 400 | Invalid Argument | Invalid argument. |
| not-found | 404 | Not Found | Not found. |
| unavailable | 503 | Unavailable | Service unavailable. |