# FareHarbor Availabilities Endpoints API **Canonical:** https://apis.io/apis/fareharbor/fareharbor-availabilities-endpoints-api/ **Provider:** FareHarbor — https://apis.io/providers/fareharbor/ **Base URL:** https://fareharbor.com/api/external/v1 **Documentation:** https://developer.fareharbor.com/api/external/v1/ FareHarbor Availabilities Endpoints API is one of 11 APIs that [FareHarbor](https://apis.io/providers/fareharbor/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Availabilities Endpoints. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas. The `/availabilities` endpoint is used to retrieve all bookable availabilities for a single item within a specified date or date range. The request pulls availability data from the Item calendar of the FareHarbor dashboard. Each individual availability shows a unique PK, which is then used during the booking process, as well as a summary of its related settings, including start/end times, capacity, valid ticket options and their prices, custom fields, party size restrictions, and more. Here the API Partner can gather the relevant PKs that they need to create their booking, and they can use the data on the API to connect and display the bookable dates and times on the product calendars on their end. The more frequently they hit this endpoint, the more accurate their product calendars will be in respect to FareHarbor. Online Booking Status: Each availability has an online booking status, which controls how it can be viewed and booked by online customers. In most cases, the status will be set to `auto`, which automatically prevents online customers from booking after a certain time cutoff, based on [item’s settings](https://help.fareharbor.com/dashboard/items/online-booking-settings/). For a complete description of these statuses and their meaning, go to [https://help.fareharbor.com/dashboard/availabilities/updating/online-booking-status/](https://help.fareharbor.com/dashboard/availabilities/updating/online-booking-status/). Booking Cutoff: The `effective_booking_cutoff` field exposes the last possible moment bookings are allowed for an availability, accounting for the item's online bookability settings and any custom booking restrictions. This field is only included in the response when `?detailed=yes` is passed on the request. **Things to Note:** * API Partners may pull availability at whatever intervals they want, as long as they fall within the rate limit, but we generally recommend that, at minimum, partners pull availability for the next 90 days (in 7 day segments) once per week, for the next 30 days once per day, and for the current day every 2 hours. * The standard availability endpoints will return the fully detailed availability, including custom field information and headlines. If you are not connecting to custom fields, you can include `/minimal` in your request to exclude custom field information from the response. This can also help with performance speed. * We are constantly monitoring our API and optimizing for performance. Depending on the complexity of certain products and how they are configured in our system, availability requests for some products may take longer than others. In these cases it helps to reduce the date range being pulled. * Availability Restrictions: * FareHarbor supports optional party size booking restrictions at the availability level. The following properties will be included for each availability provided by the availability endpoints to indicate applicable restrictions: * `minimum_party_size`: minimum number of customers currently allowed on a booking. * `maximum_party_size`: maximum number of customers currently allowed on a booking. * Note: a number value will be provided for enabled restrictions; a null value will be provided for restrictions that are not enabled. * Customer Type Rate Restrictions: * FareHarbor also supports optional party size booking restrictions at the customer type rate level. The following properties will be included for each customer type rate provided by availability endpoints to indicate applicable restrictions: * `minimum_party_size`: minimum number of the associated customer type allowed in a party. * `maximum_party_size`: maximum number of the associated customer type allowed in a party. * Note: the minimum_party_size restriction only applies when at least one customer of the associated customer type is in the party. * Note: a number value will be provided for enabled restrictions; a null value will be provided for restrictions that are not enabled. * Availability start and end times are in the company's local timezone. When providing a date or date range for availabilities, those dates are taken as local time of the company. ## Operations (4) | Method | Path | Summary | |---|---|---| | GET | `/companies//availabilities//lodgings/` | Availability Lodgings | | GET | `/companies//availabilities//` | Availability | | GET | `/companies//items//minimal/availabilities/date//` | Minimal Availabilities By Date | | GET | `/companies//items//minimal/availabilities/date-range///` | Minimal Availabilities By Date Range | ## Machine-readable artifacts (7) - **OpenAPI** — https://artifacts.apis.io/fareharbor/openapi/fareharbor-availabilities-endpoints-api-openapi.yml - **JSONSchema** — https://artifacts.apis.io/fareharbor/json-schema/fareharbor-booking-with-resource-uses-response-json-schema-schema.json - **JSONSchema** — https://artifacts.apis.io/fareharbor/json-schema/fareharbor-booking-with-payments-response-json-schema-schema.json - **JSONSchema** — https://artifacts.apis.io/fareharbor/json-schema/fareharbor-booking-response-json-schema-schema.json - **JSONSchema** — https://artifacts.apis.io/fareharbor/json-schema/fareharbor-items-response-json-schema-schema.json - **JSONSchema** — https://artifacts.apis.io/fareharbor/json-schema/fareharbor-item-response-json-schema-schema.json - **JSONSchema** — https://artifacts.apis.io/fareharbor/json-schema/fareharbor-availability-response-json-schema-schema.json ## Other FareHarbor APIs (10) - [FareHarbor Integration Center](https://apis.io/apis/fareharbor/fareharbor-integration-center/) - [FareHarbor Bookings Endpoints API](https://apis.io/apis/fareharbor/fareharbor-bookings-endpoints-api/) - [FareHarbor Checkin Endpoints API](https://apis.io/apis/fareharbor/fareharbor-checkin-endpoints-api/) - [FareHarbor Company Endpoints API](https://apis.io/apis/fareharbor/fareharbor-company-endpoints-api/) - [FareHarbor Crew Members Endpoints API](https://apis.io/apis/fareharbor/fareharbor-crew-members-endpoints-api/) - [FareHarbor Items Endpoints API](https://apis.io/apis/fareharbor/fareharbor-items-endpoints-api/) - [FareHarbor Lodging Endpoints API](https://apis.io/apis/fareharbor/fareharbor-lodging-endpoints-api/) - [FareHarbor Ping API](https://apis.io/apis/fareharbor/fareharbor-ping-api/) - [FareHarbor Roles Endpoints API](https://apis.io/apis/fareharbor/fareharbor-roles-endpoints-api/) - [FareHarbor Users Endpoints API](https://apis.io/apis/fareharbor/fareharbor-users-endpoints-api/) ## Tags Availabilities Endpoints --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/fareharbor/fareharbor-availabilities-endpoints-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/fareharbor/.