Charter Captain

Charter Captain Contracts API

The Contracts API from Charter Captain — 6 operation(s) for contracts.

GitHub OpenAPI

Operations 7

GET /api/v1/rentals/{rentalId}/documents Document status dashboard #
GET /api/v1/rentals/{rentalId}/coast-guard Coast guard presentation view #
GET /api/v1/contracts/templates List contract templates #
POST /api/v1/contracts/templates Create contract template #
PATCH /api/v1/contracts/templates/{id} Update contract template #
GET /api/v1/rentals/{rentalId}/contract View contract template and status #
POST /api/v1/rentals/{rentalId}/contract/sign Sign contract #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/chartercaptain-com/openapi/chartercaptain-com-contracts-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-contracts-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-contracts-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Charter Captain Contracts 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: Contracts
paths:
  /api/v1/rentals/{rentalId}/documents:
    get:
      summary: Document status dashboard
      description: Returns the status of all documents (contract and waivers) for a rental.
      operationId: getRentalDocuments
      tags:
      - Contracts
      security:
      - bearerAuth: []
      parameters:
      - name: rentalId
        in: path
        description: Rental ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Document status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/DocumentStatus'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Rental not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/rentals/{rentalId}/coast-guard:
    get:
      summary: Coast guard presentation view
      description: Returns a structured view of vessel, charter, and passenger info for coast guard inspection. Accessible to either the assigned captain or the boat owner of the rental.
      operationId: getRentalCoastGuard
      tags:
      - Contracts
      security:
      - bearerAuth: []
      parameters:
      - name: rentalId
        in: path
        description: Rental ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Coast guard view
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CoastGuardView'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Rental not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/contracts/templates:
    get:
      summary: List contract templates
      description: Returns all contract templates for the authenticated boat owner.
      operationId: getContractTemplates
      tags:
      - Contracts
      security:
      - bearerAuth: []
      responses:
        '200':
          description: Contract templates
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ContractTemplate'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      summary: Create contract template
      description: Creates a new contract template for the authenticated boat owner.
      operationId: postContractTemplate
      tags:
      - Contracts
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - content
              properties:
                name:
                  type: string
                content:
                  type: string
      responses:
        '201':
          description: Contract template created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ContractTemplate'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/contracts/templates/{id}:
    patch:
      summary: Update contract template
      description: Updates an existing contract template by ID.
      operationId: patchContractTemplate
      tags:
      - Contracts
      security:
      - bearerAuth: []
      parameters:
      - name: id
        in: path
        description: Contract template ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                content:
                  type: string
                isActive:
                  type: boolean
      responses:
        '200':
          description: Updated contract template
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ContractTemplate'
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Contract template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/rentals/{rentalId}/contract:
    get:
      summary: View contract template and status
      description: Returns the contract template content and current signing status for the rental. Requires authentication; accessible only to the rental's operator (its owning captain or boat owner).
      operationId: getRentalContract
      tags:
      - Contracts
      security:
      - bearerAuth: []
      parameters:
      - name: rentalId
        in: path
        description: Rental ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Contract template and status
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      template:
                        $ref: '#/components/schemas/ContractTemplate'
                      signed:
                        type: boolean
                      signedAt:
                        type: string
                        format: date-time
                        nullable: true
        '401':
          description: Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Rental or contract not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/rentals/{rentalId}/contract/sign:
    post:
      summary: Sign contract
      description: Records a customer's signature for the rental contract. On success, the server stamps the active `ContractTemplate` id plus the request's `userAgent` and `ipAddress` into `signatureData`. Public endpoint — no authentication required.
      operationId: postRentalContractSign
      tags:
      - Contracts
      security: []
      parameters:
      - name: rentalId
        in: path
        description: Rental ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - signerName
              - signerEmail
              - signatureData
              properties:
                signerName:
                  type: string
                  minLength: 1
                signerEmail:
                  type: string
                  format: email
                signatureData:
                  type: object
                  required:
                  - typedName
                  - agreedAt
                  properties:
                    typedName:
                      type: string
                      minLength: 1
                      description: Customer's typed name as their signature.
                    agreedAt:
                      type: string
                      format: date-time
                      description: ISO 8601 timestamp of when the customer agreed.
                  additionalProperties: true
      responses:
        '201':
          description: Contract signed.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SignedContract'
        '400':
          description: Bad request — `VALIDATION_ERROR` if the request body is invalid, `ALREADY_SIGNED` if the rental contract has already been signed, or `NO_TEMPLATE` if the boat owner has no active contract template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Rental not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
          required:
          - message
          - code
      required:
      - error
    CoastGuardView:
      type: object
      required:
      - vessel
      - charter
      - charterAgreement
      - passengers
      properties:
        vessel:
          type: object
        charter:
          type: object
        charterAgreement:
          type: object
        passengers:
          type: array
          items:
            type: object
    DocumentStatus:
      type: object
      required:
      - rentalId
      - charterAgreement
      - waivers
      properties:
        rentalId:
          type: string
        charterAgreement:
          type: object
          required:
          - required
          - signed
          properties:
            required:
              type: boolean
            signed:
              type: boolean
            signerName:
              type: string
              nullable: true
            signerEmail:
              type: string
              format: email
              nullable: true
            signedAt:
              type: string
              format: date-time
              nullable: true
        waivers:
          type: object
          required:
          - total
          - signed
          - pending
          - guests
          properties:
            total:
              type: integer
            signed:
              type: integer
            pending:
              type: integer
            guests:
              type: array
              items:
                $ref: '#/components/schemas/Guest'
    SignedContract:
      type: object
      required:
      - id
      - rentalId
      - contractTemplateId
      - contractTemplateVersion
      - signerName
      - signerEmail
      - signedAt
      properties:
        id:
          type: string
        rentalId:
          type: string
        contractTemplateId:
          type: string
        contractTemplateVersion:
          type: integer
        signerName:
          type: string
        signerEmail:
          type: string
          format: email
        signedAt:
          type: string
          format: date-time
        signatureData:
          type: string
          nullable: true
    Guest:
      type: object
      required:
      - id
      - rentalId
      - firstName
      - lastName
      - email
      - isCharterer
      - waiverStatus
      properties:
        id:
          type: string
        rentalId:
          type: string
        waiverTemplateId:
          type: string
          nullable: true
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
          nullable: true
        isCharterer:
          type: boolean
        waiverStatus:
          type: string
          enum:
          - PENDING
          - SENT
          - SIGNED
        waiverSentAt:
          type: string
          format: date-time
          nullable: true
        waiverSignedAt:
          type: string
          format: date-time
          nullable: true
        signatureData:
          type: string
          nullable: true
    ContractTemplate:
      type: object
      required:
      - id
      - boatOwnerId
      - name
      - content
      - version
      - isActive
      - createdAt
      - updatedAt
      properties:
        id:
          type: string
        boatOwnerId:
          type: string
        name:
          type: string
        content:
          type: string
        version:
          type: integer
        isActive:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk JWT token