Developers

Availies is being built and is not open for sign-up yet. This page describes the API as it is built, so there are no keys to create today.

One set of operations serves every caller: the admin app with a member's session, a customer's own system with an API key, and an assistant acting for a member. What a member can do in the app, a key or an assistant with the same rights can do through the same operation.

Where to read

The basics

Signing in

Retrying safely

When a request is refused

Every refusal has one shape, RFC 9457 problem details, sent as application/problem+json. A client reads code first, then reason, then the issue paths. It never reads the wording of detail, which is for a person and may change.

Field Type Always sent Notes
type string yes
title string yes
status integer yes
detail string yes
code string yes Values: plan_required , invalid_request , invalid_json , unauthenticated , forbidden , approval_required , no_active_account , not_found , method_not_allowed , version_conflict , conflict , handle_taken , last_owner , id_conflict , slot_taken , request_in_progress , invalid_slot , export_too_large , visitor_data_too_large , payload_too_large , rate_limited , unsupported_media_type , internal_error , sign_in_unavailable , not_configured , provider_unavailable , lookup_unavailable , recovery_hold , handle_renamed_recently .
request_id string yes
issues array of object no
issues[] object yes
issues[].path string yes
issues[].message string yes
reason string no Values: meeting_ended , booking_not_confirmed , already_at_time , outcome_unchanged , meeting_not_started , reschedule_still_finishing , range_not_valid , host_required , collective_not_reassigned , already_with_host , not_restorable , archived , snapshot_unreadable , already_current , route_used , route_expired , link_expired , link_in_use , link_dead , link_changed , already_member , booking_not_possible , not_https , bad_port , ip_literal , special_name , own_zone , does_not_resolve , points_inward , could_not_check , lookup_in_use , address_unverified , sign_up_closed , recent_sign_in_required , bookings_open , handle_mismatch , account_not_active , account_not_suspended , already_closing , not_deleting , account_being_removed , recovery_hold_off .

Codes that call for a decision

Status Code Meaning What the caller does
409 slot_taken Someone else got it. Offer other slots.
409 id_conflict Same client id or retry key, different request. Fix the caller.
409 request_in_progress The same request is still running. Wait as Retry-After says, then retry with the same key.
409 version_conflict The booking changed since you read it. Read it again and decide again.
409 conflict Something else depends on what you are changing. Read the detail and remove the dependency first.
422 invalid_slot The time is not offered. Offer other slots.
503 provider_unavailable A calendar could not be reached. Retry later. Never treat the time as free.
429 rate_limited Too many requests. Wait for Retry-After, in full.

Every code

plan_required , invalid_request , invalid_json , unauthenticated , forbidden , approval_required , no_active_account , not_found , method_not_allowed , version_conflict , conflict , handle_taken , last_owner , id_conflict , slot_taken , request_in_progress , invalid_slot , export_too_large , visitor_data_too_large , payload_too_large , rate_limited , unsupported_media_type , internal_error , sign_in_unavailable , not_configured , provider_unavailable , lookup_unavailable , recovery_hold , handle_renamed_recently

Every reason

Where one code covers several causes a client must tell apart, the body also carries reason, a short code from this closed list.

meeting_ended , booking_not_confirmed , already_at_time , outcome_unchanged , meeting_not_started , reschedule_still_finishing , range_not_valid , host_required , collective_not_reassigned , already_with_host , not_restorable , archived , snapshot_unreadable , already_current , route_used , route_expired , link_expired , link_in_use , link_dead , link_changed , already_member , booking_not_possible , not_https , bad_port , ip_literal , special_name , own_zone , does_not_resolve , points_inward , could_not_check , lookup_in_use , address_unverified , sign_up_closed , recent_sign_in_required , bookings_open , handle_mismatch , account_not_active , account_not_suspended , already_closing , not_deleting , account_being_removed , recovery_hold_off