GET
/
api
/
schedules
/
{scheduleId}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

scheduleId
string
required

ID of the schedule to retrieve

Response

200 - application/json
id
string

ID of the schedule

flow
object[]

Flow of content to be sent

sendAt
string

Date and time at which the schedule is to be sent

sentAt
string

Date and time at which the schedule was sent (nullable)

contactId
string

ID of the associated contact

ticketId
string

ID of the associated ticket (nullable)

userId
string

ID of the user who created the schedule

status
string

Status of the schedule

companyId
string

ID of the company associated with the schedule

flowId
string

ID of the associated flow (nullable)

sequenceId
string

ID of the associated sequence (nullable)

sequenceStageId
string

ID of the associated sequence stage (nullable)

whatsappId
string

ID of the associated WhatsApp connection

createdAt
string

Date and time at which the schedule was created

updatedAt
string

Date and time at which the schedule was last updated

contact
object

Information about the associated contact

user
object

Information about the user who created the schedule

typebotFlow
string

Typebot flow associated with the schedule (nullable)