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-favorites-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 Favorites 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: Favorites
paths:
  /api/v1/favorites:
    get:
      summary: List favorites
      description: Returns all favorites for the authenticated customer.
      operationId: getFavorites
      tags:
      - Favorites
      responses:
        '200':
          description: List of favorites
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Favorite'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
    post:
      summary: Add favorite
      description: Adds a captain or boat to the authenticated customer's favorites.
      operationId: postFavorite
      tags:
      - Favorites
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                captainId:
                  type: string
                  nullable: true
                boatId:
                  type: string
                  nullable: true
      responses:
        '201':
          description: Favorite added
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/Favorite'
        '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/favorites/{id}:
    delete:
      summary: Remove favorite
      description: Removes a favorite by ID for the authenticated customer.
      operationId: deleteFavoriteById
      tags:
      - Favorites
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Favorite removed
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Favorite not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
  /api/v1/favorites/check:
    get:
      summary: Check if favorited
      description: Checks whether a given captain or boat is in the authenticated customer's favorites.
      operationId: getFavoritesCheck
      tags:
      - Favorites
      parameters:
      - name: captainId
        in: query
        required: false
        schema:
          type: string
      - name: boatId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Favorite check result
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    required:
                    - isFavorited
                    properties:
                      isFavorited:
                        type: boolean
                      favoriteId:
                        type: string
                        nullable: true
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          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
    Favorite:
      type: object
      required:
      - id
      - customerId
      - createdAt
      properties:
        id:
          type: string
        customerId:
          type: string
        captainId:
          type: string
          nullable: true
        boatId:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Clerk JWT token