GET
/
api
/
schedules
/
{scheduleId}
curl --request GET \
  --url https://api.atendai.com/api/schedules/{scheduleId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "flow": [
    {
      "type": "message",
      "content": "<string>",
      "delay": "<string>",
      "fileName": "<string>"
    }
  ],
  "sendAt": "2023-11-07T05:31:56Z",
  "sentAt": "2023-11-07T05:31:56Z",
  "contactId": "<string>",
  "ticketId": "<string>",
  "userId": "<string>",
  "status": "<string>",
  "companyId": "<string>",
  "flowId": "<string>",
  "sequenceId": "<string>",
  "sequenceStageId": "<string>",
  "whatsappId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "contact": {
    "id": "<string>",
    "name": "<string>",
    "number": "<string>",
    "email": "<string>",
    "profilePicUrl": "<string>",
    "isGroup": true,
    "isAdmin": true,
    "isOpen": true,
    "isBotEnabled": true,
    "utmCampaign": "<string>",
    "utmContent": "<string>",
    "utmMedium": "<string>",
    "utmSource": "<string>",
    "utmTerms": "<string>",
    "active": true,
    "channel": "<string>",
    "whatsappId": "<string>",
    "companyId": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>"
  },
  "user": {
    "id": "<string>",
    "name": "<string>"
  },
  "typebotFlow": "<string>"
}

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
Successful response

The response is of type object.