Skip to main content

Get File Collaborations

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the file.

Basic Parameters​

ParameterDescription
File IDThe unique identifier that represents a file.

Advanced Parameters​

ParameterDescription
FieldsA 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.
LimitThe maximum number of items to return per page.

Example Output​

{
    "entries": [
        {
            "acceptance_requirements_status": {
                "strong_password_requirement": {
                    "enterprise_has_strong_password_required_for_external_users": true,
                    "user_has_strong_password": true
                },
                "terms_of_service_requirement": {
                    "is_accepted": true,
                    "terms_of_service": {
                        "id": "11446498",
                        "type": "terms_of_service"
                    }
                },
                "two_factor_authentication_requirement": {
                    "enterprise_has_two_factor_auth_enabled": true,
                    "user_has_two_factor_authentication_enabled": true
                }
            },
            "accessible_by": {
                "id": "11446498",
                "login": "ceo@example.com",
                "name": "Aaron Levie",
                "type": "user"
            },
            "acknowledged_at": "2012-12-12T10:55:20-08:00",
            "created_at": "2012-12-12T10:53:43-08:00",
            "created_by": {
                "id": "11446498",
                "login": "ceo@example.com",
                "name": "Aaron Levie",
                "type": "user"
            },
            "expires_at": "2012-12-26T10:53:43-08:00",
            "id": "12345678",
            "invite_email": "john@example.com",
            "item": {
                "content_created_at": "2012-12-12T10:53:43-08:00",
                "content_modified_at": "2012-12-12T10:53:43-08:00",
                "created_at": "2012-12-12T10:53:43-08:00",
                "created_by": {
                    "id": "11446498",
                    "login": "ceo@example.com",
                    "name": "Aaron Levie",
                    "type": "user"
                },
                "description": "Contract for Q1 renewal",
                "etag": "1",
                "file_version": {
                    "id": "12345",
                    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
                    "type": "file_version"
                },
                "id": "12345",
                "item_status": "active",
                "modified_at": "2012-12-12T10:53:43-08:00",
                "modified_by": {
                    "id": "11446498",
                    "login": "ceo@example.com",
                    "name": "Aaron Levie",
                    "type": "user"
                },
                "name": "Contract.pdf",
                "owned_by": {
                    "id": "11446498",
                    "login": "ceo@example.com",
                    "name": "Aaron Levie",
                    "type": "user"
                },
                "parent": {
                    "etag": "1",
                    "id": "12345",
                    "name": "Contracts",
                    "sequence_id": "3",
                    "type": "folder"
                },
                "path_collection": {
                    "entries": [
                        {
                            "etag": "1",
                            "id": "12345",
                            "name": "Contracts",
                            "sequence_id": "3",
                            "type": "folder"
                        }
                    ],
                    "total_count": 1
                },
                "purged_at": "2012-12-12T10:53:43-08:00",
                "sequence_id": "3",
                "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
                "shared_link": {
                    "access": "open",
                    "download_count": 3,
                    "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
                    "effective_access": "company",
                    "effective_permission": "can_download",
                    "is_password_enabled": true,
                    "permissions": {
                        "can_download": true,
                        "can_edit": false,
                        "can_preview": true
                    },
                    "preview_count": 3,
                    "unshared_at": "2018-04-13T13:53:23-07:00",
                    "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
                    "vanity_name": "my_url",
                    "vanity_url": "https://acme.app.box.com/v/my_url/"
                },
                "size": 629644,
                "trashed_at": "2012-12-12T10:53:43-08:00",
                "type": "file"
            },
            "modified_at": "2012-12-12T10:53:43-08:00",
            "role": "editor",
            "status": "accepted",
            "type": "collaboration"
        }
    ],
    "limit": 1000,
    "offset": 2000,
    "order": [
        {
            "by": "type",
            "direction": "ASC"
        }
    ],
    "total_count": 5000
}

Workflow Library Example​

Get File Collaborations with Box and Send Results Via Email

Workflow LibraryPreview this Workflow on desktop