Skip to main content
GET
Get call time windows
Returns the company’s call time window configuration: which directions enforcement is on for, the workspace timezone, and every allowed window grouped by day of week. Calls placed (or received) outside the configured window are gated automatically:
  • Outbound — when outbound_enabled is true and the call falls outside any allowed window, the create-call request returns 202 Accepted with status: "scheduled" and a scheduled_for timestamp marking the next window opening. The platform places the call automatically at that time.
  • Inbound — when inbound_enabled is true and the call lands outside any allowed window, the call is hung up before being answered. No call_logs row is created and no minutes are charged.
A day with no windows is closed for whichever directions are enforced. The default schedule (seeded for every company) is Sunday through Thursday 09:00–19:00 plus Friday 09:00–11:30; Saturday is closed. Any authenticated API key for the workspace can read this — no specific scope is required.

Example request

Example response

day_of_week follows the standard Sunday-first convention: 0 is Sunday, 6 is Saturday. Times are HH:MM in 24-hour notation, evaluated in the workspace timezone (change it in the Company settings tab).

Errors

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Response

200 - application/json

Current configuration

Company-level configuration that gates inbound and outbound calls by time-of-day. When outbound_enabled is true, outbound API requests placed outside any allowed window are deferred — the response is 202 Accepted with status: "scheduled" and a scheduled_for timestamp marking the next window opening. When inbound_enabled is true, inbound calls received outside any allowed window are hung up before being answered (no call_logs row is created).

A day with no windows is a closed day for whichever directions are enforced. The default schedule (seeded for every company) is Sunday through Thursday 09:00–19:00 plus Friday 09:00–11:30; Saturday is closed.

timezone
string

IANA timezone identifier. Reflects companies.timezone. Edit it in the Company settings tab.

Example:

"Asia/Jerusalem"

inbound_enabled
boolean

When true, inbound calls outside the window are hung up before answering. Default false.

outbound_enabled
boolean

When true, outbound calls outside the window are scheduled for the next opening. Default true.

windows
object[]