Sign in
Runs

List runs for a function

Changed on

Lists runs for one function in the authenticated environment

get/apps/{appId}/functions/{functionId}/runs

Request

  • Base URL: https://api.inngest.com/v2
  • URL: https://api.inngest.com/v2/apps/{appId}/functions/{functionId}/runs
  • Auth: API key in header Authorization

Path parameters

appIdstring required
functionIdstring required

Query parameters

includeOutputboolean
cursorstring

Pagination cursor from previous response

limitinteger

Number of runs to return per page (min: 1, max: 100)

fromstring date-time

Inclusive start of the run time range

untilstring date-time

Inclusive end of the run time range

timeFieldstring

Run timestamp field used for filtering and ordering. Accepts queuedAt, startedAt, or endedAt. Snake case aliases such as QUEUED_AT, STARTED_AT, and ENDED_AT are also accepted.

statusstring[]

Statuses to include, using response status values such as COMPLETED, FAILED, RUNNING, QUEUED, CANCELLED, SKIPPED, or PAUSED

isDeferredboolean

Whether to include only deferred or non-deferred runs

orderstring

Sort direction. Accepts ASC or DESC.

querystring

CEL expression used to filter runs by event, output, or error data

includestring[]

Optional run expansions. Supported values: deferred_from.

Response

A successful response.

Changes

  • deac882d457cRevision changes
    • ●

      added the new PAUSED enum value to the // response property for the response status

    • ●

      added the new SKIPPED enum value to the // response property for the response status

    • ●

      added the new UNKNOWN enum value to the // response property for the response status

    • ○

      added the new optional query request parameter include

    • ○

      added the new optional query request parameter query

    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property /// to the response with the status

    • ○

      added the optional property // to the response with the status