Skip to main content
GET
/
calendar
/
scheduled
List Scheduled Bots
curl --request GET \
  --url https://api.meestream.ai/api/v1/calendar/scheduled \
  --header 'Authorization: <api-key>'
{
  "scheduled_bots": [
    {
      "bot_id": "<string>",
      "platform": "<string>",
      "status": "<string>",
      "scheduled_join_time": "2023-11-07T05:31:56Z",
      "custom_attributes": {},
      "bot_username": "<string>",
      "is_scheduled": true
    }
  ]
}

​
Overview

Lists all future scheduled bots for the authenticated user. Returns bots that are scheduled to join meetings via calendar events.

​
Request

Endpoint: GET /calendar/scheduled or GET /calendar/schedule Headers: 
Authorization: Token <api_key>
Query Parameters:
ParameterTypeDefaultDescription
limitinteger100Number of bots to return (1-100)

​
Response

​
Success Response (200)

{
  "scheduled_bots": [
    {
      "bot_id": "uuid",
      "platform": "google_meet",
      "status": "Scheduled",
      "scheduled_join_time": "2024-12-20T09:57:00+00:00",
      "custom_attributes": {
        "source": "calendar_schedule_api",
        "event_id": "google_event_id",
        "deduplication_key": "key123"
      },
      "bot_username": "MeetStream Bot",
      "is_scheduled": true
    }
  ]
}

​
Response Fields

FieldTypeDescription
scheduled_botsarrayList of scheduled bots
scheduled_bots[].bot_idstringBot ID
scheduled_bots[].platformstringMeeting platform (google_meet, zoom, microsoft_teams, etc.)
scheduled_bots[].statusstringBot status (e.g., “Scheduled”, “InMeeting”, “Stopped”)
scheduled_bots[].scheduled_join_timeISO 8601When the bot is scheduled to join the meeting
scheduled_bots[].custom_attributesobjectCustom attributes including source, event_id, and deduplication_key
scheduled_bots[].custom_attributes.sourcestringSource of the schedule (e.g., “calendar_schedule_api”)
scheduled_bots[].custom_attributes.event_idstringAssociated calendar event ID
scheduled_bots[].custom_attributes.deduplication_keystringDeduplication key used when scheduling
scheduled_bots[].bot_usernamestringBot display name
scheduled_bots[].is_scheduledbooleanWhether the bot is scheduled (always true for this endpoint)

​
Error Responses

​
400 Bad Request

Invalid limit parameter (must be between 1 and 100).

​
401 Unauthorized

Missing user_id in token or invalid authentication.

​
404 Not Found

User not found.

​
500 Internal Server Error

An error occurred while fetching scheduled bots.

​
Usage Example

GET /calendar/scheduled?limit=50
Returns up to 50 scheduled bots for the authenticated user.
This endpoint only returns bots that are scheduled for future meetings. Bots that have already joined or completed are not included.

Authorizations

​
Authorization
string
header
required

All API endpoints are authenticated using API Keys. The key should be included in the 'Authorization' header, prefixed with 'Token '. Example: 'Authorization: Token YOUR_API_KEY'.

Query Parameters

​
limit
integer
default:100

Number of bots to return (1-100)

Required range: 1 <= x <= 100

Response

Returns the list of scheduled bots.

​
scheduled_bots
object[]
required

List of scheduled bots