Contract
- shape
- entity
- authority
- read
- evidence
- none
- subscription
- false
- permission
- any one of: org.member (carried by the caller's role template in the org `org_id`); a deactivated caller is refused first
- idempotency
- safe
- emits
- none
- MCP tool
- get_view
- REST
- POST https://api.containertradehq.com/v1/cap/get_view
Idempotency: a read: calling again changes nothing
Inputs
| name | type | required | validation |
|---|---|---|---|
| org_id | org_id | required | tradehq-org-id; 1 to 20 characters The org the view is in. |
| view_id | text | required | 1 to 64 characters The view to open: a UUID, or system:<name> for a system view. |
Response
view· object · The view, as list_saved_views answers it.result· object · What the view's capability answers the caller for its stored call, now: its first page, masked by the caller's data policy.
Full JSON Schema
{
"type": "object",
"properties": {
"view": {
"type": "object",
"description": "The view, as list_saved_views answers it.",
"x-data-class": "operational"
},
"result": {
"type": "object",
"description": "What the view's capability answers the caller for its stored call, now: its first page, masked by the caller's data policy.",
"x-data-class": "operational"
}
},
"required": [
"view",
"result"
],
"additionalProperties": false
} Refusals
unknown_view· 422 · the org has no view by that id that the caller may readview_call_refused· 422 · the view's stored call, run as the caller, was refused: the message names the capability and its code
The platform refusals apply to every call: version, authentication, authority, validation and rate limits, each in the same envelope.
Surfaces
DesktopF
MobileF
APIF
MCPF
VoiceD4
PushN
OneBoxN
OutboundN
- Voice: degraded: visualization
- Push: emits nothing
- OneBox: no document originates a saved view
- Outbound: a read emits nothing
Events
None emitted.
Related
delete_view, get_view_default, pin_view, save_view, set_my_view_default, set_org_view_default, share_view