Leadping

Leadping Lead Statuses API

Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /lead-statuses List lead statuses · List the current organization's lead statuses #
Ask an LLM
“What lead statuses has my organization defined?”
“Which pipeline stages can I put leads in?”
Tell an agent
List my organization's lead statuses.
Show all active pipeline stages.
POST /lead-statuses Create a lead status · Create an organization lead status #
Ask an LLM
“How do I add a new pipeline stage for leads?”
“Can I give a custom lead status its own color and position?”
Tell an agent
Create a lead status called {name}.
Add pipeline stage {name} in color {color} at position {sortOrder}.
PUT /lead-statuses/{id} Update a lead status · Update an organization lead status #
Ask an LLM
“How do I rename an existing pipeline stage?”
“Can I reorder my lead statuses?”
Tell an agent
Rename lead status {id} to {name}.
Move lead status {id} to sort position {sortOrder}.
DELETE /lead-statuses/{id} Archive a lead status · Archive an organization lead status #
Ask an LLM
“How do I retire a pipeline stage without losing lead history?”
“What happens to leads' past records when a status is archived?”
Tell an agent destructive · confirm first
Archive lead status {id}.
Retire pipeline stage {id} so it can't be assigned anymore.

Documentation

📖
Documentation
https://leadping.ai/docs
📖
APIReference
https://leadping.ai/docs/api-reference
📖
GettingStarted
https://leadping.ai/docs/sending-leads-to-leadping
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/authentication/leadping-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/rate-limits/leadping-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/openapi/leadping-lead-statuses-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/conventions/leadping-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/conventions/leadping-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/errors/leadping-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/data-model/leadping-data-model.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/vocabulary/leadping-vocabulary.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/leadping:leadping-lead-statuses-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

leadping-lead-statuses-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Leadping Lead Statuses API
  description: The Leadping API helps businesses capture and manage leads, automate follow-up, send SMS and MMS messages, place calls, track conversations, enforce contact suppression, and analyze communication workflows. Use this OpenAPI 3.1 contract to integrate lead sources, build organization tools, or generate a typed API client. Authenticate protected operations with a Leadping user access token or WorkOS organization API key. Lead intake operations also accept a Leadping source key.
  termsOfService: https://leadping.ai/docs/terms-of-service
  contact:
    name: Leadping Support
    url: https://leadping.ai/contact
    email: support@leadping.ai
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: v1
  summary: Lead management, messaging, calling, and automation API
servers:
- url: https://api.leadping.ai
  description: Production
tags:
- name: Lead Statuses
  description: Manages the lead statuses used to classify and track leads throughout their lifecycle. Use these endpoints to list, create, update, and archive organization-specific lead statuses for consistent pipeline organization and reporting.
paths:
  /lead-statuses:
    get:
      tags:
      - Lead Statuses
      summary: List the current organization's lead statuses
      description: Lists the current organization's active lead statuses for organizing and tracking leads through the sales workflow.
      operationId: LeadStatuses_GetAll
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/LeadStatusResponse'
                  description: Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: The request could not be completed.
        '403':
          description: The authenticated user or organization does not have permission to perform this operation.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The request could not be completed.
        '429':
          description: The API rate limit for this account or client has been exceeded.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              schema:
                minimum: 0
                type: integer
                format: int32
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request could not be completed.
      security:
      - Bearer: []
      x-agentic-access:
        action-class: connected
        consequences:
        - read
        subject:
          required: true
        authorization:
          source: OpenAPI security requirements
          audience: https://api.leadping.ai
        audit:
          recommended: false
    post:
      tags:
      - Lead Statuses
      summary: Create an organization lead status
      description: Creates a reusable lead status for the current organization to categorize, organize, and track leads consistently throughout its sales and follow-up workflow.
      operationId: LeadStatuses_Create
      requestBody:
        description: The lead status name, color, and display order to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LeadStatusRequest'
              description: Defines the editable values used to create or update a lead status.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LeadStatusRequest'
              description: Defines the editable values used to create or update a lead status.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/LeadStatusResponse'
                description: Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Bad Request
                status: 400
                detail: The request could not be completed.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: The request could not be completed.
        '403':
          description: The authenticated user or organization does not have permission to perform this operation.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The request could not be completed.
        '429':
          description: The API rate limit for this account or client has been exceeded.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              schema:
                minimum: 0
                type: integer
                format: int32
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request could not be completed.
      security:
      - Bearer: []
      x-agentic-access:
        action-class: acting
        consequences:
        - write
        subject:
          required: true
        authorization:
          source: OpenAPI security requirements
          audience: https://api.leadping.ai
        audit:
          recommended: true
  /lead-statuses/{id}:
    put:
      tags:
      - Lead Statuses
      summary: Update an organization lead status
      description: Updates the name, color, and display order of a lead status owned by the current organization so pipeline stages remain clear and consistently organized.
      operationId: LeadStatuses_Update
      parameters:
      - name: id
        in: path
        description: The unique identifier of the lead status to update.
        required: true
        schema:
          type: string
      requestBody:
        description: The replacement lead status name, color, and display order.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LeadStatusRequest'
              description: Defines the editable values used to create or update a lead status.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/LeadStatusRequest'
              description: Defines the editable values used to create or update a lead status.
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/LeadStatusResponse'
                description: Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Bad Request
                status: 400
                detail: The request could not be completed.
        '404':
          description: The requested resource was not found.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Not Found
                status: 404
                detail: The request could not be completed.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: The request could not be completed.
        '403':
          description: The authenticated user or organization does not have permission to perform this operation.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The request could not be completed.
        '429':
          description: The API rate limit for this account or client has been exceeded.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              schema:
                minimum: 0
                type: integer
                format: int32
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request could not be completed.
      security:
      - Bearer: []
      x-agentic-access:
        action-class: acting
        consequences:
        - write
        subject:
          required: true
        authorization:
          source: OpenAPI security requirements
          audience: https://api.leadping.ai
        audit:
          recommended: true
    delete:
      tags:
      - Lead Statuses
      summary: Archive an organization lead status
      description: Archives a lead status for the current organization so it is unavailable for new assignments while existing lead history is preserved.
      operationId: LeadStatuses_Archive
      parameters:
      - name: id
        in: path
        description: The unique identifier of the lead status to archive.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: boolean
        '404':
          description: The requested resource was not found.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Not Found
                status: 404
                detail: The request could not be completed.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Unauthorized
                status: 401
                detail: The request could not be completed.
        '403':
          description: The authenticated user or organization does not have permission to perform this operation.
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Forbidden
                status: 403
                detail: The request could not be completed.
        '429':
          description: The API rate limit for this account or client has been exceeded.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              schema:
                minimum: 0
                type: integer
                format: int32
          content:
            application/problem+json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
              example:
                type: about:blank
                title: Too Many Requests
                status: 429
                detail: The request could not be completed.
      security:
      - Bearer: []
      x-agentic-access:
        action-class: acting
        consequences:
        - safety-critical
        subject:
          required: true
        authorization:
          source: OpenAPI security requirements
          audience: https://api.leadping.ai
        audit:
          recommended: true
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - 'null'
          - string
          description: URI reference that identifies the problem type.
        title:
          type:
          - 'null'
          - string
          description: Short, human-readable summary of the problem.
        status:
          type:
          - 'null'
          - integer
          description: HTTP status code returned for the problem.
          format: int32
        detail:
          type:
          - 'null'
          - string
          description: Human-readable explanation specific to this occurrence of the problem.
        instance:
          type:
          - 'null'
          - string
          description: URI reference that identifies this specific occurrence of the problem.
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Validation errors keyed by the JSON request field name. Present for request validation failures.
        traceId:
          type: string
          description: Request trace identifier used to correlate this problem with Leadping diagnostics.
      description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
    LeadStatusRequest:
      type: object
      properties:
        name:
          type:
          - 'null'
          - string
          description: Display name for the lead status.
        color:
          type:
          - 'null'
          - string
          description: Display color for the lead status.
        category:
          enum:
          - Open
          - Qualified
          - Converted
          - Lost
          - Invalid
          - Duplicate
          type:
          - 'null'
          - string
          description: Controlled lead status change categories used for reporting, automation, and analytics.
        sortOrder:
          type:
          - 'null'
          - integer
          description: Relative display order for the lead status.
          format: int32
      description: Defines the editable values used to create or update a lead status.
    LeadStatusResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the lead status.
        organizationId:
          type: string
          description: Identifier of the organization that owns the lead status.
        name:
          type: string
          description: Display name of the lead status.
        color:
          type: string
          description: Display color assigned to the lead status.
        category:
          allOf:
          - $ref: '#/components/schemas/LeadStatusCategory'
          description: LeadStatusChange category represented by the lead status.
        sortOrder:
          type: integer
          description: Relative display order of the lead status.
          format: int32
        isArchived:
          type: boolean
          description: Indicates whether the lead status has been archived.
        modifiedAt:
          type: string
          description: Date and time when the lead status was last modified.
          format: date-time
      description: Describes an organization-defined lead status used to classify pipeline progress, drive automation, and report lifecycle outcomes.
    LeadStatusCategory:
      enum:
      - Open
      - Qualified
      - Converted
      - Lost
      - Invalid
      - Duplicate
      type: string
      description: Controlled lead status change categories used for reporting, automation, and analytics.
  securitySchemes:
    Bearer:
      type: http
      description: Authorization header using the Bearer scheme. Accepted values are Leadping user JWT access tokens and WorkOS organization API keys beginning with sk_.
      scheme: bearer
      bearerFormat: JWT or organization API key
    SourceKey:
      type: http
      description: 'Leadping source key for lead ingestion endpoints only using the Authorization header. Example: "Authorization: Bearer lp_src_...".'
      scheme: bearer
      bearerFormat: Leadping source key
externalDocs:
  description: Leadping API documentation, authentication guide, concepts, and integration guidance.
  url: https://leadping.ai/docs/api-reference