List Events | Chariot

List all events corresponding to your Chariot account.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

cursorstringOptional

The cursor to use for pagination. If not set, the first page of results will be returned.

categoryenumOptional

Filter Events for those with the specified category.

Response

The response for Events.list

resultslist of objects

nextPageTokenstring

A cursor token to use to retrieve the next page of results by making another API call to the same endpoint with the same parameters (only changing the pageToken). If specified, then more results exist on the server that were not returned, otherwise no more results exist on the server.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Bearer authentication of the form Bearer <token>, where token is your auth token.

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

The cursor to use for pagination. If not set, the first page of results will be returned.

Filter Events for those with the specified category.

The response for Events.list

1	{
2	"results": [
3	{
4	"id": "203c4e56-5c39-4a66-abcd-2ec8af99a1b9",
5	"category": "grant.created",
6	"created_at": "2024-01-19T18:48:56.37Z",
7	"associated_object_id": "4d06d393-1f14-46cf-b02d-8db17d7ed06a",
8	"associated_object_type": "grant"
9	}
10	],
11	"nextPageToken": "string"
12	}

1	{
2	"results": [
3	{
4	"id": "203c4e56-5c39-4a66-abcd-2ec8af99a1b9",
5	"category": "grant.created",
6	"created_at": "2024-01-19T18:48:56.37Z",
7	"associated_object_id": "4d06d393-1f14-46cf-b02d-8db17d7ed06a",
8	"associated_object_type": "grant"
9	}
10	],
11	"nextPageToken": "string"
12	}

$	curl https://api.givechariot.com/v1/events \
>	-H "Authorization: Bearer <token>"