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.
Request
bearer [ACCESS_TOKEN]
application/json
Query Parameters
stringin queryrequired
324234The ID of the terms of service.
stringin queryoptional
123334Limits results to the given user ID.
Response
application/jsonTerms of service user statuses
Returns a list of terms of service statuses.
application/jsonClient error
An unexpected client error.
Request Example
cURL
curl -i -X GET "https://api.box.com/2.0/terms_of_service_user_statuses?tos_id=324234" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses({
tosId: tos.id,
userId: user.id,
} satisfies GetTermsOfServiceUserStatusesQueryParams);Python Gen
client.terms_of_service_user_statuses.get_terms_of_service_user_statuses(
tos.id, user_id=user.id
).NET Gen
await client.TermsOfServiceUserStatuses.GetTermsOfServiceUserStatusesAsync(queryParams: new GetTermsOfServiceUserStatusesQueryParams(tosId: tos.Id) { UserId = user.Id });Swift Gen (Beta)
try await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses(queryParams: GetTermsOfServiceUserStatusesQueryParams(tosId: tos.id, userId: user.id))Node
client.termsOfService.getUserStatus('11111', { user_id: '22222' })
.then(tosStatus => {
/* tosStatus -> {
type: 'terms_of_service_user_status',
id: '12345',
tos: { type: 'terms_of_service', id: '11111' },
user: { type: 'user', id: '22222' },
is_accepted: true,
created_at: '2018-04-11T15:33:49-07:00',
modified_at: '2018-04-11T15:33:49-07:00' }
*/
});Response Example
{
"entries": [
{
"id": "11446498",
"type": "terms_of_service_user_status",
"tos": {
"id": "11446498",
"type": "terms_of_service"
},
"user": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"is_accepted": true,
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00"
}
],
"total_count": 2
}