GET
/
events
curl --request GET \
  --url https://api.useswift.dev/events \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "type": "object",
      "title": "Event",
      "description": "Events are records of updates on Swift objects. Events can be accessed via the List Events API or via webhooks configured via Event Subscriptions.",
      "example": {
        "associated_object_id": "account_in71c4amph0vgo2qllky",
        "associated_object_type": "account",
        "created_at": "2020-01-31T23:59:59Z",
        "event_category": "account.created",
        "id": "event_001dzz0r20rzr4zrhrr1364hy80",
        "type": "event"
      },
      "properties": {
        "associated_object_id": {
          "oneOf": [
            {
              "type": "string",
              "description": "The identifier of the object that generated this Event."
            }
          ]
        },
        "associated_object_type": {
          "oneOf": [
            {
              "type": "string",
              "enum": [
                "entity",
                "account",
                "user",
                "user_bank",
                "venmo_account",
                "zelle_account",
                "rtp_request",
                "fednow_request",
                "wire_transfer"
              ],
              "description": "The type of the object that generated this Event.",
              "x-enum-varnames": [
                "Entity",
                "Account",
                "User",
                "User Bank",
                "Venmo Account",
                "Zelle Account",
                "RTP Request",
                "FedNow Request",
                "Wire Transfer"
              ]
            }
          ]
        },
        "created_at": {
          "oneOf": [
            {
              "type": "string",
              "format": "date-time",
              "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Event was created."
            }
          ]
        },
        "event_category": {
          "oneOf": [
            {
              "type": "string",
              "description": "The available categories for Events.",
              "enum": [
                "entity.created",
                "entity.updated",
                "account.created",
                "account.updated",
                "user.created",
                "user.updated",
                "user_bank.created",
                "user_bank.updated",
                "venmo_account.created",
                "venmo_account.updated",
                "venmo_request.created",
                "venmo_request.updated",
                "zelle_account.created",
                "zelle_account.updated",
                "zelle_request.created",
                "zelle_request.updated",
                "rtp_request.created",
                "rtp_request.updated",
                "fednow_request.created",
                "fednow_request.updated",
                "wire_transfer.created",
                "wire_transfer.updated",
                "event_subscription.created",
                "event_subscription.updated"
              ],
              "x-enum-descriptions": [
                "Occurs whenever an Entity is created.",
                "Occurs whenever an Entity is updated.",
                "Occurs whenever an Account is created.",
                "Occurs whenever an Account is updated.",
                "Occurs whenever a User is created.",
                "Occurs whenever a User is updated.",
                "Occurs whenever a User Bank is created.",
                "Occurs whenever a User Bank is updated.",
                "Occurs whenever a Venmo Account is created.",
                "Occurs whenever a Venmo Account is updated.",
                "Occurs whenever a Venmo Request is created.",
                "Occurs whenever a Venmo Request is updated.",
                "Occurs whenever a Zelle Account is created.",
                "Occurs whenever a Zelle Account is updated.",
                "Occurs whenever a Zelle Request is created.",
                "Occurs whenever a Zelle Request is updated.",
                "Occurs whenever a Real-time Payments Request is created.",
                "Occurs whenever a Real-time Payments Request is updated.",
                "Occurs whenever a FedNow Request is created.",
                "Occurs whenever a FedNow Request is updated.",
                "Occurs whenever a Wire Transfer is created.",
                "Occurs whenever a Wire Transfer is updated.",
                "Occurs whenever an Event Subscription is created.",
                "Occurs whenever an Event Subscription is updated."
              ]
            },
            {
              "type": "null",
              "description": "The available categories for Events.",
              "enum": [
                "entity.created",
                "entity.updated",
                "account.created",
                "account.updated",
                "user.created",
                "user.updated",
                "user_bank.created",
                "user_bank.updated",
                "venmo_account.created",
                "venmo_account.updated",
                "venmo_request.created",
                "venmo_request.updated",
                "zelle_account.created",
                "zelle_account.updated",
                "zelle_request.created",
                "zelle_request.updated",
                "rtp_request.created",
                "rtp_request.updated",
                "fednow_request.created",
                "fednow_request.updated",
                "wire_transfer.created",
                "wire_transfer.updated",
                "event_subscription.created",
                "event_subscription.updated"
              ],
              "x-enum-descriptions": [
                "Occurs whenever an Entity is created.",
                "Occurs whenever an Entity is updated.",
                "Occurs whenever an Account is created.",
                "Occurs whenever an Account is updated.",
                "Occurs whenever a User is created.",
                "Occurs whenever a User is updated.",
                "Occurs whenever a User Bank is created.",
                "Occurs whenever a User Bank is updated.",
                "Occurs whenever a Venmo Account is created.",
                "Occurs whenever a Venmo Account is updated.",
                "Occurs whenever a Venmo Request is created.",
                "Occurs whenever a Venmo Request is updated.",
                "Occurs whenever a Zelle Account is created.",
                "Occurs whenever a Zelle Account is updated.",
                "Occurs whenever a Zelle Request is created.",
                "Occurs whenever a Zelle Request is updated.",
                "Occurs whenever a Real-time Payments Request is created.",
                "Occurs whenever a Real-time Payments Request is updated.",
                "Occurs whenever a FedNow Request is created.",
                "Occurs whenever a FedNow Request is updated.",
                "Occurs whenever a Wire Transfer is created.",
                "Occurs whenever a Wire Transfer is updated.",
                "Occurs whenever an Event Subscription is created.",
                "Occurs whenever an Event Subscription is updated."
              ]
            }
          ]
        },
        "id": {
          "oneOf": [
            {
              "type": "string",
              "description": "The Event identifier."
            }
          ]
        }
      },
      "required": [
        "associated_object_id",
        "associated_object_type",
        "created_at",
        "event_category",
        "id"
      ],
      "x-title-plural": "Events",
      "x-tag": "Events"
    }
  ],
  "next_cursor": "Y3Vyc29y"
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
cursor
string

Return the page of entries after this one.

​
limit
integer

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

Required range: 1 <= x <= 100
​
event_category
string

Filter the list of Events by category.

Response

200
application/json
Events

A list of Event objects.

​
data
object[]
required

Events are records of updates on Swift objects. Events can be accessed via the List Events API or via webhooks configured via Event Subscriptions.

​
next_cursor
string | null
required

A pointer to a place in the list.