Box Developer Documentation
Log in
Latest version

List storage policy assignments

get
https://api.box.com/2.0
/storage_policy_assignments

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Fetches all the storage policy assignment for an enterprise or user.

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

stringin queryrequired
984322

The ID of the user or enterprise to return assignments for.

stringin queryrequired
user

The target type to return assignments for.

Value is one of user,enterprise

Response

application/jsonStorage policy assignments

Returns a collection of storage policies for the enterprise or user.

application/jsonClient error

An unexpected client error.

get
List storage policy assignments
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/storage_policy_assignments?resolved_for_type=userresolved_for_id=984322" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.storagePolicyAssignments.getStoragePolicyAssignments({
  resolvedForType:
    'user' as GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField,
  resolvedForId: userId,
} satisfies GetStoragePolicyAssignmentsQueryParams);
Python v10
client.storage_policy_assignments.get_storage_policy_assignments(
    GetStoragePolicyAssignmentsResolvedForType.USER, user_id
)
.NET v10
await client.StoragePolicyAssignments.GetStoragePolicyAssignmentsAsync(queryParams: new GetStoragePolicyAssignmentsQueryParams(resolvedForType: GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField.User, resolvedForId: userId));
Swift v10
try await client.storagePolicyAssignments.getStoragePolicyAssignments(queryParams: GetStoragePolicyAssignmentsQueryParams(resolvedForType: GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField.user, resolvedForId: userId))
Java v10
client.getStoragePolicyAssignments().getStoragePolicyAssignments(new GetStoragePolicyAssignmentsQueryParams(GetStoragePolicyAssignmentsQueryParamsResolvedForTypeField.USER, userId))
Java v5
BoxStoragePolicyAssignment.Info assignmentInfo = BoxStoragePolicyAssignment.getAssignmentForTarget(api, "user", "1234")
Python v4
assignment = client.user(user_id='12345').get_storage_policy_assignment()
print(f'Assignment ID is {assignment.id} and the storage policy ID is {assignment.storage_policy.id}')
.NET v6
BoxStoragePolicyAssignment assignment = client.StoragePoliciesManager
    .GetAssignmentForTargetAsync("22222");
Node v4
client.storagePolicies.getAssignmentForTarget('22222')
    .then(assignment => {
        /* assignment -> {
            type: 'storage_policy_assignment',
            id: 'dXNlcl8yMjIyMg==',
            storage_policy: 'storage_policy', id: '7' },
            assigned_to: { type: 'user', id: '22222' } }
        */
    });

Response Example

{
  "entries": [
    {
      "assigned_to": {
        "id": "11446498",
        "type": "file"
      },
      "id": "ZW50ZXJwcmlzZV8xMjM0NTY3ODkw",
      "storage_policy": {
        "id": "11446498",
        "type": "storage_policy"
      },
      "type": "storage_policy_assignment"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}