sitegpt-ai

sitegpt-ai Leads API

The Leads API from sitegpt-ai — 3 operation(s) for leads.

GitHub OpenAPI

Operations 5

GET /api/v2/chatbots/{chatbotId}/leads List leads #
GET /api/v2/chatbots/{chatbotId}/leads/{leadId} Get lead #
PATCH /api/v2/chatbots/{chatbotId}/leads/{leadId} Update lead #
DELETE /api/v2/chatbots/{chatbotId}/leads/{leadId} Delete lead #
POST /api/v2/chatbots/{chatbotId}/leads/actions Run lead action #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sitegpt-ai/openapi/sitegpt-ai-leads-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-conversation-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-chatbot-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-message-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-billing-subscription-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-invoice-schema.json
📊
JSONSchema
https://artifacts.apis.io/sitegpt-ai/json-schema/sitegpt-ai-knowledge-document-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/sitegpt-ai:sitegpt-ai-leads-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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

sitegpt-ai-leads-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: SiteGPT Agent Leads API
  version: 2.0.0
  description: Agent-facing API for managing SiteGPT chatbots, dashboard summaries, appearance media, knowledge, settings, conversations, leads, members, account profiles, usage, billing reads, and API tokens.
servers:
- url: https://sitegpt.ai
security:
- bearerAuth: []
tags:
- name: Leads
paths:
  /api/v2/chatbots/{chatbotId}/leads:
    get:
      operationId: listLeads
      summary: List leads
      description: 'List chatbot leads.


        Required scope: `leads:read`.


        On success, `data` contains: `leads`, `filters`, `pagination`.'
      tags:
      - Leads
      security:
      - bearerAuth:
        - leads:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - leads:read
      x-mint:
        title: List leads
        description: List chatbot leads.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum number of records to return.
        schema:
          type: integer
          minimum: 1
      - name: cursor
        in: query
        required: false
        description: Pagination cursor.
        schema:
          type: string
      - name: status
        in: query
        required: false
        description: Lead status filter.
        schema:
          type: string
          enum:
          - all
          - open
          - archived
      - name: important
        in: query
        required: false
        description: Important flag filter.
        schema:
          type: boolean
      - name: query
        in: query
        required: false
        description: Search query.
        schema:
          type: string
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      leads:
                        type: array
                        items:
                          $ref: '#/components/schemas/Lead'
                      filters:
                        $ref: '#/components/schemas/GenericObject'
                        description: Echo of the applied filters.
                      pagination:
                        $ref: '#/components/schemas/Pagination'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  leads:
                  - id: lead-id
                    name: Example lead
                    createdAt: '2026-05-13T00:00:00.000Z'
                  pagination:
                    limit: 20
                    hasNextPage: false
                    nextCursor: null
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
        '503':
          $ref: '#/components/responses/AgentError'
  /api/v2/chatbots/{chatbotId}/leads/{leadId}:
    get:
      operationId: getLead
      summary: Get lead
      description: 'Get one chatbot lead.


        Required scope: `leads:read`.


        On success, `data` contains: `lead`, `threads`.'
      tags:
      - Leads
      security:
      - bearerAuth:
        - leads:read
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - leads:read
      x-mint:
        title: Get lead
        description: Get one chatbot lead.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: leadId
        in: path
        required: true
        description: Lead ID.
        schema:
          type: string
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      lead:
                        $ref: '#/components/schemas/Lead'
                      threads:
                        type: array
                        items:
                          $ref: '#/components/schemas/GenericObject'
                          description: Conversation summary for this lead.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  lead:
                    id: lead-id
                    name: Example lead
                    createdAt: '2026-05-13T00:00:00.000Z'
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
        '503':
          $ref: '#/components/responses/AgentError'
    patch:
      operationId: updateLead
      summary: Update lead
      description: 'Update a chatbot lead.


        Required scope: `leads:write`.


        On success, `data` contains: `lead`, `previousLead`.'
      tags:
      - Leads
      security:
      - bearerAuth:
        - leads:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - leads:write
      x-mint:
        title: Update lead
        description: Update a chatbot lead.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: leadId
        in: path
        required: true
        description: Lead ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              properties:
                name:
                  type: string
                phone:
                  type: string
                important:
                  type: boolean
                archived:
                  type: boolean
            example:
              important: true
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      lead:
                        $ref: '#/components/schemas/Lead'
                      previousLead:
                        $ref: '#/components/schemas/Lead'
                        description: The lead as it was before this update.
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  lead:
                    id: lead-id
                    name: Example lead
                    createdAt: '2026-05-13T00:00:00.000Z'
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
        '503':
          $ref: '#/components/responses/AgentError'
    delete:
      operationId: deleteLead
      summary: Delete lead
      description: 'Delete a chatbot lead. Requires confirm=true.


        Required scope: `leads:delete`.


        On success, `data` contains: `deletedLead`.'
      tags:
      - Leads
      security:
      - bearerAuth:
        - leads:delete
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - leads:delete
      x-mint:
        title: Delete lead
        description: Delete a chatbot lead. Requires confirm=true.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      - name: leadId
        in: path
        required: true
        description: Lead ID.
        schema:
          type: string
      - name: confirm
        in: query
        required: false
        description: Required true for destructive actions.
        schema:
          type: boolean
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      deletedLead:
                        $ref: '#/components/schemas/Lead'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  deletedLead:
                    id: lead-id
                    name: Example lead
                    createdAt: '2026-05-13T00:00:00.000Z'
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
        '503':
          $ref: '#/components/responses/AgentError'
  /api/v2/chatbots/{chatbotId}/leads/actions:
    post:
      operationId: runLeadAction
      summary: Run lead action
      description: 'Run a bulk lead action.


        Required scope: `leads:write`.


        On success, `data` contains: `action`, `leads`.'
      tags:
      - Leads
      security:
      - bearerAuth:
        - leads:write
      x-sitegpt-auth: bearer
      x-sitegpt-scopes:
      - leads:write
      x-mint:
        title: Run lead action
        description: Run a bulk lead action.
      parameters:
      - name: chatbotId
        in: path
        required: true
        description: Chatbot ID.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - action
              - leadIds
              additionalProperties: false
              properties:
                action:
                  type: string
                  enum:
                  - archive
                  - delete
                  - star
                  - unarchive
                  - unstar
                leadIds:
                  type: array
                  minItems: 1
                  items:
                    type: string
                confirm:
                  type: boolean
                  description: Required true for bulk delete.
            example:
              action: star
              leadIds:
              - lead-id
      responses:
        '200':
          description: Successful SiteGPT API v2 response.
          content:
            application/json:
              schema:
                type: object
                required:
                - ok
                - data
                - meta
                properties:
                  ok:
                    type: boolean
                    const: true
                  data:
                    type: object
                    additionalProperties: true
                    properties:
                      action:
                        type: string
                      leads:
                        type: array
                        items:
                          $ref: '#/components/schemas/Lead'
                  meta:
                    $ref: '#/components/schemas/AgentResponseMeta'
                additionalProperties: false
              example:
                ok: true
                data:
                  action: star
                  leads:
                  - id: lead-id
                    name: Example lead
                    createdAt: '2026-05-13T00:00:00.000Z'
                meta:
                  requestId: request-id
        '400':
          $ref: '#/components/responses/AgentError'
        '401':
          $ref: '#/components/responses/AgentError'
        '403':
          $ref: '#/components/responses/AgentError'
        '404':
          $ref: '#/components/responses/AgentError'
        '405':
          $ref: '#/components/responses/AgentError'
        '503':
          $ref: '#/components/responses/AgentError'
components:
  schemas:
    GenericObject:
      type: object
      additionalProperties: true
    AgentResponseMeta:
      type: object
      required:
      - requestId
      properties:
        requestId:
          type: string
        warnings:
          type: array
          items:
            type: string
        nextCursor:
          type:
          - string
          - 'null'
      additionalProperties: true
    AgentError:
      type: object
      required:
      - ok
      - error
      - meta
      properties:
        ok:
          type: boolean
          const: false
        error:
          type: object
          required:
          - code
          - message
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          additionalProperties: false
        meta:
          type: object
          required:
          - requestId
          properties:
            requestId:
              type: string
          additionalProperties: true
      additionalProperties: false
    ChatUser:
      type: object
      description: A website visitor identified through the chat widget.
      additionalProperties: true
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
        phone:
          type: string
        verified:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Lead:
      type: object
      description: A captured lead. The top-level email convenience field is present on lead endpoints; conversation payloads embed the same record without it.
      additionalProperties: true
      properties:
        id:
          type: string
        chatbotId:
          type: string
        chatUser:
          $ref: '#/components/schemas/ChatUser'
        name:
          type: string
        phone:
          type: string
        email:
          type: string
          description: Convenience copy of chatUser.email.
        tags:
          type: array
          items:
            type: string
        customData:
          $ref: '#/components/schemas/GenericObject'
          description: Custom lead-form fields collected by the widget.
        important:
          type: boolean
        archived:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Pagination:
      type: object
      description: Cursor pagination state for paginated list endpoints.
      additionalProperties: false
      required:
      - limit
      - hasNextPage
      - nextCursor
      properties:
        limit:
          type: integer
          description: Page size used.
        hasNextPage:
          type: boolean
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass as the cursor query parameter to fetch the next page. Null on the last page.
  responses:
    AgentError:
      description: SiteGPT agent API error response.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AgentError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: SiteGPT API token