CompTeam Leads API

The Leads API from CompTeam — 8 operation(s) for leads.

GitHub OpenAPI

Operations 13

GET /api/v1/branches/{branch_id}/leads List Leads #
POST /api/v1/branches/{branch_id}/leads Create Lead #
PATCH /api/v1/branches/{branch_id}/leads/{lead_id} Update Lead #
DELETE /api/v1/branches/{branch_id}/leads/{lead_id} Delete Lead #
GET /api/v1/branches/{branch_id}/leads/white-belt-cheat-sheet Get White Belt Cheat Sheet #
PUT /api/v1/branches/{branch_id}/leads/white-belt-cheat-sheet Update White Belt Cheat Sheet #
GET /api/v1/branches/{branch_id}/leads/email-config Get Lead Email Config #
PUT /api/v1/branches/{branch_id}/leads/email-config Update Lead Email Config #
GET /api/v1/branches/{branch_id}/leads/white-belt-cheat-sheet/pdf Download White Belt Cheat Sheet #
GET /api/v1/branches/{branch_id}/leads/{lead_id}/messages List Lead Messages #
POST /api/v1/branches/{branch_id}/leads/{lead_id}/messages Send Lead Message #
POST /api/v1/branches/{branch_id}/leads/{lead_id}/public-booking-followup Send Public Booking Followup #
POST /api/v1/branches/{branch_id}/leads/mass-action Mass Action #

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/compteam-io:compteam-io-leads-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.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

compteam-io-leads-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Compteam Io Leads API
  version: 0.1.0
  description: 'Operations tagged Leads across 2 of this provider''s published API definitions: compteam-io-openapi.json, compteam-io-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.compteam.io
  description: C-TEAM API host serving this spec and its Swagger UI at /docs
tags:
- name: Leads
paths:
  /api/v1/branches/{branch_id}/leads:
    get:
      tags:
      - Leads
      summary: List Leads
      operationId: list_leads_api_v1_branches__branch_id__leads_get
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - new
            - contacted
            - converted
            - lost
            type: string
          - type: 'null'
          title: Status
      - name: source
        in: query
        required: false
        schema:
          anyOf:
          - enum:
            - manual
            - public_booking
            - instagram_dm
            - highlevel
            type: string
          - type: 'null'
          title: Source
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Leads
      summary: Create Lead
      operationId: create_lead_api_v1_branches__branch_id__leads_post
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/branches/{branch_id}/leads/{lead_id}:
    patch:
      tags:
      - Leads
      summary: Update Lead
      operationId: update_lead_api_v1_branches__branch_id__leads__lead_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      - name: lead_id
        in: path
        required: true
        schema:
          type: string
          title: Lead Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Leads
      summary: Delete Lead
      operationId: delete_lead_api_v1_branches__branch_id__leads__lead_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      - name: lead_id
        in: path
        required: true
        schema:
          type: string
          title: Lead Id
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/branches/{branch_id}/leads/white-belt-cheat-sheet:
    get:
      tags:
      - Leads
      summary: Get White Belt Cheat Sheet
      operationId: get_white_belt_cheat_sheet_api_v1_branches__branch_id__leads_white_belt_cheat_sheet_get
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Leads
      summary: Update White Belt Cheat Sheet
      operationId: update_white_belt_cheat_sheet_api_v1_branches__branch_id__leads_white_belt_cheat_sheet_put
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhiteBeltCheatSheetUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/branches/{branch_id}/leads/email-config:
    get:
      tags:
      - Leads
      summary: Get Lead Email Config
      operationId: get_lead_email_config_api_v1_branches__branch_id__leads_email_config_get
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Leads
      summary: Update Lead Email Config
      operationId: update_lead_email_config_api_v1_branches__branch_id__leads_email_config_put
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadEmailConfigUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/branches/{branch_id}/leads/white-belt-cheat-sheet/pdf:
    get:
      tags:
      - Leads
      summary: Download White Belt Cheat Sheet
      operationId: download_white_belt_cheat_sheet_api_v1_branches__branch_id__leads_white_belt_cheat_sheet_pdf_get
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/branches/{branch_id}/leads/{lead_id}/messages:
    get:
      tags:
      - Leads
      summary: List Lead Messages
      operationId: list_lead_messages_api_v1_branches__branch_id__leads__lead_id__messages_get
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      - name: lead_id
        in: path
        required: true
        schema:
          type: string
          title: Lead Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Leads
      summary: Send Lead Message
      operationId: send_lead_message_api_v1_branches__branch_id__leads__lead_id__messages_post
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      - name: lead_id
        in: path
        required: true
        schema:
          type: string
          title: Lead Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LeadMessageCreate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/branches/{branch_id}/leads/{lead_id}/public-booking-followup:
    post:
      tags:
      - Leads
      summary: Send Public Booking Followup
      operationId: send_public_booking_followup_api_v1_branches__branch_id__leads__lead_id__public_booking_followup_post
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      - name: lead_id
        in: path
        required: true
        schema:
          type: string
          title: Lead Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/branches/{branch_id}/leads/mass-action:
    post:
      tags:
      - Leads
      summary: Mass Action
      operationId: mass_action_api_v1_branches__branch_id__leads_mass_action_post
      security:
      - HTTPBearer: []
      parameters:
      - name: branch_id
        in: path
        required: true
        schema:
          type: string
          title: Branch Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MassActionRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LeadEmailTemplateConfig:
      properties:
        subject:
          anyOf:
          - type: string
            maxLength: 160
          - type: 'null'
          title: Subject
        greeting:
          anyOf:
          - type: string
            maxLength: 200
          - type: 'null'
          title: Greeting
        intro:
          anyOf:
          - type: string
            maxLength: 800
          - type: 'null'
          title: Intro
        body:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Body
      type: object
      title: LeadEmailTemplateConfig
    LeadMessageCreate:
      properties:
        content:
          type: string
          title: Content
        attach_white_belt_cheat_sheet:
          type: boolean
          title: Attach White Belt Cheat Sheet
          default: false
      type: object
      required:
      - content
      title: LeadMessageCreate
    WhiteBeltCheatSheetUpdate:
      properties:
        title:
          type: string
          maxLength: 120
          minLength: 1
          title: Title
        introduction:
          type: string
          maxLength: 1200
          minLength: 1
          title: Introduction
        rules:
          items:
            type: string
          type: array
          maxItems: 20
          minItems: 1
          title: Rules
        closing:
          type: string
          maxLength: 600
          minLength: 1
          title: Closing
      type: object
      required:
      - title
      - introduction
      - rules
      - closing
      title: WhiteBeltCheatSheetUpdate
    LeadUpdate:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        instagram_handle:
          anyOf:
          - type: string
          - type: 'null'
          title: Instagram Handle
        status:
          anyOf:
          - type: string
            enum:
            - new
            - contacted
            - converted
            - lost
          - type: 'null'
          title: Status
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
        converted_profile_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Converted Profile Id
      type: object
      title: LeadUpdate
    LeadCreate:
      properties:
        name:
          type: string
          title: Name
        email:
          anyOf:
          - type: string
          - type: 'null'
          title: Email
        phone:
          anyOf:
          - type: string
          - type: 'null'
          title: Phone
        instagram_handle:
          anyOf:
          - type: string
          - type: 'null'
          title: Instagram Handle
        message:
          anyOf:
          - type: string
          - type: 'null'
          title: Message
        notes:
          anyOf:
          - type: string
          - type: 'null'
          title: Notes
      type: object
      required:
      - name
      title: LeadCreate
    MassActionRequest:
      properties:
        lead_ids:
          items:
            type: string
          type: array
          title: Lead Ids
        action:
          anyOf:
          - type: string
            enum:
            - schedule
            - registration_link
            - location
            - white_belt_cheat_sheet
          - type: 'null'
          title: Action
        actions:
          anyOf:
          - items:
              type: string
              enum:
              - schedule
              - registration_link
              - location
              - white_belt_cheat_sheet
            type: array
          - type: 'null'
          title: Actions
        schedule_kinds:
          anyOf:
          - items:
              type: string
              enum:
              - kids
              - amateur
              - competitor
            type: array
          - type: 'null'
          title: Schedule Kinds
        custom_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Custom Message
      type: object
      required:
      - lead_ids
      title: MassActionRequest
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    LeadEmailConfigUpdate:
      properties:
        manual_reply:
          $ref: '#/components/schemas/LeadEmailTemplateConfig'
        booking_confirmation:
          $ref: '#/components/schemas/LeadEmailTemplateConfig'
        attendance_followup:
          $ref: '#/components/schemas/LeadEmailTemplateConfig'
        no_show_followup:
          $ref: '#/components/schemas/LeadEmailTemplateConfig'
      type: object
      title: LeadEmailConfigUpdate
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- compteam-io-openapi.json
- compteam-io-openapi.yml