This page documents the canonical HTTP contract for this endpoint.
For scope=me, supply user_id or user_email. An administrator may view another organization user; ordinary users are limited to their own capacity. The route is read-only.
Query parameters
surface· optionalstring
admin_command_center (default) or sales_home.
scope· optionalstring
org (default) or me.
date· optionalstring
Date whose capacity window is summarized.
timezone· optionalstring
Timezone used to calculate the capacity window.
user_id· optionalstring
Target user ID when scope=me.
user_email· optionalstring
Target user email when scope=me.
| Name | Type | Description |
|---|---|---|
| surface | string | admin_command_center (default) or sales_home. |
| scope | string | org (default) or me. |
| date | string | Date whose capacity window is summarized. |
| timezone | string | Timezone used to calculate the capacity window. |
| user_id | string | Target user ID when scope=me. |
| user_email | string | Target user email when scope=me. |
Errors
| Status | Meaning |
|---|---|
| 401 | Authentication is missing or invalid. |
| 403 | Missing tasks:read or caller cannot view the requested target. |
| 400 | scope=me requires a target user; date or timezone is invalid. |
| 404 | Requested target user is not in the organization. |
