Rutter Events API

The Events API from Rutter — 1 operation(s) for events.

Operations 1

GET /events List events #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/rutter:rutter-events-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

rutter-events-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Rutter Events API
  version: '2024-08-31'
  description: The Universal API for all major e-commerce platforms, accounting systems, and payment processors.
servers:
- url: https://production.rutterapi.com/versioned
  description: Production server
- url: https://sandbox.rutterapi.com/versioned
  description: Sandbox server
tags:
- name: Events
paths:
  /events:
    get:
      summary: List events
      operationId: listEvents
      parameters:
      - name: access_token
        in: query
        required: true
        description: The access token of the connection.
        schema:
          $ref: '#/components/schemas/ListEventsParams/properties/access_token'
      - name: type
        in: query
        required: true
        description: The type of event to list.
        schema:
          $ref: '#/components/schemas/ListEventsParams/properties/type'
      - name: cursor
        in: query
        required: false
        description: The cursor to use for pagination. Use the value of `next_cursor` provided in a previous response.
        schema:
          $ref: '#/components/schemas/ListEventsParams/properties/cursor'
      - name: limit
        in: query
        required: false
        description: The number of entities to return. Defaults to 500.
        schema:
          $ref: '#/components/schemas/ListEventsParams/properties/limit'
      - name: expand
        in: query
        required: false
        description: Optionally, include raw external platform data when fetching data.
        schema:
          $ref: '#/components/schemas/ListEventsParams/properties/expand'
      - name: last_synced_at_min
        in: query
        required: false
        description: Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        schema:
          $ref: '#/components/schemas/ListEventsParams/properties/last_synced_at_min'
      - name: resources
        in: query
        required: false
        description: 'Comma separated list of resources to query for. If omitted, all resources will be returned. A resource can be one of the following: `ACCOUNT`, `ACCOUNTING_TRANSACTION`, `BANK_DEPOSIT`, `BANK_TRANSFER`, `CLASS`, `COMPANY_INFO`, `CURRENCIES`, `DEPARTMENT`, `EXCHANGE_RATE`, `ITEMS`, `JOURNAL_ENTRY`, `LOCATION`, `PAYMENT_TERM`, `PROJECT`, `SUBSIDIARY`, `TASK`, `TAX_AGENCY`, `TAX_AREA`, `TAX_RATES`, `UPDATED_TRANSACTION`, `ACCOUNTING_CUSTOMER`, `ACCOUNTING_CUSTOMER_REFUND`, `INVOICE`, `INVOICE_CREDIT_MEMO`, `INVOICE_PAYMENT`, `PAYMENT_METHOD`, `SALES_ORDER`, `SALES_RECEIPT`, `BILL`, `BILL_CREDIT_MEMO`, `BILL_PAYMENT`, `PURCHASE_ORDER`, `VENDOR`, `EXPENSE`, `BANK_FEED_ACCOUNT`, `BANK_FEED_CONTACT`, `BANK_FEED_PAYMENT_NETWORK`, `BANK_FEED_TRANSACTION`, `BALANCE_SHEET`, `CASH_FLOW`, `INCOME_STATEMENT`'
        schema:
          $ref: '#/components/schemas/ListEventsParams/properties/resources'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEventResponse'
              examples:
                ListEventResponse_Example:
                  $ref: '#/components/examples/ListEventResponse_Example'
      x-supported-platforms:
      - '*'
      x-sandbox-supported-platforms:
      - NETSUITE
      - QUICKBOOKS
      tags:
      - Events
      x-summary-source: derived
components:
  schemas:
    ListEventsParams:
      type: object
      properties:
        access_token:
          type: string
          format: uuid
          description: The access token of the connection.
        cursor:
          type: string
          description: The cursor to use for pagination. Use the value of `next_cursor` provided in a previous response.
        limit:
          type: integer
          description: The number of entities to return. Defaults to 500.
        expand:
          type: array
          items:
            type: string
            enum:
            - platform_data
          description: Optionally, include raw external platform data when fetching data.
        type:
          type: string
          enum:
          - object_deleted
          description: The type of event to list.
        last_synced_at_min:
          type: integer
          description: Used to filter objects with a `last_synced_at` value greater than or equal to the supplied value. Should be a [Unix time](https://en.wikipedia.org/wiki/Unix_time) in milliseconds.
        resources:
          type: string
          description: 'Comma separated list of resources to query for. If omitted, all resources will be returned. A resource can be one of the following: `ACCOUNT`, `ACCOUNTING_TRANSACTION`, `BANK_DEPOSIT`, `BANK_TRANSFER`, `CLASS`, `COMPANY_INFO`, `CURRENCIES`, `DEPARTMENT`, `EXCHANGE_RATE`, `ITEMS`, `JOURNAL_ENTRY`, `LOCATION`, `PAYMENT_TERM`, `PROJECT`, `SUBSIDIARY`, `TASK`, `TAX_AGENCY`, `TAX_AREA`, `TAX_RATES`, `UPDATED_TRANSACTION`, `ACCOUNTING_CUSTOMER`, `ACCOUNTING_CUSTOMER_REFUND`, `INVOICE`, `INVOICE_CREDIT_MEMO`, `INVOICE_PAYMENT`, `PAYMENT_METHOD`, `SALES_ORDER`, `SALES_RECEIPT`, `BILL`, `BILL_CREDIT_MEMO`, `BILL_PAYMENT`, `PURCHASE_ORDER`, `VENDOR`, `EXPENSE`, `BANK_FEED_ACCOUNT`, `BANK_FEED_CONTACT`, `BANK_FEED_PAYMENT_NETWORK`, `BANK_FEED_TRANSACTION`, `BALANCE_SHEET`, `CASH_FLOW`, `INCOME_STATEMENT`'
      required:
      - access_token
      - type
    Event:
      type: object
      properties:
        id:
          type: string
          description: ID of the event.
        data:
          description: The data of the event.
        resource:
          type: string
          description: The rutter object type.
        type:
          type: string
          enum:
          - object_deleted
          description: The type of the event.
        last_synced_at:
          type: string
          description: The [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp for when this event occurred.
      required:
      - id
      - resource
      - type
      - last_synced_at
      examples:
      - Event_Example:
          $ref: '#/components/examples/Event_Example'
    ListEventResponse:
      type: object
      properties:
        events:
          type: array
          items:
            $ref: '#/components/schemas/Event'
        next_cursor:
          type:
          - string
          - 'null'
      required:
      - events
      examples:
      - ListEventResponse_Example:
          $ref: '#/components/examples/ListEventResponse_Example'
  examples:
    Event_Example:
      value:
        id: 594b751e-500c-45b1-8973-00c9dc7b4698
        data:
          id: 00000000-0000-0000-0000-000000000000
          deleted_at: '2023-01-02T02:34:56.000Z'
        resource: BILL
        type: object_deleted
        last_synced_at: '2023-01-02T02:34:56.000Z'
    ListEventResponse_Example:
      value:
        events:
        - id: 594b751e-500c-45b1-8973-00c9dc7b4698
          data:
            id: 00000000-0000-0000-0000-000000000000
            deleted_at: '2023-01-02T02:34:56.000Z'
          resource: BILL
          type: object_deleted
          last_synced_at: '2023-01-02T02:34:56.000Z'
        next_cursor: MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=