Charter Captain

Charter Captain Settings API

The Settings API from Charter Captain — 4 operation(s) for settings.

GitHub OpenAPI

Operations 4

GET /api/v1/settings All captain settings #
PUT /api/v1/settings/availability Update availability rules #
PUT /api/v1/settings/durations Update durations #
PUT /api/v1/settings/pricing Update pricing tiers #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/chartercaptain-com/openapi/chartercaptain-com-settings-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/chartercaptain-com/json-schema/chartercaptain-com-customer-gig-detail-schema.json
📊
JSONSchema
https://artifacts.apis.io/chartercaptain-com/json-schema/chartercaptain-com-captain-profile-schema.json
📊
JSONSchema
https://artifacts.apis.io/chartercaptain-com/json-schema/chartercaptain-com-boat-profile-schema.json
📊
JSONSchema
https://artifacts.apis.io/chartercaptain-com/json-schema/chartercaptain-com-captain-schema.json
📊
JSONSchema
https://artifacts.apis.io/chartercaptain-com/json-schema/chartercaptain-com-booking-schema.json
📊
JSONSchema
https://artifacts.apis.io/chartercaptain-com/json-schema/chartercaptain-com-marketplace-captain-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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/chartercaptain-com:chartercaptain-com-settings-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

chartercaptain-com-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Charter Captain Settings API
  version: 1.0.0
  description: REST API for the Charter Captain iOS apps
servers:
- url: http://localhost:3002
  description: Development
security:
- bearerAuth: []
tags:
- name: Settings
paths:
  /api/v1/settings:
    get:
      operationId: getSettings
      summary: All captain settings
      description: 'Returns all settings for the captain: profile, availability rules, exceptions, pricing tiers, harbors, and durations.'
      tags:
      - Settings
      responses:
        '200':
          description: Captain settings bundle
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      captain:
                        $ref: '#/components/schemas/Captain'
                      availabilityRules:
                        type: array
                        items:
                          $ref: '#/components/schemas/AvailabilityRule'
                      availabilityExceptions:
                        type: array
                        items:
                          $ref: '#/components/schemas/AvailabilityException'
                      pricingTiers:
                        type: array
                        items:
                          $ref: '#/components/schemas/PricingTier'
                      harbors:
                        type: array
                        items:
                          $ref: '#/components/schemas/Harbor'
                      durations:
                        type: array
                        items:
                          $ref: '#/components/schemas/Duration'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/settings/availability:
    put:
      operationId: putSettingsAvailability
      summary: Update availability rules
      description: Updates startTime, endTime, and/or isActive for one or more availability rules.
      tags:
      - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                rules:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      startTime:
                        type: string
                        example: 08:00
                      endTime:
                        type: string
                        example: '18:00'
                      isActive:
                        type: boolean
                    required:
                    - id
              required:
              - rules
      responses:
        '200':
          description: Updated availability rules
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AvailabilityRule'
                required:
                - data
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/settings/durations:
    put:
      operationId: putSettingsDurations
      summary: Update durations
      description: Updates hours, label, and/or isActive for one or more duration options.
      tags:
      - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                durations:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      hours:
                        type: integer
                      label:
                        type: string
                      isActive:
                        type: boolean
                    required:
                    - id
              required:
              - durations
      responses:
        '200':
          description: Updated durations
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Duration'
                required:
                - data
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/settings/pricing:
    put:
      operationId: putSettingsPricing
      summary: Update pricing tiers
      description: Updates name, ratePerHour, and/or isActive for one or more pricing tiers.
      tags:
      - Settings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                tiers:
                  type: array
                  items:
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      ratePerHour:
                        type: number
                      isActive:
                        type: boolean
                    required:
                    - id
              required:
              - tiers
      responses:
        '200':
          description: Updated pricing tiers
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PricingTier'
                required:
                - data
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    AvailabilityException:
      type: object
      properties:
        id:
          type: string
        captainId:
          type: string
        date:
          type: string
          format: date-time
        isBlocked:
          type: boolean
        reason:
          type:
          - string
          - 'null'
        overrideStart:
          type:
          - string
          - 'null'
        overrideEnd:
          type:
          - string
          - 'null'
        createdAt:
          type: string
          format: date-time
      required:
      - id
      - captainId
      - date
      - isBlocked
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
          required:
          - message
          - code
      required:
      - error
    Captain:
      type: object
      properties:
        id:
          type: string
        name:
          type:
          - string
          - 'null'
        phone:
          type:
          - string
          - 'null'
        bio:
          type:
          - string
          - 'null'
        profileImageUrl:
          type:
          - string
          - 'null'
        homeHarborId:
          type:
          - string
          - 'null'
          description: Convenience pointer to the harbor in `harbors[]` with `isHome = true`. Returned for clients that only need the captain's primary harbor without iterating the list.
        harbors:
          type: array
          items:
            type: object
            properties:
              harborId:
                type: string
              isHome:
                type: boolean
              name:
                type: string
            required:
            - harborId
            - isHome
            - name
        depositType:
          type:
          - string
          - 'null'
          enum:
          - FIXED
          - PERCENTAGE
          - null
        depositValue:
          type:
          - integer
          - 'null'
        cancellationWindowDays:
          type:
          - integer
          - 'null'
        depositRefundable:
          type: boolean
        weatherCancellationPolicy:
          type:
          - string
          - 'null'
        notificationPreferences: {}
        googleCalendarConnected:
          type: boolean
      required:
      - id
    AvailabilityRule:
      type: object
      properties:
        id:
          type: string
        captainId:
          type: string
        dayOfWeek:
          type: integer
          minimum: 0
          maximum: 6
        startTime:
          type:
          - string
          - 'null'
        endTime:
          type:
          - string
          - 'null'
        isActive:
          type: boolean
      required:
      - id
      - captainId
      - dayOfWeek
    PricingTier:
      type: object
      properties:
        id:
          type: string
        captainId:
          type: string
        name:
          type: string
        ratePerHour:
          type:
          - number
          - 'null'
        isActive:
          type: boolean
      required:
      - id
      - captainId
      - name
    Duration:
      type: object
      properties:
        id:
          type: string
        hours:
          type: integer
        label:
          type: string
        isActive:
          type: boolean
        sortOrder:
          type: integer
      required:
      - id
      - hours
      - label
    Harbor:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        city:
          type:
          - string
          - 'null'
        state:
          type:
          - string
          - 'null'
        lat:
          type:
          - number
          - 'null'
        lng:
          type:
          - number
          - 'null'
        sortOrder:
          type: integer
        isActive:
          type: boolean
      required:
      - id
      - name
      - isActive
  responses:
    Unauthorized:
      description: Authentication required, or the bearer token is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ValidationError:
      description: Request body or query parameters failed validation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk JWT token