List scheduled events

GET 
/ai/assistants/:assistant_id/scheduled_events

Get scheduled events for an assistant with pagination and filtering

Path Parameters

assistant_id Assistant Idrequired

Query Parameters

page[size] Page[Size]

Possible values: >= 1 and <= 100

Default value: 20

page[number] Page[Number]

Possible values: >= 1

Default value: 1

from_date date-time
to_date date-time
conversation_channel ConversationChannelType

Possible values: [phone_call, sms_chat]

200: Successful Response

application/json

• Schema
• Example (from schema)

Schema

meta

object

required

total_pages integerrequired

total_results integerrequired

page_number integerrequired

page_size integerrequired

data

object[]

required

Array [

anyOf

• ScheduledPhoneCallEventResponse
• ScheduledSmsEventResponse

telnyx_conversation_channel ConversationChannelType (string)required

Possible values: [phone_call, sms_chat]

telnyx_end_user_target Telnyx End User Target (string)required

telnyx_agent_target Telnyx Agent Target (string)required

scheduled_at_fixed_datetime date-timerequired

assistant_id Assistant Id (string)required

retry_count Retry Count (integer)

Default value: 0

retry_attempts Retry Attempts (integer)

scheduled_event_id Scheduled Event Id (string)

conversation_id Conversation Id (string)

created_at date-time

status EventStatus (string)

Possible values: [pending, in_progress, completed, failed]

conversation_metadata

object

property name*

object

anyOf

• MOD1
• MOD2
• MOD3

string

integer

boolean

errors string[]

telnyx_conversation_channel ConversationChannelType (string)required

Possible values: [phone_call, sms_chat]

telnyx_end_user_target Telnyx End User Target (string)required

telnyx_agent_target Telnyx Agent Target (string)required

scheduled_at_fixed_datetime date-timerequired

assistant_id Assistant Id (string)required

retry_count Retry Count (integer)

Default value: 0

text Text (string)required

scheduled_event_id Scheduled Event Id (string)

conversation_id Conversation Id (string)

created_at date-time

status EventStatus (string)

Possible values: [pending, in_progress, completed, failed]

conversation_metadata

object

property name*

object

anyOf

• MOD1
• MOD2
• MOD3

string

integer

boolean

errors string[]

]

{
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  },
  "data": [
    {},
    {}
  ]
}

422: Validation Error

application/json

• Schema
• Example (from schema)

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

• MOD1
• MOD2

string

integer

]

msg Message (string)required

type Error Type (string)required

]

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/ai/assistants/:assistant_id/scheduled_events' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 422

---

{
  "meta": {
    "total_pages": 0,
    "total_results": 0,
    "page_number": 0,
    "page_size": 0
  },
  "data": [
    {},
    {}
  ]
}

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}