find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/fareharbor:fareharbor-users-endpoints-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: FareHarbor Integration Center Users Endpoints API
  version: '1.0'
  contact:
    email: support@fareharbor.com
    name: FareHarbor
    url: https://help.fareharbor.com/hc/
  description: The Users endpoints provide access to user information within the context of company operations, specifically for crew management purposes.
servers:
- url: https://fareharbor.com/api/external/v1
  description: production
- url: https://demo.fareharbor.com/api/external/v1
  description: demo
tags:
- name: Users Endpoints
  description: The Users endpoints provide access to user information within the context of company operations, specifically for crew management purposes.
paths:
  /companies/<shortname>/users/:
    get:
      summary: Company Users
      operationId: get-company-users
      deprecated: false
      tags:
      - Users Endpoints
      parameters:
      - $ref: '#/components/parameters/X-FareHarbor-API-App'
      - $ref: '#/components/parameters/X-FareHarbor-API-User'
      - schema:
          type: string
          example: 'hawaiianadventures

            '
        name: shortname
        in: path
        required: true
        description: '

          The shortname of the company.

          '
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/USERS_RESPONSE_JSON_SCHEMA'
        '400':
          $ref: '#/components/responses/BadRequest'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '504':
          $ref: '#/components/responses/GatewayTimeout'
      description: ''
components:
  schemas:
    Codes404:
      type: string
      enum:
      - availability-pk-invalid
      - booking-uuid-invalid
      - company-shortname-invald
      - customer-custom-field-value-pk-invalid
      - item-pk-invalid
    Codes400:
      type: string
      enum:
      - availability-date-range-invalid
      - book-data-parse-error
      - book-data-validation-error
      - bookability-error
      - booking-cancellation-error
      - booking-creation-error
      - booking-custom-field-value-creation-error
      - booking-custom-field-values-invalid
      - booking-note-error
      - contact-error
      - content-type-invalid-error
      - customer-custom-field-value-creation-error
      - customer-custom-field-value-update-error
      - customer-custom-field-values-invalid
      - customer-type-rates-invalid
      - invalid-checkin-already-checked-in
      - invalid-checkin-customer
      - invalid-checkin-status-error
      - invalid-qr-code-error
      - key-missing
      - lodging-pk-invalid
      - no-default-checkin-status-error
      - orderize-booking-uuid-invalid-error
      - payment-error
      - rebooking-uuid-invalid-error
      - resource-bookability-error
      - voucher-number-invalid
      - voucher-number-not-specified
    Codes403:
      type: string
      enum:
      - app-invalid
      - app-key-invalid
      - invalid-checkin-permissions-error
      - orderize-booking-uuid-invalid-error
      - user-key-invalid
    Error400:
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Codes400'
    Error403:
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Codes403'
    Error404:
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            $ref: '#/components/schemas/Codes404'
    USERS_RESPONSE_JSON_SCHEMA:
      $schema: http://json-schema.org/draft-04/schema#
      additionalProperties: false
      definitions:
        user:
          additionalProperties: false
          description: A user created in the Fareharbor Dashboard
          properties:
            name:
              description: The user's full name as it appears in the system.
              example: John Smith
              type: string
            username:
              description: The user's unique username within the system.
              example: jsmith
              type: string
          required:
          - username
          - name
          type: object
      description: Response containing a list of all distinct users created in the FareHarbor Dashboard.
      properties:
        users:
          description: List of all company users.
          items:
            $ref: '#/components/schemas/USERS_RESPONSE_JSON_SCHEMA/definitions/user'
          type: array
      required:
      - users
      title: Users Response
      type: object
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
      - code
      - message
  responses:
    NotFound:
      description: The specified resource was not found (see [Error Codes](#tag/Error-Codes))
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error404'
    Forbidden:
      description: Forbidden (see [Error Codes](#tag/Error-Codes))
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error403'
    TooManyRequests:
      description: Too Many Requests (see [Rate Limits](#tag/Getting-Started/Rate-Limits))
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    GatewayTimeout:
      description: '[Gateway Timeout](#tag/Getting-Started/Timeouts)'
    BadRequest:
      description: Bad Request (see [Error Codes](#tag/Error-Codes))
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error400'
  parameters:
    X-FareHarbor-API-App:
      name: X-FareHarbor-API-App
      in: header
      required: true
      schema:
        type: string
      description: APP-KEY (Please log in to see your key)
      example: APP-KEY
    X-FareHarbor-API-User:
      name: X-FareHarbor-API-User
      in: header
      required: true
      schema:
        type: string
      description: USER-KEY (Please log in to see your key)
      example: USER-KEY
x-stoplight:
  id: obltqlvi1ac1n