Select Friend
Box
Resource Type
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| group_type | string | The type of the group. ex: managed_group,all_users_group | |
| description | string | Human readable description of the group (max length 255). | |
| external_sync_identifier | string | An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems. ex: AD:123456 | |
| invitability_level | string | Specifies who can invite the group to collaborate on items. ex: admins_only, admins_and_members, all_managed_users | |
| member_viewability_level | string | Specifies who can view the members of the group (Get Memberships for Group). ex: admins_only, admins_and_members, all_managed_users | |
| permissions | object | Describes the permissions that the current user has for this group. | |
| can_invite_as_collaborator | boolean | Specifies if the user can invite the group to collaborate on any items. ex: True | |
| provenance | string | Keeps track of which external source this group is coming from e.g. "Active Directory", "Google Groups", "Facebook Groups". Setting this will also prevent Box users from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups. | |
| type | string | Group type (Value is always group) | |
| name | string | The name of the group. | |
| created_at | string | When the group object was created. ex: 2024-07-19T05:21:37-07:00 | |
| modified_at | string | When the group object was last modified. ex: 2024-07-19T05:21:37-07:00 | |
| id | string | The unique identifier for group. ex: 20324810242 |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| acceptance_requirements_status | object | Acceptance requirement status object | |
| two_factor_authentication_requirement | object | Two factor authentication requirement object | |
| enterprise_has_two_factor_auth_enabled | boolean | Whether or not the enterprise that owns the content requires two-factor authentication to be enabled in order to collaborate on the content.ex: True | |
| user_has_two_factor_authentication_enabled | boolean | Whether or not the user has two-factor authentication enabled. The field is null when two-factor authentication is not required. ex: True | |
| strong_password_requirement | object | Strong password requirement object | |
| user_has_strong_password | boolean | Whether or not the user has a strong and not exposed password set for their account. The field is null when a strong password is not required.ex: True | |
| enterprise_has_strong_password_required_for_external_users | boolean | Whether or not the enterprise that owns the content requires a strong password to collaborate on the content, or enforces an exposed password detection for the external collaborators. ex: True | |
| terms_of_service_requirement | object | Terms of service Object. | |
| is_accepted | boolean | Whether or not the terms of service have been accepted. The field is null when there is no terms of service required. ex: True | |
| terms_of_service | object | The terms of service that must be accepted before the collaboration can be accepted. The field is null when there is no terms of service required. | |
| id | string | The unique identifier for this terms of service. ex: 11446498 | |
| type | string | Value is always terms_of_service. | |
| created_at | string | When the collaboration object was created. ex: 2012-12-12T10:53:43-08:00 | |
| id | string | The unique identifier for this collaboration. ex: 12345678 | |
| role | string | The level of access granted. Value is one of editor,viewer,previewer,uploader,previewer uploader,viewer uploader,co-owner,owner. | |
| acknowledged_at | string | When the status of the collaboration object changed to accepted or rejected. ex: 2012-12-12T10:55:20-08:00 | |
| app_item | object | An app_item to which access is granted. The field is null when the collaboration is created on an item (see item field), or the app_item is inaccessible. The role cascades to all items associated with the app_item. | |
| type | string | Value is always app_item. ex: app_item | |
| application_type | string | The type of the app that owns this app item. ex: hubs | |
| id | string | The unique identifier for this app item. ex: 12345678 | |
| status | string | The status of the collaboration invitation. If the status is pending, login and name return an empty string. ex: accepted,pending,rejected | |
| accessible_by | object | The user or group that is granted access. | |
| id | string | The unique identifier of group(resources collected are only for group, else user id can also come). ex: "11446498" | |
| type | string | value will be either user or group. ex: user,group | |
| is_active | boolean | Is user active(True) or deleted. ex: True | |
| login | string | The primary email address of this user. If the collaboration status is pending, an empty string is returned. ex: ceo@example.com | |
| name | string | name of the user or group. | |
| group_type | string | The type of the group. ex: managed_group,all_users_group | |
| created_by | list<object> | The user who created the collaboration object. | |
| id | number | The unique identifier for this user. ex: 33224412 | |
| type | string | Value is always user | |
| login | string | The primary email address of this user. If the collaboration status is pending, an empty string is returned. ex: dylan@example.com | |
| name | string | The display name of this user. If the collaboration status is pending, an empty string is returned. ex: Dylan Smith | |
| item | object | The file or folder to which access is granted. The field is null when the collaboration status is pending or the collaboration is created on an app item (see app_item field). | |
| etag | string | Etag ex: 1 | |
| modified_at | string | item modified_at ,ex: 2012-12-12T10:53:43-08:00 | |
| owned_by | object | owned by object | |
| login | string | user login, ex: ceo@example.com | |
| name | string | user name, ex: Aaron Levie | |
| id | string | User who owns the item, ex: 11446498 | |
| type | string | type ,ex: user | |
| purged_at | string | item purged_at, ex: 2012-12-12T10:53:43-08:00 | |
| shared_link | object | item shared link object | |
| download_url | string | items download url, ex: https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg | |
| effective_access | string | who can access, ex: company | |
| permissions | object | Permissions object | |
| can_download | boolean | Can the shared link be downloaded? ex: True | |
| can_edit | boolean | Can the shared link be edited? ex: True | |
| can_preview | boolean | Can the shared link be previewed? ex: True | |
| unshared_at | string | When the shared link was unshared, ex: 2012-12-12T10:53:43-08:00 | |
| url | string | items shared link url, ex: https://www.box.com/s/rh935iit6ewrmw0unyul | |
| vanity_name | string | vanity_name ex: my_url | |
| effective_permission | string | shared permission level, ex: can_download | |
| is_password_enabled | boolean | Does sharing link has password enabled, ex: True | |
| preview_count | number | previewed count using shared link, ex: 3 | |
| vanity_url | string | vanity_url ex: https://www.box.com/s/my_url | |
| access | string | shared items access status, ex: open | |
| download_count | number | downloaded count using shared link, ex: 3 | |
| size | number | Size of the item in bytes. ex: 123456 | |
| name | string | name of item ex: Contract.pdf | |
| content_created_at | string | item content created time ex: 2012-12-12T10:53:43-08:00 | |
| content_modified_at | string | item content modified time ex: 2012-12-12T10:53:43-08:00 | |
| created_at | string | item content created_at time ex: 2012-12-12T10:53:43-08:00 | |
| created_by | object | The user who created the item. | |
| login | string | user login, ex: ceo@example.com | |
| name | string | user name, ex: Aaron Levie | |
| id | string | The user id who created the item. ex: 11446498 | |
| type | string | type ,ex: user | |
| type | string | type of the item ex: file | |
| sequence_id | string | sequence id of item ex: 3 | |
| sha1 | string | sha1 of item ex: 85136C79CBF9FE36BB9D05D0639C70C265C18D37 | |
| item_status | string | item_status ex: active | |
| parent | object | Parent object details | |
| etag | string | parent object etag ex: 1 | |
| id | string | parent object id ex: 12345" | |
| type | string | parent object type, ex: folder | |
| name | string | parent object name, ex: Contracts | |
| sequence_id | string | parent object sequence_id ex: 3 | |
| path_collection | object | Path collection Object | |
| total_count | number | total entries, ex: 1 | |
| entries | list<object> | entries | |
| id | string | path collection id, ex: 12345 | |
| type | string | path collection type, ex: folder | |
| name | string | path collection name, ex: Contracts | |
| sequence_id | string | path collection sequence_id, ex: 3 | |
| etag | string | path collection etag, ex: 1 | |
| id | string | item id ex: 1234 | |
| file_version | object | file version object | |
| sha1 | string | file sha1 ex: 134b65991ed521fcfe4724b7d814ab8ded5185dc | |
| id | string | file id ex: 12345 | |
| type | string | file version ex: file_version | |
| description | string | Description ,ex: Contract for Q1 renewal | |
| modified_by | object | modified_by object | |
| name | string | modified user name ,ex: Aaron Levie | |
| id | string | modified_by user ,ex: 11446498 | |
| type | string | type ,ex: user | |
| login | string | modified user login ,ex: ceo@example.com | |
| trashed_at | string | When the item was moved to the trash, ex: 2012-12-12T10:53:43-08:00 | |
| type | string | type, Value is always collaboration | |
| expires_at | string | When the collaboration will expire, or null if no expiration date is set. ex: 2012-12-26T10:53:43-08:00 | |
| invite_email | string | The email address used to invite an unregistered collaborator, if they are not a registered user. ex: john@example.com | |
| is_access_only | boolean | If set to true, collaborators have access to shared items. ex: True | |
| modified_at | string | When the collaboration object was last modified. ex: 2012-12-12T10:53:43-08:00 |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| group | object | group object | |
| type | string | Value is always group | |
| id | string | The unique identifier of group. ex: "22183048556" | |
| name | string | The name of the group. ex: testgroup | |
| group_type | string | The type of the group. ex: managed_group,all_users_group | |
| role | string | The role of the user in the group. ex: member,admin | |
| created_at | string | The time this membership was created. ex: 2025-04-09T21:42:04-07:00 | |
| modified_at | string | The time this membership was last modified. ex: 2025-04-09T23:47:58-07:00 | |
| ns_membership_id | string | custom membership ID for the group and user membership. | |
| ns_membership_name | string | custom name for the group and user membership. | |
| type | string | Value is always group_membership. | |
| user | object | User object | |
| name | string | The display name of this user. ex: abdd | |
| login | string | The primary email address of this user. ex: abcd@nsope.com | |
| type | string | Value is always user. ex: user | |
| id | string | The unique identifier for this user. ex: "41484722176" |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| type | string | Type. | |
| space_used | number | Space used by the user. | |
| job_title | string | Job title of the user. | |
| enterprise | object | Enterprise details of the user. | |
| name | string | Enterprise name. | |
| type | string | Enterprise type. | |
| id | string | Enterprise ID. | |
| tracking_codes | object | Tracking codes. | |
| type | string | type. | |
| name | string | Tracking code name ex: department. | |
| value | string | value. | |
| id | string | Unique ID for the user. | |
| timezone | string | Timezone of the user. | |
| max_upload_size | number | Maximum upload size for the user. | |
| status | string | Status of the user ex: active,inactive,cannot_delete_edit(Active-View/Upload Only). | |
| avatar_url | string | Avatar URL of the user. | |
| notification_email | object | Notification email of the user. | |
| string | Notification email of the user. | ||
| is_confirmed | boolean | Is notification email confirmed. | |
| is_exempt_from_device_limits | boolean | Is exempt from device limits. | |
| is_exempt_from_login_verification | boolean | Is exempt from login verification. | |
| language | string | Language preference of the user. | |
| space_amount | number | Total space allocated to the user. | |
| address | string | Address of the user. | |
| can_see_managed_users | boolean | Can see managed users. | |
| is_external_collab_restricted | boolean | Is external collaboration restricted. | |
| is_sync_enabled | boolean | Is sync enabled. | |
| role | string | Role. | |
| phone | string | Phone number of the user. | |
| name | string | Name of the user. | |
| login | string | Login email of the user. | |
| created_at | string | User creation timestamp. | |
| modified_at | string | Last modification timestamp of the user. | |
| external_app_user_id | string | External app user ID. | |
| hostname | string | Hostname ex: https://example.app.box.com/. | |
| is_platform_access_only | boolean | Is platform access only. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|