Skip to content
API Reference
/
/
Retrieve SendingEvents So...

Retrieve SendingEvents Sorted by Ascending Start Date and Filters

Request

Retrieve SendingEvents sorted by ascending startDate. By default, the response contains the 100 (maxItems property) first items. To retrieve the next items matching the request, use the query parameter 'after' with the ID of the last item

Security
api_key
Query
jobIdstring

Filter for SendingEvents belonging to a specific Job

jobNamestring

Filter for SendingEvents belonging to Jobs with a given name

workflowIdstring

Filter for SendingEvents using a specific Workflow

workflowNamestring

Filter for SendingEvents built using specific Workflows. Note that the workflowName is captured at the creation of the SendingEvent. Further changes (ex. name) of the Workflow are not updated in the SendingEvents

technicalStatusstring

Filter for SendingEvents with specific status

Enum:"IN_PROGRESS""SUCCESS""WARNING""FAILURE"
businessStatusstring

Filter for SendingEvents with specific businessStatus

Enum:"NOT_STARTED""SCHEDULED_FOR_EXECUTION""IN_PROGRESS""SUCCESS""FAILURE""REJECTED"
fromstring, (date-time)

Filter for SendingEvents with startDate greater than a specific datetime expressed in UTC timezone (format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

untilstring, (date-time)

Filter for SendingEvents with startDate less than a specific datetime expressed in UTC timezone (format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

afterstring

Cursor for pagination. Indicates that the API should return the SendingEvents which are immediately after this one in the list (the next page)

maxItemsnumber, [ 1 .. 1000 ]

Maximum number (1 - 1000) of Sending Events that might be returned. It is possible that the response contains fewer elements. Default to 100

Default:100
Headers
x-managed-company-idstring

Optional: the ID of the managed company on behalf of which the request is made

curl -i -X GET \
  'https://doc.acc.connect.easypost.eu/_mock/public-api/openapi/sending-events?jobId=string&jobName=string&workflowId=string&workflowName=string&technicalStatus=IN_PROGRESS&businessStatus=NOT_STARTED&from=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z&after=string&maxItems=100' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Successful response with a list of SendingEvents

Bodyapplication/json
itemsArray of objects(SendingEventResponseDto)required

Array of items for the current page

totalItemsnumberrequired

Total number of items available (without pagination)

Response
{
  "items": [
    { … }
  ],
  "totalItems": 0
}