The Conduyt CRM API provides programmatic access to your CRM data including
contacts, companies, deals, pipelines, tasks, notes, automations, invoices,
email sequences, and more.
Authentication
All authenticated endpoints require a Bearer token (API key) in the
Authorization header:
Authorization: Bearer cdy_<your-api-key>
API keys are generated in Settings > API Keys within the Conduyt
dashboard. Keys use the cdy_ prefix and are hashed with bcrypt on
creation — the full key is shown exactly once at creation time.
Session cookie authentication (conduyt_session) is also supported for
browser-based clients but is not recommended for integrations.
Rate Limiting
Most write endpoints enforce per-IP rate limits. When exceeded, the API
returns 429 Too Many Requests with a Retry-After header indicating
seconds until the next allowed request.
| Endpoint Group | Limit |
|---|
| Login | 5 / 15 min per IP |
| Registration | 3 / hour per IP |
| Contact/Deal create | 30 / min per IP |
| General | 100 / 15 min per IP |
Pagination
List endpoints support cursor-based pagination via query parameters:
page — Page number (default: 1)per_page — Items per page (default: 50, max: 200)
Responses include a meta object: { page, per_page, total }.
Response Format
All successful responses wrap data in a data envelope:
{ "data": { ... } }
Error responses use:
{ "error": "Human-readable error message" }
Multi-Tenancy
Conduyt is multi-tenant. All data is scoped to the authenticated user's
current account. API keys are bound to a specific account at creation time.
Webhook Events
Outbound webhooks fire on events including:
contact.created, contact.updated, contact.deleted,
deal.created, deal.updated, deal.won, deal.lost,
task.created, task.completed, note.created,
appointment.created, appointment.updated,
form.submitted, invoice.paid
Payloads are signed with HMAC-SHA256 using the webhook's secret. Retries
follow exponential backoff: 1m, 5m, 15m, 1h, 6h, 24h, 72h (7 attempts).
Learn more at Conduyt Crm.
Quick Start
1. Install
See Install above.
2. Set Up Credentials
Get your access token from your API provider's developer portal, then store it:
conduyt-crm-pp-cli auth set-token YOUR_TOKEN_HERE
Or set it via environment variable:
export CONDUYT_BEARER_AUTH="your-token-here"
3. Verify Setup
conduyt-crm-pp-cli doctor
This checks your configuration and credentials.
4. Try Your First Command
conduyt-crm-pp-cli activities list
Usage
Run conduyt-crm-pp-cli --help for the full command reference and flag list.
Commands
activities
Activity feed and logging
conduyt-crm-pp-cli activities create-activity - Log an activityconduyt-crm-pp-cli activities list - List activities
admin
Super-admin account management and impersonation
conduyt-crm-pp-cli admin clean-test-accounts - Delete test accountsconduyt-crm-pp-cli admin clean-test-data - Clean test data from the systemconduyt-crm-pp-cli admin impersonate - Impersonate a user (super-admin)conduyt-crm-pp-cli admin list-accounts - List all accounts (super-admin)conduyt-crm-pp-cli admin stop-impersonate - Stop impersonatingconduyt-crm-pp-cli admin toggle-comp - Toggle comp (free) status for an account
ai
AI-powered features (chat, email compose, contact enrichment)
conduyt-crm-pp-cli ai chat - AI chat assistantconduyt-crm-pp-cli ai compose-email - AI-assisted email compositionconduyt-crm-pp-cli ai deal-insights - AI-generated deal insights and recommendationsconduyt-crm-pp-cli ai enrich-contact - AI-powered contact data enrichmentconduyt-crm-pp-cli ai improve-email - AI-assisted email improvementconduyt-crm-pp-cli ai summarize-contact - AI-generated contact summary
api-keys
API key management
conduyt-crm-pp-cli api-keys create - Returns the full key exactly once. Store it securely.conduyt-crm-pp-cli api-keys list - Returns API key metadata. Never returns the full key.conduyt-crm-pp-cli api-keys revoke - Revoke an API key
appointments
Appointment scheduling
conduyt-crm-pp-cli appointments create - Create an appointmentconduyt-crm-pp-cli appointments delete - Delete an appointmentconduyt-crm-pp-cli appointments get - Get an appointment by IDconduyt-crm-pp-cli appointments list - List all appointmentsconduyt-crm-pp-cli appointments update - Update an appointment
automation-executions
Automation execution logs and step details
conduyt-crm-pp-cli automation-executions get - Get execution details by IDconduyt-crm-pp-cli automation-executions list - List automation execution logs
automations
Workflow automations (native + n8n), publishing, analytics
conduyt-crm-pp-cli automations create - Create an automationconduyt-crm-pp-cli automations create-from-template - Create automation from a templateconduyt-crm-pp-cli automations delete - Delete an automationconduyt-crm-pp-cli automations get - Get an automation by IDconduyt-crm-pp-cli automations list - List automationsconduyt-crm-pp-cli automations list-actions - List available automation actionsconduyt-crm-pp-cli automations list-condition-fields - List available condition fields for triggersconduyt-crm-pp-cli automations list-events - List available trigger eventsconduyt-crm-pp-cli automations list-templates - List automation templatesconduyt-crm-pp-cli automations test-webhook - Send a test payload to an automation's webhook URLconduyt-crm-pp-cli automations update - Update an automation
availability
Manage availability
conduyt-crm-pp-cli availability get - Get current user's availability rulesconduyt-crm-pp-cli availability set - Set availability rules
billing
Stripe billing, checkout, and subscription status
conduyt-crm-pp-cli billing create-checkout-session - Create a Stripe checkout sessionconduyt-crm-pp-cli billing create-portal - Create a Stripe billing portal sessionconduyt-crm-pp-cli billing get-status - Get subscription statusconduyt-crm-pp-cli billing webhook-stripe - Stripe billing webhook
booking-pages
Public booking pages (Calendly-style)
conduyt-crm-pp-cli booking-pages create - Create a booking pageconduyt-crm-pp-cli booking-pages delete - Delete a booking pageconduyt-crm-pp-cli booking-pages get - Get a booking page by IDconduyt-crm-pp-cli booking-pages list - List booking pagesconduyt-crm-pp-cli booking-pages update - Update a booking page
bulk
Manage bulk
conduyt-crm-pp-cli bulk delete-contacts - Bulk delete contactsconduyt-crm-pp-cli bulk edit-contacts - Bulk edit contact fieldsconduyt-crm-pp-cli bulk edit-deals - Bulk edit deal fieldsconduyt-crm-pp-cli bulk get-status - Get bulk operation statusconduyt-crm-pp-cli bulk tag-contacts - Bulk add/remove tags on contactsconduyt-crm-pp-cli bulk update-contacts - Bulk update contacts with field valuesconduyt-crm-pp-cli bulk update-deals - Bulk update deals
calendar
Internal calendar and appointment management
conduyt-crm-pp-cli calendar connect-google - Initiate Google Calendar OAuthconduyt-crm-pp-cli calendar connect-microsoft - Initiate Microsoft Calendar OAuthconduyt-crm-pp-cli calendar create-event - Create an event on a connected calendarconduyt-crm-pp-cli calendar delete-connection - Disconnect a calendarconduyt-crm-pp-cli calendar delete-event - Delete a synced calendar eventconduyt-crm-pp-cli calendar get-connection - Get a calendar connection by IDconduyt-crm-pp-cli calendar get-event - Get a synced calendar eventconduyt-crm-pp-cli calendar google-callback - Google Calendar OAuth callbackconduyt-crm-pp-cli calendar list-connections - List calendar connectionsconduyt-crm-pp-cli calendar list-events - List synced calendar eventsconduyt-crm-pp-cli calendar microsoft-callback - Microsoft Calendar OAuth callbackconduyt-crm-pp-cli calendar sync - Trigger manual calendar syncconduyt-crm-pp-cli calendar update-event - Update a synced calendar eventconduyt-crm-pp-cli calendar webhook-google - Google Calendar push notification webhookconduyt-crm-pp-cli calendar webhook-microsoft - Microsoft Calendar webhook
calendars
Internal calendar and appointment management
conduyt-crm-pp-cli calendars create - Create a calendarconduyt-crm-pp-cli calendars get - Get a calendar by IDconduyt-crm-pp-cli calendars list - List internal calendarsconduyt-crm-pp-cli calendars update - Update a calendar
calls
Call log management
conduyt-crm-pp-cli calls create-record - Create a call recordconduyt-crm-pp-cli calls get - Get a call by IDconduyt-crm-pp-cli calls list - List call recordsconduyt-crm-pp-cli calls update - Update a call record (e.g., add notes)
chat
Internal team chat channels and messages
conduyt-crm-pp-cli chat add-member - Add a member to a channelconduyt-crm-pp-cli chat add-reaction - Add a reaction to a messageconduyt-crm-pp-cli chat create-channel - Create a chat channelconduyt-crm-pp-cli chat delete-message - Delete a chat messageconduyt-crm-pp-cli chat edit-message - Edit a chat messageconduyt-crm-pp-cli chat get-message - Get a chat message by IDconduyt-crm-pp-cli chat get-typing-status - Get who is currently typingconduyt-crm-pp-cli chat list-channels - List chat channelsconduyt-crm-pp-cli chat list-messages - List messages in a channelconduyt-crm-pp-cli chat remove-member - Remove a member from a channelconduyt-crm-pp-cli chat remove-reaction - Remove a reaction from a messageconduyt-crm-pp-cli chat send-message - Send a message in a channelconduyt-crm-pp-cli chat send-typing-indicator - Send a typing indicatorconduyt-crm-pp-cli chat upload-file - Upload a file to a channel
companies
Company (organization) management
conduyt-crm-pp-cli companies create-company - Create a companyconduyt-crm-pp-cli companies delete-company - Soft-delete a companyconduyt-crm-pp-cli companies get-company - Get a company by IDconduyt-crm-pp-cli companies list - List companiesconduyt-crm-pp-cli companies update-company - Update a company
conduyt-auth
Manage conduyt auth
conduyt-crm-pp-cli conduyt-auth accept-invite - Accept a team invitationconduyt-crm-pp-cli conduyt-auth change-password - Change password (authenticated)conduyt-crm-pp-cli conduyt-auth forgot-password - Request a password reset emailconduyt-crm-pp-cli conduyt-auth get-me - Get current authenticated userconduyt-crm-pp-cli conduyt-auth login - Authenticates user credentials and returns a session cookie. Rate limited to 5 requests per 15 minutes per IP.conduyt-crm-pp-cli conduyt-auth logout - Log out (destroy session)conduyt-crm-pp-cli conduyt-auth register - Creates a new user and account. Rate limited to 3 requests per hour per IP.conduyt-crm-pp-cli conduyt-auth reset-password - Reset password with tokenconduyt-crm-pp-cli conduyt-auth switch-account - Switch to a different account
conduyt-search
Manage conduyt search
conduyt-crm-pp-cli conduyt-search global - Global search across contacts, companies, and deals
contact
Contact management, tagging, scoring, import/export, merge, duplicates
conduyt-crm-pp-cli contact upsert - Creates or updates a contact by email or phone match. Designed for inbound webhook integrations.
contacts
Contact management, tagging, scoring, import/export, merge, duplicates
conduyt-crm-pp-cli contacts create - Creates a new contact. Rate limited to 30 requests per minute.conduyt-crm-pp-cli contacts delete - Soft-delete a contactconduyt-crm-pp-cli contacts export - Export contacts as CSVconduyt-crm-pp-cli contacts find-duplicate - Find duplicate contactsconduyt-crm-pp-cli contacts get - Get a contact by IDconduyt-crm-pp-cli contacts get-import-template - Download CSV import templateconduyt-crm-pp-cli contacts import - Import contacts from CSVconduyt-crm-pp-cli contacts list - Returns a paginated list of contacts. Supports search, filtering by tag,
source, company, assigned user, date ranges, lead score, and smart views.
Smart views: needs_follow_up, hot_leads, new_this_week,
recently_won, untagged, missing_email, missing_phone.
conduyt-crm-pp-cli contacts list-smart-views - List available smart view definitionsconduyt-crm-pp-cli contacts merge - Merge two contactsconduyt-crm-pp-cli contacts update - Update a contact
conversations
Threaded conversation view per contact
conduyt-crm-pp-cli conversations get - Get conversation thread for a contactconduyt-crm-pp-cli conversations list - List conversation threads
custom-fields
Custom field definitions for contacts and deals
conduyt-crm-pp-cli custom-fields create - Create a custom field definitionconduyt-crm-pp-cli custom-fields delete - Delete a custom field definitionconduyt-crm-pp-cli custom-fields list - List custom field definitionsconduyt-crm-pp-cli custom-fields update - Update a custom field definition
dashboard
Dashboard summary metrics
conduyt-crm-pp-cli dashboard get - Get dashboard summary metrics
deals
Deal/opportunity management within pipelines
conduyt-crm-pp-cli deals create - Creates a new deal in a pipeline stage. Rate limited to 30 requests per minute.conduyt-crm-pp-cli deals delete - Soft-delete a dealconduyt-crm-pp-cli deals get - Get a deal by IDconduyt-crm-pp-cli deals list - Returns deals with Kanban-optimized sort order (stage, sortOrder, then requested sort).conduyt-crm-pp-cli deals update - Update a deal
dialer
Click-to-call dialer via Twilio
conduyt-crm-pp-cli dialer get-history - Get recent call historyconduyt-crm-pp-cli dialer get-token - Get a Twilio browser token for click-to-callconduyt-crm-pp-cli dialer initiate-call - Initiate an outbound call
document-templates
Proposal and contract templates with merge fields
conduyt-crm-pp-cli document-templates create - Create a document templateconduyt-crm-pp-cli document-templates delete - Delete a document templateconduyt-crm-pp-cli document-templates get - Get a document template by IDconduyt-crm-pp-cli document-templates list - List document templatesconduyt-crm-pp-cli document-templates update - Update a document template
drip-campaigns
SMS drip campaign engine
conduyt-crm-pp-cli drip-campaigns create - Create a drip campaignconduyt-crm-pp-cli drip-campaigns delete - Delete a drip campaignconduyt-crm-pp-cli drip-campaigns list - List SMS drip campaignsconduyt-crm-pp-cli drip-campaigns seed - Seed default drip campaignsconduyt-crm-pp-cli drip-campaigns update - Update a drip campaign
drip-enrollments
Manage drip enrollments
conduyt-crm-pp-cli drip-enrollments list - List drip enrollments
email
Send individual and bulk emails
conduyt-crm-pp-cli email send - Send an email to a contactconduyt-crm-pp-cli email send-bulk - Send bulk emails
email-domains
Custom email domain verification (Resend)
conduyt-crm-pp-cli email-domains add - Add a custom email domainconduyt-crm-pp-cli email-domains get - Get email domain configurationconduyt-crm-pp-cli email-domains remove - Remove email domainconduyt-crm-pp-cli email-domains update - Update email domain settingsconduyt-crm-pp-cli email-domains verify - Verify DNS configuration for email domain
emails
Send individual and bulk emails
conduyt-crm-pp-cli emails create-sequence - Create an email sequenceconduyt-crm-pp-cli emails create-template - Create an email templateconduyt-crm-pp-cli emails delete-template - Delete an email templateconduyt-crm-pp-cli emails enroll-in-sequence - Enroll contacts in a sequenceconduyt-crm-pp-cli emails get-sequence - Get an email sequence by IDconduyt-crm-pp-cli emails get-sequence-stats - Get sequence performance statsconduyt-crm-pp-cli emails get-template - Get an email template by IDconduyt-crm-pp-cli emails list - List email messagesconduyt-crm-pp-cli emails list-sequence-enrollments - List enrollments for a sequenceconduyt-crm-pp-cli emails list-sequences - List email sequencesconduyt-crm-pp-cli emails list-templates - List email templatesconduyt-crm-pp-cli emails test-send-template - Send a test email from a templateconduyt-crm-pp-cli emails unenroll-from-sequence - Unenroll contacts from a sequenceconduyt-crm-pp-cli emails update-sequence - Update an email sequenceconduyt-crm-pp-cli emails update-template - Update an email template
files
File uploads and attachments
conduyt-crm-pp-cli files create-record - Create a file attachment recordconduyt-crm-pp-cli files delete - Delete a file attachmentconduyt-crm-pp-cli files list - List file attachmentsconduyt-crm-pp-cli files upload - Upload a file
forms
Lead capture forms and submissions
conduyt-crm-pp-cli forms create - Create a formconduyt-crm-pp-cli forms delete - Delete a formconduyt-crm-pp-cli forms get - Get a form by IDconduyt-crm-pp-cli forms list - List formsconduyt-crm-pp-cli forms update - Update a form
imports
CSV import jobs with mapping and deduplication
conduyt-crm-pp-cli imports create - Create an import jobconduyt-crm-pp-cli imports get - Get import job statusconduyt-crm-pp-cli imports list - List import jobsconduyt-crm-pp-cli imports upload-file - Upload a CSV file for import
integrations
Third-party integrations (Zapier, etc.)
conduyt-crm-pp-cli integrations connect - Connect an integrationconduyt-crm-pp-cli integrations create-zapier-subscription - Create a Zapier webhook subscriptionconduyt-crm-pp-cli integrations delete-zapier-subscription - Delete a Zapier subscriptionconduyt-crm-pp-cli integrations disconnect - Disconnect an integrationconduyt-crm-pp-cli integrations get-zapier-sample-data - Get sample data for a Zapier eventconduyt-crm-pp-cli integrations list - List active integrationsconduyt-crm-pp-cli integrations list-zapier-subscriptions - List Zapier webhook subscriptions
invoices
Invoice creation, sending, payments, PDF generation
conduyt-crm-pp-cli invoices create - Create an invoiceconduyt-crm-pp-cli invoices delete - Delete an invoiceconduyt-crm-pp-cli invoices get - Get an invoice by IDconduyt-crm-pp-cli invoices get-next-number - Get the next auto-incremented invoice numberconduyt-crm-pp-cli invoices list - List invoicesconduyt-crm-pp-cli invoices update - Update an invoice
messages
SMS and email message history
conduyt-crm-pp-cli messages create - Create a message recordconduyt-crm-pp-cli messages get-sms - Get an SMS message by IDconduyt-crm-pp-cli messages list - List messagesconduyt-crm-pp-cli messages send-sms - Send an SMS message
notes
Notes attached to contacts or deals
conduyt-crm-pp-cli notes create - Body is capped at 50 KB. Returns 413 if exceeded.conduyt-crm-pp-cli notes delete - Delete a noteconduyt-crm-pp-cli notes get - Get a note by IDconduyt-crm-pp-cli notes list - List notesconduyt-crm-pp-cli notes update - Update a note
notifications
In-app notifications
conduyt-crm-pp-cli notifications create - Create a notificationconduyt-crm-pp-cli notifications list - List notificationsconduyt-crm-pp-cli notifications mark-all-read - Mark all notifications as readconduyt-crm-pp-cli notifications mark-read - Mark a notification as read
pipelines
Sales pipeline and stage management
conduyt-crm-pp-cli pipelines create - Requires owner or admin role. Subject to plan limits.conduyt-crm-pp-cli pipelines delete - Delete a pipelineconduyt-crm-pp-cli pipelines get - Get a pipeline by IDconduyt-crm-pp-cli pipelines list - List pipelines with stagesconduyt-crm-pp-cli pipelines update - Update a pipeline
products
Product catalog for invoices
conduyt-crm-pp-cli products create - Create a productconduyt-crm-pp-cli products delete - Delete a productconduyt-crm-pp-cli products get - Get a product by IDconduyt-crm-pp-cli products list - List productsconduyt-crm-pp-cli products update - Update a product
public
Unauthenticated public endpoints (booking, form submit)
conduyt-crm-pp-cli public book-appointment - Book an appointment via public pageconduyt-crm-pp-cli public get-booking-page - Get a public booking page by slugconduyt-crm-pp-cli public get-booking-slots - Get available time slots for a booking page
push
Manage push
conduyt-crm-pp-cli push get-public-key - Get VAPID public key for web pushconduyt-crm-pp-cli push subscribe - Subscribe to web push notificationsconduyt-crm-pp-cli push unsubscribe - Unsubscribe from web push
reports
Pipeline, revenue, activity, team, and custom reports
conduyt-crm-pp-cli reports create-custom - Create a custom reportconduyt-crm-pp-cli reports delete-custom - Delete a custom reportconduyt-crm-pp-cli reports get-activity - Activity reportconduyt-crm-pp-cli reports get-custom - Get a custom report by IDconduyt-crm-pp-cli reports get-pipeline - Pipeline performance reportconduyt-crm-pp-cli reports get-revenue - Revenue reportconduyt-crm-pp-cli reports get-team - Team performance reportconduyt-crm-pp-cli reports list-custom - List saved custom reportsconduyt-crm-pp-cli reports run-custom - Execute a custom report and return resultsconduyt-crm-pp-cli reports update-custom - Update a custom report
scoring-rules
Lead scoring rule management
conduyt-crm-pp-cli scoring-rules create - Create a scoring ruleconduyt-crm-pp-cli scoring-rules delete - Delete a scoring ruleconduyt-crm-pp-cli scoring-rules list - List lead scoring rulesconduyt-crm-pp-cli scoring-rules recalculate-scores - Recalculate all contact scoresconduyt-crm-pp-cli scoring-rules update - Update a scoring rule
settings
Account settings, branding, SMS/Twilio configuration
conduyt-crm-pp-cli settings get - Get account settingsconduyt-crm-pp-cli settings get-branding - Get white-label branding settingsconduyt-crm-pp-cli settings get-sms - Get SMS provider settingsconduyt-crm-pp-cli settings get-twilio - Get Twilio configurationconduyt-crm-pp-cli settings test-integration - Test an integration connectionconduyt-crm-pp-cli settings test-sms - Send a test SMSconduyt-crm-pp-cli settings test-twilio - Test Twilio configurationconduyt-crm-pp-cli settings update - Update account settingsconduyt-crm-pp-cli settings update-branding - Update white-label brandingconduyt-crm-pp-cli settings update-sms - Update SMS provider settingsconduyt-crm-pp-cli settings update-twilio - Update Twilio configuration
smart-lists
Static contact lists
conduyt-crm-pp-cli smart-lists create - Create a smart listconduyt-crm-pp-cli smart-lists list - List smart lists (static contact lists)conduyt-crm-pp-cli smart-lists update - Update a smart list
tags
Tag management and merging
conduyt-crm-pp-cli tags create - Create a tagconduyt-crm-pp-cli tags delete - Delete a tagconduyt-crm-pp-cli tags list - List tagsconduyt-crm-pp-cli tags merge - Merge two tagsconduyt-crm-pp-cli tags update - Update a tag
tasks
Task management with assignment and due dates
conduyt-crm-pp-cli tasks create - Create a taskconduyt-crm-pp-cli tasks delete - Delete a taskconduyt-crm-pp-cli tasks get - Get a task by IDconduyt-crm-pp-cli tasks list - List tasksconduyt-crm-pp-cli tasks update - Update a task
users
Team member management and invitations
conduyt-crm-pp-cli users get - Get a team member by IDconduyt-crm-pp-cli users invite - Invite a team memberconduyt-crm-pp-cli users list - List team membersconduyt-crm-pp-cli users remove - Remove a team memberconduyt-crm-pp-cli users update - Update a team member
webhook-logs
Manage webhook logs
conduyt-crm-pp-cli webhook-logs list - List webhook delivery logs
webhooks
Outbound webhook management and logs
conduyt-crm-pp-cli webhooks create - URL is validated for SSRF protection. HMAC signing secret is auto-generated.conduyt-crm-pp-cli webhooks delete - Delete a webhookconduyt-crm-pp-cli webhooks get - Get a webhook by IDconduyt-crm-pp-cli webhooks inbound-contact - Inbound webhook for contact dataconduyt-crm-pp-cli webhooks inbound-deal - Inbound webhook for deal dataconduyt-crm-pp-cli webhooks list - List outbound webhooksconduyt-crm-pp-cli webhooks list-endpoints - List configured webhook endpointsconduyt-crm-pp-cli webhooks messages - Inbound webhook for message eventsconduyt-crm-pp-cli webhooks receive - Receive an inbound webhook payloadconduyt-crm-pp-cli webhooks sms-inbound - Twilio inbound SMS webhookconduyt-crm-pp-cli webhooks sms-status - Twilio SMS status callbackconduyt-crm-pp-cli webhooks stripe-invoice - Stripe invoice webhookconduyt-crm-pp-cli webhooks test - Send a test payload to a webhookconduyt-crm-pp-cli webhooks update - Update a webhookconduyt-crm-pp-cli webhooks voice-inbound - Twilio inbound voice webhookconduyt-crm-pp-cli webhooks voice-recording - Twilio recording callbackconduyt-crm-pp-cli webhooks voice-status - Twilio voice status callbackconduyt-crm-pp-cli webhooks voice-voicemail - Twilio voicemail callback
workflows
Simple trigger-action workflows
conduyt-crm-pp-cli workflows create - Create a workflowconduyt-crm-pp-cli workflows delete - Delete a workflowconduyt-crm-pp-cli workflows get - Get a workflow by IDconduyt-crm-pp-cli workflows list - List workflowsconduyt-crm-pp-cli workflows update - Update a workflow
Output Formats
# Human-readable table (default in terminal, JSON when piped)
conduyt-crm-pp-cli activities list
# JSON for scripting and agents
conduyt-crm-pp-cli activities list --json
# Filter to specific fields
conduyt-crm-pp-cli activities list --json --select id,name,status
# Dry run — show the request without sending
conduyt-crm-pp-cli activities list --dry-run
# Agent mode — JSON + compact + no prompts in one flag
conduyt-crm-pp-cli activities list --agent
Agent Usage
This CLI is designed for AI agent consumption:
- Non-interactive - never prompts, every input is a flag
- Pipeable -
--json output to stdout, errors to stderr
- Filterable -
--select id,name returns only fields you need
- Previewable -
--dry-run shows the request without sending
- Explicit retries - add
--idempotent to create retries and --ignore-missing to delete retries when a no-op success is acceptable
- Confirmable -
--yes for explicit confirmation of destructive actions
- Piped input - write commands can accept structured input when their help lists
--stdin
- Offline-friendly - sync/search commands can use the local SQLite store when available
- Agent-safe by default - no colors or formatting unless
--human-friendly is set
Exit codes: 0 success, 2 usage error, 3 not found, 4 auth error, 5 API error, 7 rate limited, 10 config error.
Health Check
conduyt-crm-pp-cli doctor
Verifies configuration, credentials, and connectivity to the API.
Configuration
Config file: ~/.config/conduyt-pp-cli/config.toml
Static request headers can be configured under headers; per-command header overrides take precedence.
Environment variables:
| Name | Kind | Required | Description |
|---|
CONDUYT_BEARER_AUTH | per_call | Yes | Set to your API credential. |
Troubleshooting
Authentication errors (exit code 4)
- Run
conduyt-crm-pp-cli doctor to check credentials
- Verify the environment variable is set:
echo $CONDUYT_BEARER_AUTH
Not found errors (exit code 3)
- Check the resource ID is correct
- Run the
list command to see available items
Generated by CLI Printing Press