Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apifycloud.io/llms.txt

Use this file to discover all available pages before exploring further.

Endpoint

GET https://api.apifycloud.io/api/v1/video/{appId}/scheduled-calls

Authentication

Bearer token required. Scope: scheduling:read

Path parameters

  • appId (UUID, required)

Query parameters

  • agentId (string, optional) filter to a single assigned agent
  • status (string, optional) comma-separated: scheduled, pending_confirmation, confirmed, cancelled, completed, no_show
  • bookingSource (string, optional) comma-separated: admin, agent, public_booking, api
  • dateFrom (string, optional) ISO-8601 inclusive lower bound on scheduled_at
  • dateTo (string, optional) ISO-8601 exclusive upper bound on scheduled_at
  • search (string, optional) substring match across guest_name / guest_email / guest_phone
  • limit (number, optional) 1–200, default 50
  • offset (number, optional) default 0

Response

{
  "data": {
    "calls": [
      {
        "id": "uuid",
        "app_id": "uuid",
        "assigned_agent_id": "uuid",
        "booking_source": "api",
        "guest_name": "Jane Doe",
        "guest_phone": "+57 300 555 0100",
        "guest_email": "jane@example.com",
        "guest_timezone": "America/Bogota",
        "scheduled_at": "2026-05-01T15:00:00.000Z",
        "duration_minutes": 30,
        "app_timezone": "America/Bogota",
        "status": "scheduled",
        "created_at": "2026-04-22T12:00:00.000Z"
      }
    ]
  },
  "pagination": {
    "total": 120,
    "limit": 50,
    "offset": 0,
    "hasMore": true
  }
}

Errors

  • 403 forbidden unauthorized for app or missing scope
  • 400 validation_error invalid query parameters
  • 429 rate_limit_exceeded
  • 500 server_error

Example

curl "https://api.apifycloud.io/api/v1/video/{appId}/scheduled-calls?status=scheduled,confirmed&dateFrom=2026-05-01T00:00:00Z&limit=50" \
  -H "Authorization: Bearer {access_token}"