Charter Captain

Charter Captain Notifications API

The Notifications API from Charter Captain — 3 operation(s) for notifications.

GitHub OpenAPI

Operations 3

GET /api/v1/notifications List notifications (paginated) #
PATCH /api/v1/notifications/preferences Update notification preferences #
POST /api/v1/notifications/test Send a test push notification #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/chartercaptain-com/openapi/chartercaptain-com-notifications-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-notifications-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-notifications-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Charter Captain Notifications 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: Notifications
paths:
  /api/v1/notifications:
    get:
      operationId: getNotifications
      summary: List notifications (paginated)
      description: Returns a paginated list of notifications for the authenticated captain, ordered by most recent first.
      tags:
      - Notifications
      parameters:
      - schema:
          type: integer
          minimum: 1
          default: 1
          description: Page number (default 1)
        required: false
        description: Page number (default 1)
        name: page
        in: query
      - schema:
          type: integer
          minimum: 1
          maximum: 50
          default: 20
          description: Items per page (1–50, default 20)
        required: false
        description: Items per page (1–50, default 20)
        name: limit
        in: query
      responses:
        '200':
          description: Paginated notification list
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Notification'
                  meta:
                    $ref: '#/components/schemas/PaginationMeta'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/notifications/preferences:
    patch:
      operationId: patchNotificationPreferences
      summary: Update notification preferences
      description: Merges the provided push notification preferences with the captain's existing settings.
      tags:
      - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NotificationPreferences'
      responses:
        '200':
          description: Updated preferences
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/NotificationPreferences'
                required:
                - data
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /api/v1/notifications/test:
    post:
      operationId: postNotificationsTest
      summary: Send a test push notification
      description: Sends a test push notification to all active devices for the authenticated captain. Returns delivery counts.
      tags:
      - Notifications
      responses:
        '200':
          description: Push delivery result
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PushTestResult'
                required:
                - data
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: string
          required:
          - message
          - code
      required:
      - error
    PaginationMeta:
      type: object
      properties:
        page:
          type: integer
        limit:
          type: integer
        total:
          type: integer
      required:
      - page
      - limit
      - total
    PushTestResult:
      type: object
      properties:
        sent:
          type: integer
          description: Number of devices reached
        failed:
          type: integer
          description: Number of delivery failures
      required:
      - sent
      - failed
    NotificationPreferences:
      type: object
      properties:
        push:
          type: object
          properties:
            newBooking:
              type: boolean
            paymentReceived:
              type: boolean
            tipReceived:
              type: boolean
            weatherAlert:
              type: boolean
            bookingCancelled:
              type: boolean
            waiverSigned:
              type: boolean
            allDocumentsSigned:
              type: boolean
            checkoutReminder:
              type: boolean
    Notification:
      type: object
      properties:
        id:
          type: string
        bookingId:
          type: string
        type:
          type: string
        sentAt:
          type: string
          format: date-time
        status:
          type: string
  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