Box Developer Documentation
Log in
Latest version

List terms of service user statuses

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

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

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
324234

The ID of the terms of service.

stringin queryoptional
123334

Limits 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.

get
List terms of service user statuses
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versionig strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/terms_of_service_user_statuses?tos_id=324234" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses({
  tosId: tos.id,
  userId: user.id,
} satisfies GetTermsOfServiceUserStatusesQueryParams);
Python v10
client.terms_of_service_user_statuses.get_terms_of_service_user_statuses(
    tos.id, user_id=user.id
)
.NET v10
await client.TermsOfServiceUserStatuses.GetTermsOfServiceUserStatusesAsync(queryParams: new GetTermsOfServiceUserStatusesQueryParams(tosId: tos.Id) { UserId = user.Id });
Swift v10
try await client.termsOfServiceUserStatuses.getTermsOfServiceUserStatuses(queryParams: GetTermsOfServiceUserStatusesQueryParams(tosId: tos.id, userId: user.id))
Java v10
client.getTermsOfServiceUserStatuses().getTermsOfServiceUserStatuses(new GetTermsOfServiceUserStatusesQueryParams.Builder(tos.getId()).userId(user.getId()).build())
Node v3
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": [
    {
      "created_at": "2012-12-12T10:53:43-08:00",
      "id": "11446498",
      "is_accepted": true,
      "modified_at": "2012-12-12T10:53:43-08:00",
      "tos": {
        "id": "11446498",
        "type": "terms_of_service"
      },
      "type": "terms_of_service_user_status",
      "user": {
        "id": "11446498",
        "type": "user",
        "login": "ceo@example.com",
        "name": "Aaron Levie"
      }
    }
  ],
  "total_count": 2
}