Leadping Organizations API

openapi: 3.2.0
info:
  title: Leadping Organizations 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: Organizations
  description: Manages Leadping organizations, memberships, invitations, settings, and API credentials. Use these endpoints to maintain organization profiles and branding, manage members and invitations, configure options, and issue or revoke organization API keys.
paths:
  /organizations/me:
    get:
      tags:
      - Organizations
      summary: Get current organization account profile
      description: Returns the authenticated user's current organization profile, including account settings, billing context, and communication configuration.
      operationId: Organizations_GetForCurrentUser
      responses:
        '200':
          description: Organization was successfully retrieved.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationResponse'
                description: Describes organization profile data returned by Leadping.
        '404':
          description: The specified organization was not found.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
    post:
      tags:
      - Organizations
      summary: Create an organization account
      description: Creates an organization account for the authenticated user, assigns them as its owner, and makes it their active organization context.
      operationId: Organizations_CreateForCurrentUser
      requestBody:
        description: The organization profile, contact, and initial setup details to create.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationRequest'
              description: Defines the fields clients can send when working with organization profile.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationRequest'
              description: Defines the fields clients can send when working with organization profile.
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationResponse'
                description: Describes organization profile data returned by Leadping.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
    put:
      tags:
      - Organizations
      summary: Update current organization account profile
      description: Updates the authenticated user's current organization profile, including contact, settings, and communication configuration.
      operationId: Organizations_UpdateForCurrentUser
      requestBody:
        description: The updated organization profile data.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationRequest'
              description: Defines the fields clients can send when working with organization profile.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationRequest'
              description: Defines the fields clients can send when working with organization profile.
        required: true
      responses:
        '200':
          description: Returns the organization response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationResponse'
                description: Describes organization profile data returned by Leadping.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
  /organizations/me/options:
    get:
      tags:
      - Organizations
      summary: List organization switch options
      description: Lists organizations the authenticated user can switch into, including membership role and current-organization selection data.
      operationId: Organizations_GetSwitchOptions
      responses:
        '200':
          description: Returns the list of organization switch option.
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/OrganizationSwitchOption'
                  description: Describes organization switch option data used in Leadping API requests and responses.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
  /organizations/me/switch:
    post:
      tags:
      - Organizations
      summary: Switch current organization account context
      description: Switches the authenticated user's active organization context so subsequent lead, billing, and communication requests target that organization.
      operationId: Organizations_SwitchCurrentOrganization
      requestBody:
        description: The selected organization identifier.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationSwitchRequest'
              description: Defines the fields clients can send when working with organization switch.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationSwitchRequest'
              description: Defines the fields clients can send when working with organization switch.
        required: true
      responses:
        '200':
          description: Returns the organization response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationResponse'
                description: Describes organization profile data returned by Leadping.
        '403':
          description: The authenticated user is not authorized for this operation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
  /organizations/me/members:
    get:
      tags:
      - Organizations
      summary: List users for the current organization
      description: Lists users assigned to the current organization, including roles and membership details for access management.
      operationId: Organizations_GetCurrentOrganizationMembers
      responses:
        '200':
          description: Returns the list of organization member table row.
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/OrganizationMemberTableRow'
                  description: Describes organization user data used in Leadping API requests and responses.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
        '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.
      security:
      - Bearer: []
    post:
      tags:
      - Organizations
      summary: Add a user to the current organization account
      description: Adds an existing user to the current organization with the requested role for shared lead communication and account access.
      operationId: Organizations_AddCurrentOrganizationMember
      requestBody:
        description: The user and role to add to the current organization.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationMemberRequest'
              description: Defines the fields clients can send when working with organization user.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationMemberRequest'
              description: Defines the fields clients can send when working with organization user.
        required: true
      responses:
        '200':
          description: Returns the organization member response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationMemberResponse'
                description: Describes organization user data returned by Leadping.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '403':
          description: The authenticated user is not authorized for this operation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
  /organizations/me/members/{userId}:
    put:
      tags:
      - Organizations
      summary: Change a current-organization user role
      description: Changes a user's role in the current organization, updating access to lead, automation, billing, and admin workflows.
      operationId: Organizations_ChangeCurrentOrganizationMemberRole
      parameters:
      - name: userId
        in: path
        description: The ID of the user whose current-organization role is changing.
        required: true
        schema:
          type: string
      requestBody:
        description: The updated role assignment.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationMemberRequest'
              description: Defines the fields clients can send when working with organization user.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationMemberRequest'
              description: Defines the fields clients can send when working with organization user.
        required: true
      responses:
        '200':
          description: Returns the organization member response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationMemberResponse'
                description: Describes organization user data returned by Leadping.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '403':
          description: The authenticated user is not authorized for this operation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
    delete:
      tags:
      - Organizations
      summary: Remove a user from the current organization
      description: Removes a user from the current organization, revoking their access to its leads, settings, billing, and communication data.
      operationId: Organizations_RemoveCurrentOrganizationMember
      parameters:
      - name: userId
        in: path
        description: The ID of the user to remove from the current organization.
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content is returned when the operation succeeds.
        '400':
          description: The request was invalid or failed validation.
          content:
            text/plain:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
            text/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '403':
          description: The authenticated user is not authorized for this operation.
          content:
            text/plain:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
            text/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            text/plain:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
            text/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
      security:
      - Bearer: []
  /organizations/me/invitations:
    get:
      tags:
      - Organizations
      summary: List invitations for the current organization
      description: Lists pending and historical invitations for the current organization, including recipient, role, status, and expiration.
      operationId: Organizations_GetCurrentOrganizationInvitations
      responses:
        '200':
          description: Returns the list of organization invitation table row.
          content:
            application/json:
              schema:
                type: array
                items:
                  allOf:
                  - $ref: '#/components/schemas/OrganizationInvitationTableRow'
                  description: Describes organization invitation data used in Leadping API requests and responses.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
        '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.
      security:
      - Bearer: []
    post:
      tags:
      - Organizations
      summary: Create a current-organization user invitation
      description: Creates an invitation for the current organization so another user can join with the requested role and account access.
      operationId: Organizations_CreateCurrentOrganizationInvitation
      requestBody:
        description: The invitation recipient and requested role.
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationInvitationRequest'
              description: Defines the input used for organization invitation.
          application/*+json:
            schema:
              allOf:
              - $ref: '#/components/schemas/OrganizationInvitationRequest'
              description: Defines the input used for organization invitation.
        required: true
      responses:
        '200':
          description: Returns the organization invitation response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationInvitationResponse'
                description: Describes organization invitation data returned by Leadping.
        '400':
          description: The request was invalid or failed validation.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '401':
          description: Authentication credentials are missing or invalid.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ProblemDetails'
                description: Standard problem-details response containing machine-readable and human-readable information about an HTTP API error.
        '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.
        '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.
      security:
      - Bearer: []
  /organizations/me/invitations/{invitationId}/resend:
    post:
      tags:
      - Organizations
      summary: Resend a current-organization user invitation
      description: Resends a pending current-organization invitation, refreshing delivery while preserving recipient, role, and acceptance token.
      operationId: Organizations_ResendCurrentOrganizationInvitation
      parameters:
      - name: invitationId
        in: path
        description: The ID of the current-organization invitation to resend.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns the organization invitation response.
          content:
            text/plain:
              schema:
                allOf:
                - $ref: '#/components/schemas/OrganizationInvitationResponse'
                description: Describes organization invitation data returned by Leadping.
            application/json:
              schema:
                allOf:
 

# --- truncated at 32 KB (117 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/leadping/refs/heads/main/openapi/leadping-organizations-api-openapi.yml