Unify and manage your data

List schedule executions

Learn more about list schedule executions.

Use the List schedule executions to list the executions of a schedule. This lets you review the run history of a schedule and track each execution.

HTTP method and endpoint

Use the following HTTP method and endpoint path to list schedule executions.

GET {TenantURL}/ai/agentflow/api/v202605/{tenant_id}/schedules/{schedule_id}/conversations

The following table describes the endpoint path parameters.

ParameterTypeRequiredDescription
TenantURLStringYesThe base URL for your tenant.
tenant_idStringYesThe unique identifier of your tenant.
schedule_idStringYesThe unique identifier of the schedule.

Query parameters

The following table describes the query parameters and their values.

ParameterTypeRequiredDescriptionAccepted values / Default
limitIntegerNoThe maximum number of conversations to return per page.Default: 50
page_tokenStringNoThe page token from a previous response. Omit to get the first page.—

Request headers

The following request headers must be included.

HeaderValueRequired
Authorization<access_token>Yes

Request body

This operation does not require a request body.

Example request

Use the following example to see how a complete request is structured, with headers.

GET {TenantURL}/ai/agentflow/api/v202605/tenant-xyz/schedules/example-id/conversations
Authorization: <access_token>

Response body

The following table describes the fields returned in the response body.

ParameterTypeDescription
conversationsArrayThe conversations in the current page of results. Each conversation is one execution of the schedule.
conversations[].conversation_idStringThe unique identifier of the conversation.
conversations[].statusStringThe status of the execution: running, completed, stopped, or failed.
conversations[].started_atStringThe date and time when the execution started.
conversations[].completed_atStringThe date and time when the execution finished. Empty if the execution is still running.
paginationObjectPagination details for this page of results.
pagination.total_countIntegerThe number of items in this page of results.
pagination.next_page_tokenStringThe token to pass as page_token to get the next page of results. Empty when this is the last page.
pagination.limitIntegerThe maximum number of items per page.

Example response

The following example shows a successful response.

{
  "conversations": [
    {
      "conversation_id": "conv-abc123",
      "status": "completed",
      "started_at": "2025-05-13T09:00:00Z",
      "completed_at": "2025-05-13T09:15:30Z"
    }
  ],
  "pagination": {
    "total_count": 50,
    "next_page_token": "eyJvZmZzZXQiOiA1MH0=",
    "limit": 50
  }
}

The following table lists the possible error responses returned by this API.

HTTP statusDescriptionRecommended action
422 Unprocessable EntityValidation ErrorReview the request parameters or body, correct the invalid values, and resend the request.