Events

List Events

List all events corresponding to your Chariot account.

get/v1/events

Query parameters

limitinteger

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

cursorstring

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

category'grant.created' | 'grant.updated' | 'unintegrated_grant.created' | 'unintegrated_grant.updated' | 'donor_account.created' | 'donor_account.updated' | 'authorization_token.created' | 'authorization_token.updated' | 'grant_request.created' | 'grant_request.updated' | 'disbursement.created' | 'disbursement.updated' | 'inbound_transfer.created' | 'inbound_transfer.updated' | 'donation.created' | 'donation.updated' | 'deposit.created' | 'deposit.updated' | 'verification_request.created' | 'verification_request.updated'

The category of the event. This is useful for filtering events.

Event names follow the pattern {resource}.{event_type} where event_type is either created or updated. Status transitions (for example, a Donor Account moving to approved or rejected) are emitted as {resource}.updated events — fetch the object to read its current status.

Filter Events for those with the specified category.

Response

The response for Events.list

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.

Example response

{
  "results": [
    {
      "id": "203c4e56-5c39-4a66-abcd-2ec8af99a1b9",
      "created_at": "2024-01-19T18:48:56.37Z",
      "associated_object_id": "4d06d393-1f14-46cf-b02d-8db17d7ed06a",
      "associated_object_type": "grant"
    }
  ]
}

Changes

Changed in 7 of the 41 revisions of this API.241450

  • b87f7738d336820See the full diff
    • removed the required property code from the response with the 400 status

      response-required-property-removed

    • removed the required property code from the response with the 401 status

      response-required-property-removed

    • removed the required property code from the response with the 403 status

      response-required-property-removed

    • removed the required property code from the response with the 500 status

      response-required-property-removed

    • removed the required property message from the response with the 400 status

      response-required-property-removed

    • removed the required property message from the response with the 401 status

      response-required-property-removed

    • removed the required property message from the response with the 403 status

      response-required-property-removed

    • removed the required property message from the response with the 500 status

      response-required-property-removed

    • media type application/json was changed to a more specific media type application/problem+json for the response status 400

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 401

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 403

      response-media-type-name-specialized

    • media type application/json was changed to a more specific media type application/problem+json for the response status 500

      response-media-type-name-specialized

    • added the required property detail to the response with the 400 status

      response-required-property-added

    • added the required property detail to the response with the 401 status

      response-required-property-added

    • added the required property detail to the response with the 403 status

      response-required-property-added

    • added the required property detail to the response with the 500 status

      response-required-property-added

    • added the required property status to the response with the 400 status

      response-required-property-added

    • added the required property status to the response with the 401 status

      response-required-property-added

    • added the required property status to the response with the 403 status

      response-required-property-added

    • added the required property status to the response with the 500 status

      response-required-property-added

    • added the required property title to the response with the 400 status

      response-required-property-added

    • added the required property title to the response with the 401 status

      response-required-property-added

    • added the required property title to the response with the 403 status

      response-required-property-added

    • added the required property title to the response with the 500 status

      response-required-property-added

    • added the required property type to the response with the 400 status

      response-required-property-added

    • added the required property type to the response with the 401 status

      response-required-property-added

    • added the required property type to the response with the 403 status

      response-required-property-added

    • added the required property type to the response with the 500 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the optional property details from the response with the 400 status

      response-optional-property-removed

    • removed the optional property details from the response with the 401 status

      response-optional-property-removed

    • removed the optional property details from the response with the 403 status

      response-optional-property-removed

    • removed the optional property details from the response with the 500 status

      response-optional-property-removed

    • added the optional property details/items/debug to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/debug to the response with the 500 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/type to the response with the 500 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 400 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 401 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 403 status

      response-optional-property-added

    • added the optional property details/items/value to the response with the 500 status

      response-optional-property-added

  • 90671617b825124See the full diff
    • the code response's property type/format changed from number/ to string/ for status 400

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 401

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 403

      response-property-type-changed

    • the code response's property type/format changed from number/ to string/ for status 500

      response-property-type-changed

    • removed the required property error from the response with the 400 status

      response-required-property-removed

    • removed the required property error from the response with the 401 status

      response-required-property-removed

    • removed the required property error from the response with the 403 status

      response-required-property-removed

    • removed the required property error from the response with the 500 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 400 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 401 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 403 status

      response-required-property-removed

    • removed the required property timestamp from the response with the 500 status

      response-required-property-removed

    • added the optional property details to the response with the 400 status

      response-optional-property-added

    • added the optional property details to the response with the 401 status

      response-optional-property-added

    • added the optional property details to the response with the 403 status

      response-optional-property-added

    • added the optional property details to the response with the 500 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 4f143792edeb145See the full diff
    • removed the enum value donor_account.rejected from the query request parameter category

      request-parameter-enum-value-removed

    • added the new authorization_token.created enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new authorization_token.updated enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new grant_request.created enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new grant_request.updated enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new enum value authorization_token.created to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value authorization_token.updated to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value grant_request.created to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value grant_request.updated to the query request parameter category

      request-parameter-enum-value-added

    • removed the donor_account.rejected enum value from the results/items/category response property for the response status 200

      response-property-enum-value-removed

  • 412b6fc0ed4e33See the full diff
    • removed the enum value donor_account.approved from the query request parameter category

      request-parameter-enum-value-removed

    • removed the enum value grant.approved from the query request parameter category

      request-parameter-enum-value-removed

    • removed the enum value grant.rejected from the query request parameter category

      request-parameter-enum-value-removed

    • removed the donor_account.approved enum value from the results/items/category response property for the response status 200

      response-property-enum-value-removed

    • removed the grant.approved enum value from the results/items/category response property for the response status 200

      response-property-enum-value-removed

    • removed the grant.rejected enum value from the results/items/category response property for the response status 200

      response-property-enum-value-removed

    • added the new donor_account.approved enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new donor_account.created enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new donor_account.rejected enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new donor_account.updated enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new grant.approved enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new grant.rejected enum value to the results/items/category response property for the response status 200

      response-property-enum-value-added

    • added the new enum value donor_account.approved to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value donor_account.created to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value donor_account.rejected to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value donor_account.updated to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value grant.approved to the query request parameter category

      request-parameter-enum-value-added

    • added the new enum value grant.rejected to the query request parameter category

      request-parameter-enum-value-added