Live Direct Marketing

Live Direct Marketing Users API

The Users API from Live Direct Marketing — 12 operation(s) for users.

GitHub OpenAPI

Operations 15

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

POST /api/users/me/accept-terms Accept the legal terms as the current user · Accept legal terms for the current user #
Ask an LLM
“How do I accept the terms of service for my user?”
“Can I record that I agreed to the legal terms from my profile?”
Tell an agent
Accept the legal terms for my user.
Mark the terms as accepted on my own account.
GET /api/users List platform users · List users (SUPER/MANAGER) #
Ask an LLM
“Which users are registered on the platform?”
“Can a manager page through all users?”
Tell an agent
List users, page {page}.
Show {pageSize} users per page.
POST /api/users Create a user · Create a user (SUPER only) #
Ask an LLM
“How does a super admin create a new user?”
“Can I assign a role when I create a user?”
Tell an agent
Create a user {email} with password {password}.
Add user {email} with password {password} and role {role}.
GET /api/users/system/stats Get system resource stats · Get system stats (SUPER only) #
Ask an LLM
“What are the current system stats for the platform server?”
“Can a super admin see system-level resource usage?”
Tell an agent
Show the system stats.
Get current server resource statistics.
POST /api/users/system/kill-process/{pid} Kill a system process · Kill a system process by pid (SUPER only) #
Ask an LLM
“Can a super admin kill a stuck process on the server?”
“How do I terminate a system process by its pid?”
Tell an agent destructive · confirm first
Kill system process {pid}.
Terminate the server process with pid {pid}.
POST /api/users/system/cleanup-orphans Clean up orphaned system resources · Cleanup orphan system resources (SUPER only) #
Ask an LLM
“Can I clean up orphaned resources left on the system?”
“What removes leftover orphan processes or resources?”
Tell an agent destructive · confirm first
Clean up orphaned system resources.
Remove the orphan resources left on the server.
GET /api/users/{id} Get a user · Get a user by id (SUPER/MANAGER) #
Ask an LLM
“What details does the platform hold for a specific user?”
“Can a manager look up one user by id?”
Tell an agent
Get user {id}.
Show the record for user {id}.
DELETE /api/users/{id} Delete a user and clean up their tenants · Delete a user with tenant cleanup: sole-member tenants + their DBs are dropped… #
Ask an LLM
“What happens to a user's tenants when I delete the user?”
“Does deleting a user drop tenants where they are the only member?”
Tell an agent destructive · confirm first
Delete user {id}.
Remove user {id} and clean up their sole-member tenants.
PATCH /api/users/{id}/role Change a user's role · Update a user role (SUPER/MANAGER) #
Ask an LLM
“How do I promote a user to a different role?”
“Can a manager change someone's role?”
Tell an agent
Change the role of user {id} to {role}.
Give user {id} the {role} role.
PATCH /api/users/{id}/status Change a user's status · Update a user status (SUPER/MANAGER) #
Ask an LLM
“Can I block or reactivate a user by changing their status?”
“How do I set a user's account status?”
Tell an agent
Set the status of user {id} to {status}.
Change user {id} to status {status}.
PATCH /api/users/{id}/password Set a user's password · Update a user password (SUPER only) #
Ask an LLM
“Can a super admin reset another user's password?”
“How do I set a new password for a user?”
Tell an agent
Set the password of user {id} to {password}.
Reset user {id}'s password to {password}.
PATCH /api/users/{id}/profile Update a user's name · Update a user profile (SUPER only) #
Ask an LLM
“Can I correct a user's first or last name?”
“Which profile fields can a super admin edit on a user?”
Tell an agent
Rename user {id} to {firstName} {lastName}.
Update the profile of user {id}.
GET /api/users/{id}/comments List admin comments on a user · List admin comments on a user (SUPER/MANAGER) #
Ask an LLM
“What notes have admins left about a user?”
“Can I read the internal comments on someone's account?”
Tell an agent
List admin comments on user {id}.
Show the internal notes about user {id}.
POST /api/users/{id}/comments Add an admin comment on a user · Add an admin comment on a user (SUPER/MANAGER) #
Ask an LLM
“How do I leave an internal note on a user's account?”
“Can managers add comments about a user?”
Tell an agent
Add an admin comment to user {id}.
Leave an internal note on user {id}.
DELETE /api/users/{id}/comments/{commentId} Delete an admin comment on a user · Delete an admin comment on a user (SUPER only) #
Ask an LLM
“Can I remove an admin note from a user?”
“Who is allowed to delete comments on a user?”
Tell an agent destructive · confirm first
Delete comment {commentId} on user {id}.
Remove admin note {commentId} from user {id}.

Documentation

📖
Documentation
https://developers.live-direct-marketing.online/
📖
APIReference
https://developers.live-direct-marketing.online/api-reference
📖
GettingStarted
https://developers.live-direct-marketing.online/quickstart
📖
Authentication
https://developers.live-direct-marketing.online/authentication
📖
Documentation
https://check.live-direct-marketing.online/docs
📖
APIReference
https://check.live-direct-marketing.online/api/docs

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/live-direct-marketing-online/refs/heads/main/openapi/live-direct-marketing-online-users-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/live-direct-marketing-online/refs/heads/main/data-model/live-direct-marketing-online-data-model.yml

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/live-direct-marketing-online:live-direct-marketing-online-users-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

live-direct-marketing-online-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: LDM v3 Users API
  description: 'Multi-tenant B2B outreach automation platform. Auth: JWT Bearer (15-min) or tenant API key (ldm_*) managed in CRM Settings → API Keys. All tenant-scoped endpoints require the X-Tenant-Id header.'
  version: 1.0.0
  contact: {}
servers:
- url: https://api.live-direct-marketing.online
  description: Production
- url: https://api.dev.live-direct-marketing.online
  description: Development
- url: http://127.0.0.1:3000
  description: Local
tags:
- name: Users
paths:
  /api/users/me/accept-terms:
    post:
      operationId: UsersController_acceptTerms
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Accept legal terms for the current user
      tags:
      - Users
      x-required-scope:
      - users:write
  /api/users:
    get:
      operationId: UsersController_findAll
      parameters:
      - name: page
        required: true
        in: query
        schema:
          type: number
      - name: pageSize
        required: true
        in: query
        schema:
          type: number
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: List users (SUPER/MANAGER)
      tags:
      - Users
    post:
      operationId: UsersController_createUser
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Create a user (SUPER only)
      tags:
      - Users
  /api/users/system/stats:
    get:
      operationId: UsersController_systemStats
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Get system stats (SUPER only)
      tags:
      - Users
      x-required-scope:
      - users:read
  /api/users/system/kill-process/{pid}:
    post:
      operationId: UsersController_killProcess
      parameters:
      - name: pid
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Kill a system process by pid (SUPER only)
      tags:
      - Users
  /api/users/system/cleanup-orphans:
    post:
      operationId: UsersController_cleanupOrphans
      parameters:
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Cleanup orphan system resources (SUPER only)
      tags:
      - Users
      x-required-scope:
      - users:write
  /api/users/{id}:
    get:
      operationId: UsersController_findById
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Get a user by id (SUPER/MANAGER)
      tags:
      - Users
    delete:
      operationId: UsersController_deleteUser
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: 'Delete a user with tenant cleanup: sole-member tenants + their DBs are dropped…'
      tags:
      - Users
  /api/users/{id}/role:
    patch:
      operationId: UsersController_updateRole
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRoleDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Update a user role (SUPER/MANAGER)
      tags:
      - Users
  /api/users/{id}/status:
    patch:
      operationId: UsersController_updateStatus
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateStatusDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Update a user status (SUPER/MANAGER)
      tags:
      - Users
  /api/users/{id}/password:
    patch:
      operationId: UsersController_updatePassword
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePasswordDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Update a user password (SUPER only)
      tags:
      - Users
  /api/users/{id}/profile:
    patch:
      operationId: UsersController_updateProfile
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateProfileDto'
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Update a user profile (SUPER only)
      tags:
      - Users
  /api/users/{id}/comments:
    get:
      operationId: UsersController_listComments
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: List admin comments on a user (SUPER/MANAGER)
      tags:
      - Users
    post:
      operationId: UsersController_addComment
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddCommentDto'
      responses:
        '201':
          description: ''
      security:
      - jwt: []
      summary: Add an admin comment on a user (SUPER/MANAGER)
      tags:
      - Users
  /api/users/{id}/comments/{commentId}:
    delete:
      operationId: UsersController_deleteComment
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: commentId
        required: true
        in: path
        schema:
          type: string
      - name: X-Tenant-Id
        in: header
        required: false
        schema:
          type: string
          format: uuid
        description: Tenant UUID — required for all tenant-scoped endpoints
      responses:
        '200':
          description: ''
      security:
      - jwt: []
      summary: Delete an admin comment on a user (SUPER only)
      tags:
      - Users
components:
  schemas:
    UpdateRoleDto:
      type: object
      properties:
        role:
          type: object
      required:
      - role
    UpdateStatusDto:
      type: object
      properties:
        status:
          type: object
      required:
      - status
    UpdateProfileDto:
      type: object
      properties:
        firstName:
          type: string
        lastName:
          type: string
    AddCommentDto:
      type: object
      properties: {}
    UpdatePasswordDto:
      type: object
      properties:
        password:
          type: string
          minLength: 8
      required:
      - password
    CreateUserDto:
      type: object
      properties:
        email:
          type: string
          format: email
        password:
          type: string
          minLength: 8
        firstName:
          type: string
        lastName:
          type: string
        role:
          type: object
      required:
      - email
      - password
  securitySchemes:
    jwt:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: JWT access token from /auth/login (Bearer <token>)
    tenant-api-key:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Tenant API key (Bearer ldm_*) for MCP/A2A clients. Issued via CRM Settings → API Keys.
    rpa-service:
      scheme: bearer
      bearerFormat: JWT
      type: http
      description: Dedicated RPA service key. No tenant API-key or query-key authentication.