--- title: "List workspaces" method: GET path: "/documents/workspaces-list" tags: ["Document AI — DMS"] --- # List workspaces `GET /documents/workspaces-list` ## Request - Base URL: `https://api.paperoffice.ai/latest` - URL: `https://api.paperoffice.ai/latest/documents/workspaces-list` - Auth: HTTP bearer po_workspaces_list: List workspaces accessible to the current token. Returns workspace ID, name, workspace_tier, _capabilities (trash/recycle-bin, retention), document count and storage size. standard tier: no recycle bin; business... ## Query parameters - `locale` string ## Response `200` Success - object: List workspaces - `_aggregate` object - `total_workspaces` integer - `total_docs` integer - `total_analyzed` integer - `total_unanalyzed` integer - `analyzed_pct` integer - `unanalyzed_pct` integer - `count` integer - `processing_time` string - `result` object[] - `id` integer - `name` string - `description` string - `type` string - `status` string - `is_default` integer - `is_stealth` integer - `is_archived` integer - `image` string - `data_contact` string - `data_address` string - `data_settings` string - `metadata` string - `ai_dms_mode` string - `storage_mount_id` string - `storage_mount_path` string - `storage_mode` string - `auto_locked` integer - `auto_locked_reason` string - `default_locale` string - `created_at` string - `updated_at` string - `workspace_tier` string - `ai_dms_max_pages` string - `ai_dms_max_pages_basic` string - `ai_dms_max_pages_premium` string - `ai_dms_max_pages_ultra` string - `default_document_type_id` string - `is_compliance_vault` integer - `vault_retention_years` string - `vault_retention_mode` string - `vault_retention_legal_basis` string - `crm_contact_id` string - `container_delete_at` string - `default_processing_lane` string - `contact_firstname` string - `contact_lastname` string - `contact_email` string - `contact_phone` string - `address_street` string - `address_zip` string - `address_city` string - `address_country` string - `tier` string - `security_tier` string - `_capabilities` object - `workspace_tier` string - `trash_enabled` boolean - `soft_delete_supported` boolean - `delete_mode_effective_default` string - `retention_at_document_type` boolean - `worm_at_document_level` boolean - `compliance_pdf_watermark` boolean - `audit_trail_readable` boolean - `audit_trail_source` string - `audit_trail_scope` string - `revision_trail_requires_document_worm` boolean - `headless_gobd_recommended_tier` string - `_tier_summary` string - `default_document_type_mode` string - `reference` string - `external_id` string - `cost_center` string - `color` string - `icon` string - `tags` unknown[] - unknown - `password_enabled` boolean - `sms_enabled` boolean - `sms_phone` string - `dual_auth_enabled` boolean - `dual_auth_phone_1` string - `dual_auth_phone_2` string - `session_max_duration` integer - `session_inactivity_timeout` integer - `contact_salutation` string - `contact_position` string - `contact_department` string - `contact_mobile` string - `contact_notes` string - `company_name` string - `company_vatid` string - `company_taxnr` string - `crm_account_id` string - `contact_mode` string - `crm_contact_ids` unknown[] - unknown - `crm_contact_links` unknown[] - unknown - `address_extra` string - `address_line3` string - `address_region` string - `address_country_code` string - `stats` object - `doc_count` integer - `analyzed_count` integer - `unanalyzed_count` integer - `storage_only_count` integer - `ai_dms_basic_count` integer - `ai_dms_premium_count` integer - `ai_dms_ultra_count` integer - `intelligence_score` integer - `intelligence_level` string - `analyzed_pct` integer - `unanalyzed_pct` integer - `total_pages` integer - `storage_only_pages` integer - `unanalyzed_pages` integer - `storage_size_bytes` integer - `storage_size` string - `retention_active_count` integer - `retention_compliance_count` integer - `retention_latest_until` string - `retention_delete_block_count` integer - `legal_hold_active_count` integer - `legal_hold_live_count` integer - `audit_quarantine_count` integer - `protection_check_failed` boolean - `retention_active_count` integer - `retention_compliance_count` integer - `retention_latest_until` string - `retention_delete_block_count` integer - `legal_hold_active_count` integer - `legal_hold_live_count` integer - `is_revision_secure` boolean - `revision_proof_locked` boolean - `document_count` integer - `audit_quarantine_count` integer - `protection_check_failed` boolean - `documents_count` integer - `analyzed_count` integer - `unanalyzed_count` integer - `storage_only_count` integer - `ai_dms_basic_count` integer - `ai_dms_premium_count` integer - `ai_dms_ultra_count` integer - `total_pages` integer - `storage_only_pages` integer - `unanalyzed_pages` integer - `intelligence_score` integer - `intelligence_level` string - `analyzed_pct` integer - `unanalyzed_pct` integer - `processing_lane` string - `has_workspace_password` boolean - `status` string - `total_count` integer - `workspaces` object[] - `id` integer - `name` string - `description` string - `type` string - `status` string - `is_default` integer - `is_stealth` integer - `is_archived` integer - `image` string - `data_contact` string - `data_address` string - `data_settings` string - `metadata` string - `ai_dms_mode` string - `storage_mount_id` string - `storage_mount_path` string - `storage_mode` string - `auto_locked` integer - `auto_locked_reason` string - `default_locale` string - `created_at` string - `updated_at` string - `workspace_tier` string - `ai_dms_max_pages` string - `ai_dms_max_pages_basic` string - `ai_dms_max_pages_premium` string - `ai_dms_max_pages_ultra` string - `default_document_type_id` string - `is_compliance_vault` integer - `vault_retention_years` string - `vault_retention_mode` string - `vault_retention_legal_basis` string - `crm_contact_id` string - `container_delete_at` string - `default_processing_lane` string - `contact_firstname` string - `contact_lastname` string - `contact_email` string - `contact_phone` string - `address_street` string - `address_zip` string - `address_city` string - `address_country` string - `tier` string - `security_tier` string - `_capabilities` object - `workspace_tier` string - `trash_enabled` boolean - `soft_delete_supported` boolean - `delete_mode_effective_default` string - `retention_at_document_type` boolean - `worm_at_document_level` boolean - `compliance_pdf_watermark` boolean - `audit_trail_readable` boolean - `audit_trail_source` string - `audit_trail_scope` string - `revision_trail_requires_document_worm` boolean - `headless_gobd_recommended_tier` string - `_tier_summary` string - `default_document_type_mode` string - `reference` string - `external_id` string - `cost_center` string - `color` string - `icon` string - `tags` unknown[] - unknown - `password_enabled` boolean - `sms_enabled` boolean - `sms_phone` string - `dual_auth_enabled` boolean - `dual_auth_phone_1` string - `dual_auth_phone_2` string - `session_max_duration` integer - `session_inactivity_timeout` integer - `contact_salutation` string - `contact_position` string - `contact_department` string - `contact_mobile` string - `contact_notes` string - `company_name` string - `company_vatid` string - `company_taxnr` string - `crm_account_id` string - `contact_mode` string - `crm_contact_ids` unknown[] - unknown - `crm_contact_links` unknown[] - unknown - `address_extra` string - `address_line3` string - `address_region` string - `address_country_code` string - `stats` object - `doc_count` integer - `analyzed_count` integer - `unanalyzed_count` integer - `storage_only_count` integer - `ai_dms_basic_count` integer - `ai_dms_premium_count` integer - `ai_dms_ultra_count` integer - `intelligence_score` integer - `intelligence_level` string - `analyzed_pct` integer - `unanalyzed_pct` integer - `total_pages` integer - `storage_only_pages` integer - `unanalyzed_pages` integer - `storage_size_bytes` integer - `storage_size` string - `retention_active_count` integer - `retention_compliance_count` integer - `retention_latest_until` string - `retention_delete_block_count` integer - `legal_hold_active_count` integer - `legal_hold_live_count` integer - `audit_quarantine_count` integer - `protection_check_failed` boolean - `retention_active_count` integer - `retention_compliance_count` integer - `retention_latest_until` string - `retention_delete_block_count` integer - `legal_hold_active_count` integer - `legal_hold_live_count` integer - `is_revision_secure` boolean - `revision_proof_locked` boolean - `document_count` integer - `audit_quarantine_count` integer - `protection_check_failed` boolean - `documents_count` integer - `analyzed_count` integer - `unanalyzed_count` integer - `storage_only_count` integer - `ai_dms_basic_count` integer - `ai_dms_premium_count` integer - `ai_dms_ultra_count` integer - `total_pages` integer - `storage_only_pages` integer - `unanalyzed_pages` integer - `intelligence_score` integer - `intelligence_level` string - `analyzed_pct` integer - `unanalyzed_pct` integer - `processing_lane` string - `has_workspace_password` boolean ## Other responses - `4XX`: Error - `5XX`: Error --- [API](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api.md) · [All operations](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/paperoffice/apis/paperoffice-ai-api/revisions/c6a6228a4509?raw)