List pending collaborations

get

https://api.box.com/2.0

/collaborations

Retrieves all pending collaboration invites for this user.

Related Guides

Request

Content-Typeapplication/json

Query Parameters

fieldsstring arrayin queryoptional

exampleid,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

limit integer / int64in queryoptional

example1000Range1000

The maximum number of items to return per page.

offset integer / int64in queryoptional

example1000Default0

The offset of the item at which to begin the response.

status stringin queryrequired

examplepending

Value is always pending

Response

200application/jsonCollaborations

Returns a collection of pending collaboration objects.

If the user has no pending collaborations, the collection will be empty.

defaultapplication/jsonClient error

An unexpected client error.

get

List pending collaborations

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -X GET https://api.box.com/2.0/collaborations?status=pending \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'

.NET

BoxCollection<BoxCollaboration> pendingCollabs = await CollaborationsManager
    .GetPendingCollaborationAsync();

Java

Collection<BoxCollaboration.Info> pendingCollaborations =
    BoxCollaboration.getPendingCollaborations(api);

Python

pending_collaborations = client.get_pending_collaborations()
for pending_collaboration in pending_collaborations:
    print('Collaboration {0} is pending'.format(pending_collaboration.id))

Node

client.collaborations.getPending()
	.then(collaborations => {
		/* collaborations -> {
			total_count: 1,
			entries: [
				{
					type: 'collaboration',
					id: '11111',
					created_by: {
						type: 'user',
						id: '22222',
						name: 'Example User',
						login: 'user@example.com'
					},
					created_at: '2011-11-29T12:56:35-08:00',
					modified_at: '2012-09-11T15:12:32-07:00',
					expires_at: null,
					status: 'pending',
					accessible_by: {
						type: 'user',
						id: '33333',
						name: 'Collaborator User',
						login: 'collaborator@example.com'
					},
					role: 'editor',
					acknowledged_at: '2011-11-29T12:59:40-08:00',
					item: null
				}
			]
		}
		*/
	});

iOS

client.collaborations.listPendingForEnterprise() { results in
    switch results {
    case let .success(iterator):
        for i in 1 ... 10 {
            iterator.next { result in
                switch result {
                case let .success(collaboration):
                    print("Collaboration created by \(collaboration.createdBy?.name)")
                case let .failure(error):
                    print(error)
                }
            }
        }
    case let .failure(error):
        print(error)
    } 
}