Small Improvements · Example Payload

Getmaileventsforcompanyusingget Example

GET /v2/email-events/{companyId}

email-event-resource

Getmaileventsforcompanyusingget Example is an example object payload from Small Improvements, with 8 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summaryoperationIdmethodpathtagsdescriptionparametersresponse

Example Payload

Raw ↑ 
{
  "summary": "getMailEventsForCompany",
  "operationId": "getMailEventsForCompanyUsingGET",
  "method": "GET",
  "path": "/v2/email-events/{companyId}",
  "tags": [
    "email-event-resource"
  ],
  "description": "GET /v2/email-events/{companyId}",
  "parameters": {
    "companyId": "<value>",
    "cursor": "<value>",
    "events": "<value>",
    "fromDate": "<value>",
    "pageSize": "<value>",
    "recipientEmail": "<value>",
    "toDate": "<value>"
  },
  "response": {
    "status": 200,
    "description": "OK"
  }
}