Sample - Box Platform API
GET/storage_policy_assignments/{storage_policy_assignment_id}

Get a storage policy assignment

Retrieves a specific storage policy assignment by its identifier. Use storage_policy_assignment_id to inspect the storage policy assigned to a user or enterprise.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
storage_policy_assignment_idstringrequired
The unique identifier of the storage policy assignment to retrieve.

2 status codes
200Returns a storage policy assignment object containing its identifier, type, assigned storage policy, and assignment target.
idstringrequired
The unique identifier for a storage policy assignment.
typestringrequired
The value will always be `storage_policy_assignment`.
Allowed:storage_policy_assignment
storage_policyobjectoptional
assigned_toobjectoptional
defaultReturned when an unexpected client error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

storage_policy_assignment_id must identify the storage policy assignment to retrieve. Provide the identifier as a string.