GET
/
api
/
schedules
/
{scheduleId}

Authorizations

Authorization
string
header
required

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
companyId
string

ID of the company associated with the schedule

contact
object

Information about the associated contact

contactId
string

ID of the associated contact

createdAt
string

Date and time at which the schedule was created

flow
object[]

Flow of content to be sent

flowId
string

ID of the associated flow (nullable)

id
string

ID of the schedule

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)

sequenceId
string

ID of the associated sequence (nullable)

sequenceStageId
string

ID of the associated sequence stage (nullable)

status
string

Status of the schedule

ticketId
string

ID of the associated ticket (nullable)

typebotFlow
string

Typebot flow associated with the schedule (nullable)

updatedAt
string

Date and time at which the schedule was last updated

user
object

Information about the user who created the schedule

userId
string

ID of the user who created the schedule

whatsappId
string

ID of the associated WhatsApp connection