# FareHarbor Integration Center Home API

**Canonical:** https://apis.io/apis/fareharbor/fareharbor-integration-center-home-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 Integration Center Home API is one of 2 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. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

FareHarbor Integration Center Home API: 31 operations.

## Operations (31)

| Method | Path | Summary |
|---|---|---|
| GET | `/companies/\Z` | Companies |
| GET | `/companies/<company-shortname>/` | Company |
| GET | `/companies/<shortname>/users/` | Company Users |
| PUT | `/companies/<shortname>/checkin/` | Checkin Qr Code |
| GET | `/companies/<company-shortname>/checkin-statuses/` | Checkin Statuses |
| GET | `/companies/<shortname>/lodgings/` | Lodgings |
| GET | `/companies/<shortname>/availabilities/<availability.pk>/lodgings/` | Availability Lodgings |
| GET | `/companies/<affiliate-shortname>/agents/` | Agents |
| GET | `/companies/<affiliate-shortname>/desks/` | Desks |
| GET | `/companies/<shortname>/items/` | Items |
| GET | `/companies/<shortname>/items/<item.pk>/` | Item |
| GET | `/companies/<shortname>/availabilities/<availability.pk>/` | Availability |
| GET | `/companies/<shortname>/items/<item.pk>/minimal/availabilities/date/<date>/` | Minimal Availabilities By Date |
| GET | `/companies/<shortname>/items/<item.pk>/minimal/availabilities/date-range/<start-date>/<end-date>/` | Minimal Availabilities By Date Range |
| GET | `/companies/<shortname>/availabilities/<availability.pk>/bookings/` | Bookings |
| POST | `/companies/<shortname>/availabilities/<availability.pk>/bookings/` | Bookings |
| POST | `/companies/<shortname>/availabilities/<availability.pk>/bookings/validate/` | Validate |
| GET | `/companies/<shortname>/bookings/<Booking.uuid>/` | Booking |
| DELETE | `/companies/<shortname>/bookings/<Booking.uuid>/` | Booking |
| PUT | `/companies/<shortname>/bookings/<Booking.uuid>/note/` | Update Booking Note |
| PUT | `/companies/<shortname>/bookings/<Booking.uuid>/customer-custom-field-values/<custom_field_value.pk>/` | Update Customer Custom Field Value |
| PATCH | `/companies/<shortname>/bookings/<Booking.uuid>/resource-uses/<resource_use.pk>/` | Update Resource Use |
| PUT | `/companies/<shortname>/bookings/<Booking.uuid>/checkin/` | Checkin Booking |
| GET | `/companies/<shortname>/minimal/bookings-by-create-date/<date>/` | Bookings By Create Date |
| POST | `/bookings/resend-confirmation-email/` | Resend Confirmation Email |
| GET | `/companies/<shortname>/availabilities/<availability.pk>/crew-members/` | Crew Members |
| POST | `/companies/<shortname>/availabilities/<availability.pk>/crew-members/` | Crew Members |
| PATCH | `/companies/<shortname>/availabilities/<availability.pk>/crew-members/(?P<crew_member_id>\d+)/` | Crew Member |
| DELETE | `/companies/<shortname>/availabilities/<availability.pk>/crew-members/(?P<crew_member_id>\d+)/` | Crew Member |
| GET | `/companies/<shortname>/roles/` | Roles |
| GET | `/ping/\Z` | Ping |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/fareharbor/refs/heads/main/openapi/_original/fareharbor-home-openapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fareharbor/refs/heads/main/json-schema/fareharbor-booking-with-resource-uses-response-json-schema-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fareharbor/refs/heads/main/json-schema/fareharbor-booking-with-payments-response-json-schema-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fareharbor/refs/heads/main/json-schema/fareharbor-booking-response-json-schema-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fareharbor/refs/heads/main/json-schema/fareharbor-items-response-json-schema-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fareharbor/refs/heads/main/json-schema/fareharbor-item-response-json-schema-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/fareharbor/refs/heads/main/json-schema/fareharbor-availability-response-json-schema-schema.json

## Other FareHarbor APIs (1)

- [FareHarbor Integration Center](https://apis.io/apis/fareharbor/fareharbor-integration-center/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/fareharbor/fareharbor-integration-center-home-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/fareharbor/.