List user and enterprise events

GET https://{{api.box.com}}/2.0/events

Returns up to a year of past events for a given user

https://developer.box.com/reference/get-events

Request Params

• all returns everything for a user and is the default

• changes returns events that may cause file tree changes such as file updates or collaborations.

• sync is similar to changes but only applies to synced folders

• admin_logs returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for programmatically pulling from a 1 year history of events across all users within the enterprise and within a created_after and created_before time frame. The complete history of events will be returned in chronological order based on the event time, but latency will be much higher than admin_logs_streaming.

• admin_logs_streaming returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for polling for recent events across all users within the enterprise. Latency will be much lower than admin_logs, but events will not be returned in chronological order and may contain duplicates. | | stream_position | number | | The location in the event stream to start receiving events from.

• now will return an empty list events and the latest stream position for initialization.

• 0 or null will return all events. | | limit | number | | Limits the number of events returned

Note: Sometimes, the events less than the limit requested can be returned even when there may be more events remaining. This is primarily done in the case where a number of events have already been retrieved and these retrieved events are returned rather than delaying for an unknown amount of time to see if there are any more results. | | event_type | string | | A comma-separated list of events to filter by. This can only be used when requesting the events with a stream_type of admin_logs or adming_logs_streaming. For any other stream_type this value will be ignored. | | created_after | string | | The lower bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored. | | created_before | string | | The upper bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored. |

RESPONSES

status: OK

{"chunk_size":2,"next_stream_position":"1152922976252290886","entries":[{"type":"event","created_at":"2022-12-12T10:53:43-08:00","recorded_at":"2022-12-12T10:54:43-08:00","event_id":"f82c3ba03e41f7e8a7608363cc6c0390183c3f83","created_by":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com"},"event_type":"FILE_MARKED_MALICIOUS","session_id":"70090280850c8d2a1933c1","source":{"id":"11446498","type":"user","name":"Aaron Levie","login":"ceo@example.com","created_at":"2012-12-12T10:53:43-08:00","modified_at":"2012-12-12T10:53:43-08:00","language":"en","timezone":"Africa/Bujumbura","space_amount":11345156112,"space_used":1237009912,"max_upload_size":2147483648,"status":"active","job_title":"CEO","phone":"6509241374","address":"900 Jefferson Ave, Redwood City, CA 94063","avatar_url":"https://www.box.com/api/avatar/large/181216415","notification_email":{"email":"notifications@example.com","is_confirmed":true}},"additional_details":{"key":"value"}}]}