> For a complete page index, fetch https://developer.close.com/llms.txt

# Retrieve a list of events

GET https://api.close.com/api/v1/event/

The list of available object types and actions is available [here](https://developer.close.com/api/resources/events/list-of-event-types). The event log can be filtered by the following parameters:

- `date_updated`: The date/time of when the event was last updated, in ISO format. Can be filtered by range (`date_updated__gte=X&date_updated__lte=Y`). Note: For pagination, it is recommended to use cursors instead of this filter (see below).
- `object_type`: If specified, only events for objects of a given type are returned. Example: `object_type=lead`
- `object_id`: If specified, only events for the given object are returned. No related object events are returned. Example: `object_id=lead_123`
- `action`: Only events of specified actions are returned. Example: `action=deleted`
- `lead_id`: If specified, events for the given lead, including any of its related objects (contacts, activities, opportunities, tasks) are returned.
- `user_id`: Only return events of the given user.
- `request_id`: Only events emitted while processing this specific API request.

Only certain combinations of filters are supported. `date_updated` can be optionally used with any allowed filter combination. Supported combinations are:

- `object_type` and `object_id`
- `object_type` and `action`
- `object_id` and `action`
- `lead_id` and `object_type`
- `lead_id`, `object_type` and `action`
- `lead_id`, `user_id` and `object_type`
- `lead_id`, `user_id`, `object_type` and `action`
- `lead_id` and `user_id`
- `user_id` and `object_id`
- `user_id`, `object_id` and `action`
- `user_id` and `object_type`
- `user_id`, `object_type` and `action`
- Just `lead_id`
- Just `user_id`
- Just `request_id`

The response is a dictionary with the following fields:

- `data`: A list of events (dictionaries), using the format outlined in “Event format”.
- `cursor_next`: Cursor string to retrieve the next page of events, i.e. events before the given ID (earlier date), or `null` if no more objects are available.
- `cursor_previous`: Cursor string to retrieve the previous page of events, i.e. events after the given ID (later date), or `null` if no more objects are available.

Events are always ordered by date (latest first), i.e. the `date_updated` field. Note that even though `date_created` and `date_updated` may only have millisecond-precision, two or more events for the same object are guaranteed to be returned in the proper order.

The endpoint supports the following parameters for pagination, and does *not* support `_skip`:

- `_cursor`: Pagination using a cursor string (`cursor_next` or `cursor_previous` from a previous response). Note that you still need to supply any other filters (except for `date_updated`) that were used in the previous query.
- `_limit`: Maximum number of events to return (capped at and defaulting to 50).

Cursors are a reliable way to go to the next or previous page of events (unlike filtering by `date_updated`, where you may need to account for and filter out multiple events happening in the same millisecond). However, cursors are not designed to stream new events: Events may be visible through the API in a different order than they were triggered (but the ordering returned by the API is correct). Also, event consolidation of multiple recent events to the same object may occur. To avoid missing recent events when paginating, we recommend to scan the latest five minutes of events.

In the example response, to retrieve the next older batch of events, specify `_cursor=cursor2`.

Reference: https://developer.close.com/api/resources/events/list

## Authentication

- `Authorization` header (basic auth, required) — Use your API key as the username and leave the password empty.
- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `_limit` (integer, optional, default: 100) — Number of results to return.
- `_skip` (integer, optional, default: 0) — Number of results to skip before returning, for pagination.
- `object_type` (string, optional, nullable)
- `object_id` (string, optional, nullable)
- `lead_id` (string, optional, nullable)
- `action` (string, optional, nullable)
- `user_id` (string, optional, nullable)
- `date_updated__gt` (string, optional, nullable)
- `date_updated__gte` (string, optional, nullable)
- `date_updated__lt` (string, optional, nullable)
- `date_updated__lte` (string, optional, nullable)

## Response

### 200

Successful response

## Errors

### 400 Bad Request Error

Bad request

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 404 Not Found Error

Not found

- `any`

## Examples

**Response**

```json
{
  "cursor_next": "cursor2",
  "cursor_previous": "cursor1",
  "data": []
}
```

**SDK Code**

```python events_list_example
import requests

url = "https://api.close.com/api/v1/event/"

response = requests.get(url, auth=("<CLOSE_API_KEY>", ""))

print(response.json())
```

```javascript events_list_example
const url = 'https://api.close.com/api/v1/event/';
const credentials = btoa("<CLOSE_API_KEY>:");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go events_list_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.close.com/api/v1/event/"

	req, _ := http.NewRequest("GET", url, nil)

	req.SetBasicAuth("<CLOSE_API_KEY>", "")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby events_list_example
require 'uri'
require 'net/http'

url = URI("https://api.close.com/api/v1/event/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request.basic_auth("<CLOSE_API_KEY>", "")

response = http.request(request)
puts response.read_body
```

```java events_list_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.close.com/api/v1/event/")
  .basicAuth("<CLOSE_API_KEY>", "")
  .asString();
```

```php events_list_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.close.com/api/v1/event/', [
  'headers' => [
  ],
    'auth' => ['<CLOSE_API_KEY>', ''],
]);

echo $response->getBody();
```

```csharp events_list_example
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://api.close.com/api/v1/event/");
client.Authenticator = new HttpBasicAuthenticator("<CLOSE_API_KEY>", "");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```