CLI: all commands
Every @centerfy/cli command (222 in all), grouped by resource and linked to its endpoint.
Usage is centerfy <resource> <command> [ids…] ['<json>'] (see CLI for setup). '<json>' is the request body or query as one JSON object; ['<json>'] means it is optional. Agency commands need --agency and an agency key. Inside the interactive shell, help <resource> prints the same list with a one-line summary per command.
Contacts
| Command | Endpoint |
|---|---|
centerfy contacts list ['<json>'] | List contacts |
centerfy contacts get <contactId> | Get a contact |
centerfy contacts create '<json>' | Create a contact |
centerfy contacts update <contactId> '<json>' | Update a contact |
centerfy contacts delete <contactId> | Delete a contact |
Tags
| Command | Endpoint |
|---|---|
centerfy tags list | List all tags |
centerfy contacts add-tags <contactId> '<json>' | Add tags to a contact |
centerfy contacts remove-tags <contactId> '<json>' | Remove tags from a contact |
Notes
| Command | Endpoint |
|---|---|
centerfy contacts create-note <contactId> '<json>' | Create a contact note |
centerfy contacts list-notes <contactId> | List contact notes |
centerfy contacts delete-note <contactId> <noteId> | Delete a contact note |
AI Calls
| Command | Endpoint |
|---|---|
centerfy contacts make-ai-call <contactId> '<json>' | Make an AI call to a contact |
Phone numbers
| Command | Endpoint |
|---|---|
centerfy phoneNumbers list | List owned numbers |
centerfy phoneNumbers get <phoneNumberId> | Get a phone number |
centerfy phoneNumbers assign-agent <phoneNumberId> '<json>' | Assign to an agent |
centerfy phoneNumbers unassign-agent <phoneNumberId> | Remove from agent |
Number pools
| Command | Endpoint |
|---|---|
centerfy numberPools list | List number pools |
centerfy numberPools create '<json>' | Create a number pool |
centerfy numberPools get <poolId> | Get a number pool |
centerfy numberPools delete <poolId> | Delete a number pool |
centerfy numberPools update <poolId> '<json>' | Update a number pool |
centerfy numberPools add-number <poolId> '<json>' | Add a number to a pool |
centerfy numberPools remove-number <poolId> <numberId> | Remove a number from a pool |
Voices
| Command | Endpoint |
|---|---|
centerfy voices list ['<json>'] | List voices |
centerfy voices preview '<json>' | Preview a voice |
Agents
| Command | Endpoint |
|---|---|
centerfy agents create '<json>' | Create an agent |
centerfy agents list ['<json>'] | List AI agents |
centerfy agents get <agentId> | Get an agent |
centerfy agents update <agentId> '<json>' | Update an agent |
centerfy agents duplicate <agentId> | Duplicate an agent |
centerfy agents archive <agentId> | Archive an agent |
Agent folders
| Command | Endpoint |
|---|---|
centerfy agentFolders create '<json>' | Create a folder |
centerfy agentFolders list | List folders |
centerfy agentFolders update <folderId> '<json>' | Update a folder |
centerfy agentFolders add-agent <folderId> '<json>' | Assign an agent |
centerfy agentFolders remove-agent <folderId> <agentId> | Remove an agent |
centerfy agentFolders delete <folderId> | Delete a folder |
Tools
| Command | Endpoint |
|---|---|
centerfy agents list-custom-tools <agentId> | List agent custom tools |
centerfy agents assign-custom-tool <agentId> '<json>' | Assign a tool to an agent |
centerfy agents remove-custom-tool <agentId> <toolId> | Remove a tool from an agent |
centerfy customTools create '<json>' | Create a custom tool |
centerfy customTools get <toolId> | Get a custom tool |
centerfy customTools update <toolId> '<json>' | Update a custom tool |
centerfy customTools delete <toolId> | Delete a custom tool |
Knowledge bases
| Command | Endpoint |
|---|---|
centerfy knowledgeBases list | List knowledge bases |
centerfy knowledgeBases create '<json>' | Create a knowledge base |
centerfy knowledgeBases delete <knowledgeBaseId> | Delete a knowledge base |
centerfy knowledgeBases enable <knowledgeBaseId> | Enable a knowledge base |
centerfy knowledgeBases disable <knowledgeBaseId> | Disable a knowledge base |
centerfy knowledgeBases add-text <knowledgeBaseId> '<json>' | Add a text source |
centerfy knowledgeBases add-faq <knowledgeBaseId> '<json>' | Add an FAQ source |
centerfy knowledgeBases add-url <knowledgeBaseId> '<json>' | Add a URL source |
centerfy knowledgeBases add-file <knowledgeBaseId> '{"path":"./file.pdf"}' | Add a file source |
centerfy knowledgeBases delete-source <knowledgeBaseId> <sourceId> | Delete a source |
centerfy agents assign-knowledge-base <agentId> '<json>' | Assign to an agent |
centerfy agents remove-knowledge-base <agentId> <knowledgeBaseId> | Remove from an agent |
Appointments
| Command | Endpoint |
|---|---|
centerfy appointments list '<json>' | List appointments (date range) |
centerfy appointments create '<json>' | Create an appointment |
centerfy appointments get <appointmentId> | Get an appointment |
centerfy appointments update <appointmentId> '<json>' | Update an appointment |
centerfy appointments delete <appointmentId> | Delete an appointment |
Messages
| Command | Endpoint |
|---|---|
centerfy messages send '<json>' | Send a message to a contact |
centerfy messages send-ai '<json>' | Send an AI message to a contact |
centerfy messages list-for-contact <contactId> ['<json>'] | Fetch a contact’s messages |
Conversations
| Command | Endpoint |
|---|---|
centerfy conversations list ['<json>'] | List conversations |
centerfy conversations get <conversationId> | Get a conversation |
centerfy conversations list-messages <conversationId> ['<json>'] | List messages in a conversation |
Calls
| Command | Endpoint |
|---|---|
centerfy calls list ['<json>'] | List call history |
centerfy calls stats ['<json>'] | Call stats for the sub-account |
centerfy calls get <callId> | Get a call (rich detail) |
Pipelines
| Command | Endpoint |
|---|---|
centerfy pipelines list ['<json>'] | List pipelines |
centerfy pipelines create '<json>' | Create a pipeline |
centerfy pipelines get <pipelineId> | Get a pipeline |
centerfy pipelines update <pipelineId> '<json>' | Rename a pipeline |
centerfy pipelines delete <pipelineId> ['<json>'] | Delete a pipeline |
centerfy pipelines create-stage <pipelineId> '<json>' | Add a stage |
centerfy pipelines update-stage <pipelineId> <stageId> '<json>' | Update a stage |
centerfy pipelines delete-stage <pipelineId> <stageId> ['<json>'] | Delete a stage |
Opportunities
| Command | Endpoint |
|---|---|
centerfy opportunities list ['<json>'] | List opportunities |
centerfy opportunities create '<json>' | Create an opportunity |
centerfy opportunities get <opportunityId> | Get an opportunity |
centerfy opportunities update <opportunityId> '<json>' | Update an opportunity |
centerfy opportunities move <opportunityId> '<json>' | Move an opportunity to a stage |
centerfy opportunities delete <opportunityId> | Delete an opportunity |
Companies
| Command | Endpoint |
|---|---|
centerfy companies list ['<json>'] | List companies |
centerfy companies create '<json>' | Create a company |
centerfy companies get <companyId> | Get a company |
centerfy companies update <companyId> '<json>' | Update a company |
centerfy companies delete <companyId> | Delete a company |
centerfy companies contacts <companyId> ['<json>'] | List a company’s contacts |
Smart Lists
| Command | Endpoint |
|---|---|
centerfy smartLists list ['<json>'] | List smart lists |
centerfy smartLists get <smartListId> | Get a smart list |
centerfy smartLists contacts <smartListId> ['<json>'] | List a smart list’s contacts |
Custom Fields
| Command | Endpoint |
|---|---|
centerfy customFields list ['<json>'] | List custom fields |
centerfy customFields create '<json>' | Create a custom field |
centerfy customFields get <customFieldId> | Get a custom field |
centerfy customFields update <customFieldId> '<json>' | Update a custom field |
centerfy customFields delete <customFieldId> | Delete a custom field |
centerfy contacts get-custom-fields <contactId> | Get a contact’s custom field values |
centerfy contacts set-custom-fields <contactId> '<json>' | Set a contact’s custom field values |
Contact Consent
| Command | Endpoint |
|---|---|
centerfy contacts set-dnc <contactId> '<json>' | Set DNC bypass |
centerfy contacts unsubscribe <contactId> '<json>' | Unsubscribe a contact |
centerfy contacts resubscribe <contactId> '<json>' | Re-subscribe a contact |
Lead Scoring
| Command | Endpoint |
|---|---|
centerfy leadScoring rules ['<json>'] | List lead scoring rules |
centerfy leadScoring score <contactId> ['<json>'] | Get a contact’s lead score |
centerfy leadScoring recompute <contactId> | Recompute a lead score |
Analytics
| Command | Endpoint |
|---|---|
centerfy analytics overview ['<json>'] | Insights overview |
centerfy analytics agents ['<json>'] | Agent performance |
centerfy analytics usage ['<json>'] | Usage summary |
centerfy analytics email ['<json>'] | Email performance |
Call Recordings
| Command | Endpoint |
|---|---|
centerfy callRecordings get <callId> ['<json>'] | Get a recording URL |
Wallet
| Command | Endpoint |
|---|---|
centerfy wallet get | Get the wallet balance |
centerfy wallet usage ['<json>'] | List billed usage |
Calendars
| Command | Endpoint |
|---|---|
centerfy calendars list ['<json>'] | List calendars |
centerfy calendars create '<json>' | Create a calendar |
centerfy calendars get <calendarId> | Get a calendar |
centerfy calendars update <calendarId> '<json>' | Update a calendar |
centerfy calendars delete <calendarId> | Delete a calendar |
centerfy calendars free-slots <calendarId> '<json>' | List free slots |
centerfy calendars assign-agent <agentId> '<json>' | Assign a calendar to an agent |
centerfy calendars remove-agent <agentId> <calendarId> | Remove a calendar from an agent |
Scheduled Calls
| Command | Endpoint |
|---|---|
centerfy scheduledCalls create '<json>' | Schedule a call |
centerfy scheduledCalls list ['<json>'] | List scheduled calls |
centerfy scheduledCalls get <scheduledCallId> | Get a scheduled call |
centerfy scheduledCalls cancel <scheduledCallId> | Cancel a scheduled call |
Scheduled Messages
| Command | Endpoint |
|---|---|
centerfy scheduledMessages create '<json>' | Schedule a message |
centerfy scheduledMessages list ['<json>'] | List scheduled messages |
centerfy scheduledMessages get <scheduledMessageId> | Get a scheduled message |
centerfy scheduledMessages cancel <scheduledMessageId> | Cancel a scheduled message |
Workflows
| Command | Endpoint |
|---|---|
centerfy workflows list ['<json>'] | List workflows |
centerfy workflows get <workflowId> ['<json>'] | Get a workflow |
centerfy workflows enroll <workflowId> '<json>' | Enroll contacts |
centerfy workflows remove-contact <workflowId> '<json>' | Remove a contact |
centerfy workflows activate <workflowId> | Activate a workflow |
centerfy workflows deactivate <workflowId> | Deactivate a workflow |
centerfy workflows executions <workflowId> ['<json>'] | List executions |
Reminder Templates
| Command | Endpoint |
|---|---|
centerfy reminderTemplates list ['<json>'] | List reminder templates |
centerfy reminderTemplates create '<json>' | Create a reminder template |
centerfy reminderTemplates get <templateId> | Get a reminder template |
centerfy reminderTemplates update <templateId> '<json>' | Update a reminder template |
centerfy reminderTemplates delete <templateId> | Delete a reminder template |
Forms
| Command | Endpoint |
|---|---|
centerfy forms list ['<json>'] | List forms |
centerfy forms get <formId> | Get a form |
centerfy forms submissions <formId> ['<json>'] | List form submissions |
centerfy forms submit <formId> '<json>' | Submit a form |
centerfy forms contact-submissions <contactId> ['<json>'] | List a contact’s submissions |
Voice Widget
| Command | Endpoint |
|---|---|
centerfy agentWidget get <agentId> | Get widget settings |
centerfy agentWidget update <agentId> '<json>' | Update widget settings |
centerfy agentWidget embed <agentId> ['<json>'] | Get embed code |
Outbound Webhook Subscriptions
| Command | Endpoint |
|---|---|
centerfy outboundWebhooks list ['<json>'] | List subscriptions |
centerfy outboundWebhooks create '<json>' | Create a subscription |
centerfy outboundWebhooks get <webhookId> | Get a subscription |
centerfy outboundWebhooks update <webhookId> '<json>' | Update a subscription |
centerfy outboundWebhooks delete <webhookId> | Delete a subscription |
centerfy outboundWebhooks rotate-secret <webhookId> | Rotate the secret |
centerfy outboundWebhooks test <webhookId> ['<json>'] | Send a test event |
centerfy outboundWebhooks deliveries <webhookId> ['<json>'] | List deliveries |
centerfy outboundWebhooks redeliver <deliveryId> | Redeliver a delivery |
Team Users
| Command | Endpoint |
|---|---|
centerfy users list ['<json>'] | List team members |
centerfy users change-role <userId> '<json>' | Change a member’s role |
centerfy users remove <userId> | Remove a member |
centerfy users invite '<json>' | Invite a user |
centerfy users invitations ['<json>'] | List invitations |
centerfy users resend-invitation <invitationId> | Resend an invitation |
centerfy users delete-invitation <invitationId> | Cancel an invitation |
Campaigns
| Command | Endpoint |
|---|---|
centerfy campaigns list ['<json>'] | List campaigns |
centerfy campaigns create '<json>' | Create a campaign |
centerfy campaigns get <campaignId> | Get a campaign |
centerfy campaigns update <campaignId> '<json>' | Update a campaign |
centerfy campaigns delete <campaignId> | Delete a campaign |
centerfy campaigns start <campaignId> | Send a campaign now |
centerfy campaigns schedule <campaignId> '<json>' | Schedule a campaign |
centerfy campaigns stats <campaignId> | Get campaign stats |
Contract Templates
| Command | Endpoint |
|---|---|
centerfy contractTemplates list ['<json>'] | List contract templates |
centerfy contractTemplates get <templateId> | Get a contract template |
Contracts
| Command | Endpoint |
|---|---|
centerfy contracts list ['<json>'] | List contracts |
centerfy contracts create '<json>' | Create a contract |
centerfy contracts get <contractId> | Get a contract |
centerfy contracts send <contractId> ['<json>'] | Send for signature |
centerfy contracts remind <contractId> ['<json>'] | Remind signers |
centerfy contracts void <contractId> | Void a contract |
centerfy contracts audit <contractId> ['<json>'] | Get the audit trail |
centerfy contracts pdf <contractId> | Download the signed PDF |
Reviews
| Command | Endpoint |
|---|---|
centerfy reviews list ['<json>'] | List reviews |
centerfy reviews get <reviewId> | Get a review |
Review Requests
| Command | Endpoint |
|---|---|
centerfy reviewRequests list ['<json>'] | List review requests |
centerfy reviewRequests send '<json>' | Send a review request |
Invoices
| Command | Endpoint |
|---|---|
centerfy invoices list ['<json>'] | List invoices |
centerfy invoices create '<json>' | Create an invoice |
centerfy invoices get <invoiceId> | Get an invoice |
centerfy invoices update <invoiceId> '<json>' | Update an invoice |
centerfy invoices delete <invoiceId> | Delete an invoice |
centerfy invoices mark-paid <invoiceId> ['<json>'] | Mark an invoice paid |
centerfy invoices send <invoiceId> | Email an invoice |
Quotes
| Command | Endpoint |
|---|---|
centerfy quotes list ['<json>'] | List quotes |
centerfy quotes create '<json>' | Create a quote |
centerfy quotes get <quoteId> | Get a quote |
centerfy quotes update <quoteId> '<json>' | Update a quote |
centerfy quotes delete <quoteId> ['<json>'] | Delete a quote |
centerfy quotes payment-link <quoteId> | Create a payment link |
centerfy quotes send <quoteId> | Email a quote |
centerfy quotes pdf <quoteId> | Get the printable quote |
Phone Number Purchasing
| Command | Endpoint |
|---|---|
centerfy phoneProvisioning search ['<json>'] | Search available numbers |
centerfy phoneProvisioning purchase '<json>' | Buy a phone number |
centerfy phoneProvisioning import '<json>' | Import a number (SIP) |
centerfy phoneProvisioning release <phoneNumberId> | Release a phone number |
Agency · Sub-Accounts
| Command | Endpoint |
|---|---|
centerfy --agency subAccounts list ['<json>'] | List sub-accounts |
centerfy --agency subAccounts create '<json>' | Create a sub-account |
centerfy --agency subAccounts get <subAccountId> | Get a sub-account |
centerfy --agency subAccounts update <subAccountId> '<json>' | Update sub-account settings |
centerfy --agency subAccounts archive <subAccountId> | Archive a sub-account |
centerfy --agency subAccounts unarchive <subAccountId> | Unarchive a sub-account |
centerfy --agency subAccounts pause <subAccountId> ['<json>'] | Pause a sub-account |
centerfy --agency subAccounts unpause <subAccountId> | Unpause a sub-account |
centerfy --agency subAccounts usage <subAccountId> | Get sub-account usage |
Agency · Sub-Account Users
| Command | Endpoint |
|---|---|
centerfy --agency subAccountUsers list <subAccountId> ['<json>'] | List members and invitations |
centerfy --agency subAccountUsers invite <subAccountId> '<json>' | Invite a user |
centerfy --agency subAccountUsers remove <subAccountId> <userId> | Remove a member |
Agency · Sub-Account API Keys
| Command | Endpoint |
|---|---|
centerfy --agency subAccountApiKeys list <subAccountId> | List API keys |
centerfy --agency subAccountApiKeys create <subAccountId> '<json>' | Create an API key |
centerfy --agency subAccountApiKeys revoke <subAccountId> <keyId> | Revoke an API key |
Agency · Agency Wallet
| Command | Endpoint |
|---|---|
centerfy --agency wallet get | Get the agency wallet balance |