Sample - Box Platform API
GET/terms_of_service_user_statuses

List terms of service user statuses

Retrieves an overview of users and their status for a terms of service, including Whether they have accepted the terms and when.

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

2 parameters
tos_idstringrequired
The ID of the terms of service.
user_idstringoptional
Limits results to the given user ID.

2 status codes
200Returns a list of terms of service statuses.
total_countintegeroptional
The total number of objects.
entriesarray<TermsOfServiceUserStatus>optional
A list of terms of service user statuses.
defaultAn unexpected client error.
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

Any other status is an error: An unexpected client error.