---
title: "GET /polling/executions"
method: GET
path: "/polling/executions"
---

# GET /polling/executions

`GET /polling/executions`

This endpoint is used to regularly poll for new executions that have been processed by Stedi.

You must define one of `startDateTime` or `pageToken` when making a request.

You may optionally define a `pageSize`. The minimum `pageSize` is 1, and the maximum `pageSize` is 1000. The default is 100.

`startDateTime` takes a string in ISO 8601 format. (ex: `2023-08-10T18:00:00Z`). 
`startDateTime` must be set to at least 1 minute in the past.

The results will contain executions that occurred after this `startDateTime`. Starting from the oldest to newest executions ordered by the `processedAt` field. Note, this is _exclusive_ of the `startDateTime`, a execution occuring at exactly `2023-08-10T18:00:00Z` for instance, would not be included. In addition, there is a 15 second window where newly created executions will not be included to account for any network latency or clock drifts within the systems to ensure you do not miss any executions.

Each request will _always_ return a `nextPageToken`, regardless of whether there are new executions or not.

We DO NOT recommend trying to roll your own polling strategy leveraging `startDateTime` only. There are edge cases around two executions occuring at the _exact_ same time and being on the edge of a pagination which could cause you to miss one due to the exclusive nature of `startDateTime`. We recommend using `pageToken`'s instead.

When making subsequent polling requests (not initiating with `startDateTime`), the `pageToken` can be used to continue iterating through pages of executions. Usage of the `pageToken` guaruntees you will not miss any executions on the stream. If at any point there are no more new executions in the `item` array, you will still receive a `nextPageToken`. Continue to use this token to poll for new executions. Once there are new executions, they will be returned in the `item` array.

`pageToken`'s you have retrieved can serve as checkpoints. They do not expire, and you can always start from that point in the execution stream again if you need to catch a system up or recover from a failure. Storing `pageToken`'s as part of your polling process is encouraged.

`pageToken`'s are unique per request, opaque, and should not be parsed or modified in any way. They are not guaranteed to be in any particular format, and may change in the future.

## Query parameters

- `pageSize` number — The maximum number of elements to return in a page. You can set this to a maximum of 500 elements. If not specified, the default is 100.
- `pageToken` string — A token returned by a previous call to this operation in the `nextPageToken`. If not specified, Stedi returns the first page of results.
- `startDateTime` string, date-time — An ISO 8601 formatted string. For example `2023-08-28T00:00:00Z`. Stedi returns executions processed after this time.

## Response `200`

ListPollingExecutions 200 response

- ListPollingExecutionsResponseContent
  - `nextPageToken` string — The token used for pagination
  - `items` ExecutionSummary[], required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `executionId` string, required
    - `status` 'COMPLETED' | 'PARTIALLY_COMPLETED' | 'FAILED' | 'IGNORED' | 'IN_PROGRESS' | 'RETRYING' | 'RETRIED' | 'STARTED', required
    - `direction` 'INBOUND' | 'OUTBOUND' | 'UNKNOWN', required
    - `transactionCount` number
    - `faultCount` number
    - `faultCode` 'DELIVERY_FAILURE' | 'FAILED_TO_EXTRACT_BUSINESS_IDENTIFIERS' | 'FAILED_TO_FIND_GUIDE' | 'FAILED_TO_FIND_LOCAL_PROFILE' | 'FAILED_TO_FIND_PARTNER_PROFILE' | 'FAILED_TO_FIND_PARTNERSHIP' | 'FAILED_TO_FIND_PROFILES' | 'FAILED_TO_FIND_RECEIVER_PROFILE' | 'FAILED_TO_FIND_SENDER_PROFILE' | 'FAILED_TO_FIND_CONNECTION' | 'FAILED_TO_GENERATE_CONTROL_NUMBERS' | 'FAILED_TO_PARSE' | 'FAILED_TO_PARSE_METADATA' | 'FAILED_TO_TRANSLATE' | 'FAILED_TO_ACK' | 'FAILED_TO_ACK_INTERCHANGE' | 'FILE_NOT_FOUND' | 'INVALID_EVENT' | 'INVALID_CONFIGURATION' | 'MISMATCHED_PARTNERSHIP_CONNECTION' | 'MISSING_FUNCTIONAL_GROUP_CONTROL_NUMBER' | 'MISSING_FUNCTIONAL_GROUP_RELEASE' | 'MISSING_INTERCHANGE_CONTROL_NUMBER' | 'MISSING_TRANSACTION_SET_CONTROL_NUMBER' | 'MISSING_RECEIVER_ID' | 'MISSING_RECEIVER_QUALIFIER' | 'MISSING_SENDER_ID' | 'MISSING_SENDER_QUALIFIER' | 'MULTIPLE_MATCHING_GUIDES' | 'MULTIPLE_MATCHING_TRANSACTION_SETTINGS' | 'MULTIPLE_PARTNERSHIPS' | 'NO_TRANSLATION_OUTPUT' | 'NO_TRANSACTION_SETS' | 'NOT_SUPPORTED' | 'NO_FUNCTIONAL_GROUPS' | 'NO_USAGE_INDICATOR_CODE' | 'PREVIOUSLY_RETRIED' | 'TRANSLATION_ERROR' | 'UNKNOWN_ERROR'
    - `faultMessage` string
    - `fileType` 'CSV' | 'EDI/EDIFACT' | 'FILEPART' | 'JSON' | 'PSV' | 'JSON/STEDI-GUIDE' | 'TSV' | 'UNKNOWN' | 'EDI/X12' | 'XML' | 'ZIP'
    - `retryable` boolean
    - `parentExecutionId` string
    - `childExecutionId` string
    - `partnershipId` string — Identifier chosen by the user to uniquely identify a partnership.
    - `connectionType` 'bucket' | 'remote-ftp' | 'stedi-ftp' | 'as2'
    - `connectionId` string — Autogenerated identifier for a connection
    - `source` ExecutionSource
      - `dirname` string, required
      - `name` string, required
    - `operation` string

## Other responses

- `400` — ResourceUnderChangeException 400 response
- `401` — UnauthorizedException 401 response
- `403` — AccessDeniedException 403 response
- `404` — ResourceNotFoundException 404 response
- `429` — ThrottlingException 429 response
- `500` — ServiceException 500 response
- `503` — ServiceUnavailableException 503 response
- `504` — GatewayTimeoutException 504 response

## Changes

- **2025-02-28** `2e4ed843c334` — 1 info
  - added the required property `items/items/source/dirname` to the response with the `200` status
- **2024-12-18** `6e04e598f826` — 1 info
  - the `items/items/partnershipId` response's property pattern was changed from `^([a-zA-Z0-9_-]+)$` to `^([a-zA-Z0-9._-]+)$` for the status `200`

[Change history](https://skmtc.dev/stedi/apis/core/changes/polling/executions/get.md)

---

[API](https://skmtc.dev/stedi/apis/core.md) · [All operations](https://skmtc.dev/stedi/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/stedi/core/revisions/4446f4193c6b/schema)
