Get Availability

​

Endpoint

​

Authentication

​

Path parameters

• appId (UUID, required)

​

Query parameters

​

Behavior

• Respects existing scheduled calls, blocked agent_availability_exceptions, and agent_dnd_windows.
• available_extra exceptions are honored as positive availability.
• Working hours are enforced by default (respectWorkingHours=true). Pass respectWorkingHours=false if your integration owns its own hours model and only wants the raw conflict data.

​

Caps

• Max 400 candidate slots per request (time window × step × agents). Larger queries return 400 invalid_request.
• No cached results — each call is fresh off the database.

​

Response

{
  "data": {
    "slots": [
      {
        "startUtc": "2026-05-01T14:00:00.000Z",
        "endUtc": "2026-05-01T14:30:00.000Z",
        "agentId": "user_abc"
      },
      {
        "startUtc": "2026-05-01T14:30:00.000Z",
        "endUtc": "2026-05-01T15:00:00.000Z",
        "agentId": "user_abc"
      }
    ]
  }
}

​

Errors

• 400 invalid_request invalid range, duration out of bounds, or too many candidate slots
• 403 forbidden unauthorized for app or missing scope
• 429 rate_limit_exceeded
• 500 server_error

​

Example

curl "https://api.apifycloud.io/api/v1/video/{appId}/availability?fromUtc=2026-05-01T12:00:00Z&toUtc=2026-05-01T20:00:00Z&durationMinutes=30&agentId=user_abc" \
  -H "Authorization: Bearer {access_token}"