Skip to content
API Docs

availabilities

Fetch availabilities for range

Arguments

appointment_type_ids · [ID] · Array of IDs of appointment types to filter availabilities
availability_provider_id · ID · ID of the provider to show availabilities for, supercedes provider id and is_org
endDate · String · the end date of availability (datetime string)
end_date_padding · Int · Amount of hours after the endDate to pull availabilities in for. This is helpful when using this query with some calendar display libraries
include_suborganizations · Boolean · When true, availability from suborganization providers can be included
startDate · String · the start date of availability (datetime string)
start_date_padding · Int · Amount of hours before the startDate to pull availabilities in for. This is helpful when using this query with some calendar display libraries
organization_id · ID · The ID of the organization to pull availability for. Default to current user organization if not set. Ignored if is_org is false

Returns

[Availability!]

Example 

query availabilities(
  $appointment_location_id: ID
  $appointment_type_id: ID
  $appointment_type_ids: [ID]
  $availability_provider_id: ID
  $contact_type_id: ID
  $endDate: String
  $end_date_padding: Int
  $includeRepeating: Boolean
  $is_org: Boolean
  $is_repeating: Boolean
  $one_time: Boolean
  $provider_id: ID
  $provider_ids: [ID]
  $include_suborganizations: Boolean
  $show_availability: Boolean
  $startDate: String
  $start_date_padding: Int
  $user_id: ID
  $organization_id: ID
  $timezone: String
  $state_license: String
  $tag_ids: [ID]
) {
  availabilities(
    appointment_location_id: $appointment_location_id
    appointment_type_id: $appointment_type_id
    appointment_type_ids: $appointment_type_ids
    availability_provider_id: $availability_provider_id
    contact_type_id: $contact_type_id
    endDate: $endDate
    end_date_padding: $end_date_padding
    includeRepeating: $includeRepeating
    is_org: $is_org
    is_repeating: $is_repeating
    one_time: $one_time
    provider_id: $provider_id
    provider_ids: $provider_ids
    include_suborganizations: $include_suborganizations
    show_availability: $show_availability
    startDate: $startDate
    start_date_padding: $start_date_padding
    user_id: $user_id
    organization_id: $organization_id
    timezone: $timezone
    state_license: $state_license
    tag_ids: $tag_ids
  ) {
    appointment_location_id
    appointment_type_id
    contact_type_id
    day_of_week
    duration_string
    end_on
    id
    is_repeating
    origin_start_date
    range_end
    range_start
    repeating_availability_id
    resourceId
    timezone_abbr
    user
    user_id
  }
}