Sign in

v1

latestOpenAPI 3.0.02026-07-2475182625.5 KB
Events

List all processed events

Returns a list of processed events within a specific time range.

get/events/processed

Query parameters

daysinteger required

The number of days for which the data is requested, with a maximum of 30 days. The /events endpoint does not return events that are more than 30 days old.

beginstring date

Filters results to include events after the specified begin date (in YYYY-MM-DD format). Must be at least one day before the specified end date.

endstring date

Filters results to include events before the specified end date (in YYYY-MM-DD format).

Response

OK

actionstring

The action performed by the API.

resultstring

The result of the action (e.g., success or error).

pageinteger

Current page of results, if pagination is used.

limitinteger

Maximum number of results per page, if pagination is used.

nextPageinteger

The next page number of results returned.

totalinteger

Total number of events returned in the response.

moreboolean

Indicates if there are more results available. The response will return up to 25 unique events. If there are more than 25 results, the return contains a "more" attribute.

Example response

{
  "action": "events.get",
  "result": "success",
  "page": 1,
  "limit": 50,
  "total": 1,
  "events": [
    {
      "id": "ABCDEFGHIJK1LMNOPQR2STUV3WXYZAB",
      "processed": true,
      "created": 1729545999690,
      "type": "account.updated",
      "live": true,
      "data": {
        "id": "abcDEFgHiJklM1N-3OP9qRST",
        "account": "abcDEFgHiJklM1N-3OP9qRST",
        "contact": {
          "first": "First",
          "last": "Last",
          "email": "first.last@domain.com",
          "company": "Company Name",
          "phone": "555-555-5555",
          "subscribed": true
        },
        "address": {
          "addressLine1": "123 Main Street",
          "addressLine2": "Apt. 456",
          "city": "Santa Barbara",
          "country": "US",
          "region": "US-CA",
          "company": "Company Name"
        },
        "language": "en",
        "country": "US",
        "lookup": {
          "global": "ab-Cd9e8F6ghiJ-Okl3M3n"
        },
        "url": "https://user.test.onfastspring.com/account"
      },
      "event": "ABCDEFGHIJK1LMNOPQR2STUV3WXYZAB"
    }
  ],
  "data": [
    {
      "id": "ABCDEFGHIJK1LMNOPQR2STUV3WXYZAB",
      "processed": true,
      "created": 1729545999690,
      "type": "account.updated",
      "live": true,
      "data": {
        "id": "abcDEFgHiJklM1N-3OP9qRST",
        "account": "abcDEFgHiJklM1N-3OP9qRST",
        "contact": {
          "first": "First",
          "last": "Last",
          "email": "first.last@domain.com",
          "company": "Company Name",
          "phone": "555-555-5555",
          "subscribed": true
        },
        "address": {
          "addressLine1": "123 Main Street",
          "addressLine2": "Apt. 456",
          "city": "Santa Barbara",
          "country": "US",
          "region": "US-CA",
          "company": "Company Name"
        },
        "language": "en",
        "country": "US",
        "lookup": {
          "global": "ab-Cd9e8F6ghiJ-Okl3M3n"
        },
        "url": "https://user.test.onfastspring.com/account"
      }
    }
  ]
}