Retrieve Jobs Sorted by Ascending StartDate and Filters

Request

Retrieve Jobs 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

fromstring, (date-time)

Filter for Jobs 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 Jobs with startDate less than a specific datetime expressed in UTC timezone (format: yyyy-MM-dd'T'HH:mm:ss.SSS'Z')

workflowIdstring

Filter for Jobs using a specific Workflow

afterstring

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

maxItemsnumber, [ 1 .. 1000 ]

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

Default:100

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/jobs?from=2019-08-24T14%3A15%3A22Z&until=2019-08-24T14%3A15%3A22Z&workflowId=string&after=string&maxItems=100' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-managed-company-id: string'

Responses

Bodyapplication/json

itemsArray of objects(JobDto)required

Array of items for the current page

totalItemsnumberrequired

Total number of items available (without pagination)

Response

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