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-customers-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: Charter Captain Customers 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: Customers
paths:
  /api/v1/customers:
    get:
      summary: List customers with search
      description: Returns a paginated list of customers for the authenticated captain, with trip and spend summary fields.
      operationId: getCustomers
      tags:
      - Customers
      parameters:
      - name: q
        in: query
        description: Search by name, email, or phone
        required: false
        schema:
          type: string
      - name: page
        in: query
        description: Page number (default 1)
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
      - name: limit
        in: query
        description: Page size (default 20, max 100)
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      responses:
        '200':
          description: Paginated customer list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomerSummary'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/customers/{id}:
    get:
      summary: Customer detail
      description: Returns a single customer with full booking history, total spend, and trip count.
      operationId: getCustomerById
      tags:
      - Customers
      parameters:
      - name: id
        in: path
        description: Customer ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Customer detail
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    allOf:
                    - $ref: '#/components/schemas/CustomerSummary'
                    - type: object
                      properties:
                        bookings:
                          type: array
                          items:
                            $ref: '#/components/schemas/Booking'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/customers/{id}/notes:
    patch:
      summary: Update customer notes
      description: Updates the private notes field for a customer.
      operationId: patchCustomerNotes
      tags:
      - Customers
      parameters:
      - name: id
        in: path
        description: Customer ID
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - notes
              properties:
                notes:
                  type: string
      responses:
        '200':
          description: Updated customer
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Customer'
        '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: Customer not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    CustomerSummary:
      allOf:
      - $ref: '#/components/schemas/Customer'
      - type: object
        properties:
          trips:
            type: integer
          totalSpent:
            type: number
          lastTrip:
            type: string
            format: date-time
            nullable: true
    WeatherCheck:
      type: object
      properties:
        id:
          type: string
        bookingId:
          type: string
        checkedAt:
          type: string
          format: date-time
        hasAdvisory:
          type: boolean
        advisoryType:
          type: string
          nullable: true
        windSpeed:
          type: number
          nullable: true
        waveHeight:
          type: number
          nullable: true
        forecast:
          type: string
          nullable: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
          required:
          - message
          - code
      required:
      - error
    Payment:
      type: object
      required:
      - id
      - amount
      - type
      - status
      properties:
        id:
          type: string
        bookingId:
          type: string
        amount:
          type: number
        type:
          type: string
          enum:
          - DEPOSIT
          - BALANCE
          - TIP
          - REFUND
        status:
          type: string
          enum:
          - PENDING
          - SUCCEEDED
          - FAILED
          - REFUNDED
        createdAt:
          type: string
          format: date-time
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
      required:
      - page
      - limit
      - total
    Notification:
      type: object
      properties:
        id:
          type: string
        bookingId:
          type: string
        type:
          type: string
        sentAt:
          type: string
          format: date-time
        status:
          type: string
    Booking:
      type: object
      required:
      - id
      - captainId
      - date
      - status
      properties:
        id:
          type: string
        captainId:
          type: string
        date:
          type: string
          format: date-time
        startTime:
          type: string
          nullable: true
        endTime:
          type: string
          nullable: true
        status:
          type: string
          enum:
          - PENDING_DEPOSIT
          - DEPOSIT_PAID
          - CONFIRMED
          - COMPLETED
          - CANCELLED
          - WEATHER_CANCELLED
        totalPrice:
          type: number
          nullable: true
        notes:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
        customer:
          $ref: '#/components/schemas/Customer'
        harbor:
          $ref: '#/components/schemas/Harbor'
        duration:
          $ref: '#/components/schemas/Duration'
        payments:
          type: array
          items:
            $ref: '#/components/schemas/Payment'
        weatherChecks:
          type: array
          items:
            $ref: '#/components/schemas/WeatherCheck'
        notifications:
          type: array
          items:
            $ref: '#/components/schemas/Notification'
    Customer:
      type: object
      required:
      - id
      - firstName
      - lastName
      - email
      properties:
        id:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
          nullable: true
        notes:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk JWT token