Skip to main content
The Events API uses cursor-based pagination, which is useful for working with large datasets. In response to each request, the API returns a unique ID (cursor) that indicates where you left off retrieving data. On the next call, you can provide that cursor to continue fetching events starting from the next point in the dataset so no records are missed. There are two types of cursors used in calls to the API: a reset cursor and a cursor (also called a continuing cursor).

​
Reset cursor

A reset cursor is used for the first request you make to the API to create a new point from which to start fetching data. You can also use a reset cursor any time you need to reset the parameters of your cursor – such as the number of records to return with each request – or go back to an earlier point in the records. For the first POST request you make to the API, you must include a ResetCursor object with an optional start time, end time, and limit parameters in the request body. The return will include a cursor in the response body that you can save to use in the next call made to the API. If no parameters are provided, the API will use the default values indicated in the schema. For example: 
{
	"limit": 100,
	"start_time": "2023-03-15T16:32:50-03:00",
	"end_time": "2023-03-15T17:32:50-03:00"
}

​
Cursor

The cursor is a persistent checkpoint that marks your exact position in the event stream and remains valid across API sessions. For continued calling of the API, you should save the cursor you receive from each response. In your next call to the API, include the cursor from the previous response in the request body to start fetching data from the last indicated position. This allows you to resume from where you left off without missing any events. 
{
	"cursor": "aGVsbG8hIGlzIGl0IG1lIHlvdSBhcmUgbG9va2luZyBmb3IK"
}
The 1Password Events API apps for Splunk and Elastic will automatically store the cursor position for future requests.