Get available time slots for a date
Returns future 30-minute slots for the requested date, from 09:00 through 16:30 in the selected timezone.
/api/scheduling/availabilityReturns future 30-minute slots for the requested date, from 09:00 through 16:30 in the selected timezone. date must use YYYY-MM-DD. timezone accepts an IANA zone or fixed UTC offset and defaults to UTC. Slots already confirmed for the same absolute instant are excluded.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
scheduling:read- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
Query Parameters
Date to check availability (YYYY-MM-DD)
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$dateIANA timezone or UTC offset (e.g. Europe/Warsaw, +02:00)
length <= 100Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "date": "2030-06-15", "timezone": "Europe/Warsaw", "data": [ "09:00", "09:30", "10:00" ]}Request examples
curl
curl --request GET \
'https://api.convor.io/api/scheduling/availability?date=2030-06-15' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...'JavaScript
const response = await fetch("https://api.convor.io/api/scheduling/availability?date=2030-06-15", {
method: "GET",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_..."
},
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?