Node SDK: all methods
Every method of @centerfy/sdk (222 in all), grouped by resource and linked to its endpoint.
centerfy is a CenterfyClient, agency is a CenterfyAgencyClient (see Node SDK for setup). params is the request body or query object documented on the endpoint page; params? means it can be omitted. Each endpoint page has a ready-to-run example under its Node SDK tab.
Contacts
| Method | Endpoint | Route |
|---|---|---|
centerfy.contacts.list(params?) | List contacts | GET /webhooks/inbound/contacts |
centerfy.contacts.get(contactId) | Get a contact | GET /webhooks/inbound/contacts/:id |
centerfy.contacts.create(params) | Create a contact | POST /webhooks/inbound/contacts |
centerfy.contacts.update(contactId, params) | Update a contact | PATCH /webhooks/inbound/contacts/:id |
centerfy.contacts.delete(contactId) | Delete a contact | DELETE /webhooks/inbound/contacts/:id |
Tags
| Method | Endpoint | Route |
|---|---|---|
centerfy.tags.list() | List all tags | GET /webhooks/inbound/tags |
centerfy.contacts.addTags(contactId, params) | Add tags to a contact | POST /webhooks/inbound/contacts/:id/tags |
centerfy.contacts.removeTags(contactId, params) | Remove tags from a contact | DELETE /webhooks/inbound/contacts/:id/tags |
Notes
| Method | Endpoint | Route |
|---|---|---|
centerfy.contacts.createNote(contactId, params) | Create a contact note | POST /webhooks/inbound/contacts/:id/notes |
centerfy.contacts.listNotes(contactId) | List contact notes | GET /webhooks/inbound/contacts/:id/notes |
centerfy.contacts.deleteNote(contactId, noteId) | Delete a contact note | DELETE /webhooks/inbound/contacts/:id/notes/:noteId |
AI Calls
| Method | Endpoint | Route |
|---|---|---|
centerfy.contacts.makeAiCall(contactId, params) | Make an AI call to a contact | POST /webhooks/inbound/contacts/:id/call |
Phone numbers
| Method | Endpoint | Route |
|---|---|---|
centerfy.phoneNumbers.list() | List owned numbers | GET /webhooks/inbound/phone-numbers |
centerfy.phoneNumbers.get(phoneNumberId) | Get a phone number | GET /webhooks/inbound/phone-numbers/:id |
centerfy.phoneNumbers.assignAgent(phoneNumberId, params) | Assign to an agent | POST /webhooks/inbound/phone-numbers/:id/agent |
centerfy.phoneNumbers.unassignAgent(phoneNumberId) | Remove from agent | DELETE /webhooks/inbound/phone-numbers/:id/agent |
Number pools
| Method | Endpoint | Route |
|---|---|---|
centerfy.numberPools.list() | List number pools | GET /webhooks/inbound/number-pools |
centerfy.numberPools.create(params) | Create a number pool | POST /webhooks/inbound/number-pools |
centerfy.numberPools.get(poolId) | Get a number pool | GET /webhooks/inbound/number-pools/:id |
centerfy.numberPools.delete(poolId) | Delete a number pool | DELETE /webhooks/inbound/number-pools/:id |
centerfy.numberPools.update(poolId, params) | Update a number pool | PATCH /webhooks/inbound/number-pools/:id |
centerfy.numberPools.addNumber(poolId, params) | Add a number to a pool | POST /webhooks/inbound/number-pools/:id/numbers |
centerfy.numberPools.removeNumber(poolId, numberId) | Remove a number from a pool | DELETE /webhooks/inbound/number-pools/:id/numbers/:numberId |
Voices
| Method | Endpoint | Route |
|---|---|---|
centerfy.voices.list(params?) | List voices | GET /webhooks/inbound/voices |
centerfy.voices.preview(params) | Preview a voice | POST /webhooks/inbound/voices/preview |
Agents
| Method | Endpoint | Route |
|---|---|---|
centerfy.agents.create(params) | Create an agent | POST /webhooks/inbound/agents |
centerfy.agents.list(params?) | List AI agents | GET /webhooks/inbound/agents |
centerfy.agents.get(agentId) | Get an agent | GET /webhooks/inbound/agents/:id |
centerfy.agents.update(agentId, params) | Update an agent | PATCH /webhooks/inbound/agents/:id |
centerfy.agents.duplicate(agentId) | Duplicate an agent | POST /webhooks/inbound/agents/:id/duplicate |
centerfy.agents.archive(agentId) | Archive an agent | DELETE /webhooks/inbound/agents/:id |
Agent folders
| Method | Endpoint | Route |
|---|---|---|
centerfy.agentFolders.create(params) | Create a folder | POST /webhooks/inbound/agent-folders |
centerfy.agentFolders.list() | List folders | GET /webhooks/inbound/agent-folders |
centerfy.agentFolders.update(folderId, params) | Update a folder | PATCH /webhooks/inbound/agent-folders/:id |
centerfy.agentFolders.addAgent(folderId, params) | Assign an agent | POST /webhooks/inbound/agent-folders/:id/agents |
centerfy.agentFolders.removeAgent(folderId, agentId) | Remove an agent | DELETE /webhooks/inbound/agent-folders/:id/agents/:agentId |
centerfy.agentFolders.delete(folderId) | Delete a folder | DELETE /webhooks/inbound/agent-folders/:id |
Tools
| Method | Endpoint | Route |
|---|---|---|
centerfy.agents.listCustomTools(agentId) | List agent custom tools | GET /webhooks/inbound/agents/:id/custom-tools |
centerfy.agents.assignCustomTool(agentId, params) | Assign a tool to an agent | POST /webhooks/inbound/agents/:id/custom-tools |
centerfy.agents.removeCustomTool(agentId, toolId) | Remove a tool from an agent | DELETE /webhooks/inbound/agents/:id/custom-tools/:toolId |
centerfy.customTools.create(params) | Create a custom tool | POST /webhooks/inbound/custom-tools |
centerfy.customTools.get(toolId) | Get a custom tool | GET /webhooks/inbound/custom-tools/:id |
centerfy.customTools.update(toolId, params) | Update a custom tool | PATCH /webhooks/inbound/custom-tools/:id |
centerfy.customTools.delete(toolId) | Delete a custom tool | DELETE /webhooks/inbound/custom-tools/:id |
Knowledge bases
| Method | Endpoint | Route |
|---|---|---|
centerfy.knowledgeBases.list() | List knowledge bases | GET /webhooks/inbound/knowledge-bases |
centerfy.knowledgeBases.create(params) | Create a knowledge base | POST /webhooks/inbound/knowledge-bases |
centerfy.knowledgeBases.delete(knowledgeBaseId) | Delete a knowledge base | DELETE /webhooks/inbound/knowledge-bases/:id |
centerfy.knowledgeBases.enable(knowledgeBaseId) | Enable a knowledge base | POST /webhooks/inbound/knowledge-bases/:id/enable |
centerfy.knowledgeBases.disable(knowledgeBaseId) | Disable a knowledge base | POST /webhooks/inbound/knowledge-bases/:id/disable |
centerfy.knowledgeBases.addText(knowledgeBaseId, params) | Add a text source | POST /webhooks/inbound/knowledge-bases/:id/text |
centerfy.knowledgeBases.addFaq(knowledgeBaseId, params) | Add an FAQ source | POST /webhooks/inbound/knowledge-bases/:id/faq |
centerfy.knowledgeBases.addUrl(knowledgeBaseId, params) | Add a URL source | POST /webhooks/inbound/knowledge-bases/:id/url |
centerfy.knowledgeBases.addFile(knowledgeBaseId, file, filename) | Add a file source | POST /webhooks/inbound/knowledge-bases/:id/file |
centerfy.knowledgeBases.deleteSource(knowledgeBaseId, sourceId) | Delete a source | DELETE /webhooks/inbound/knowledge-bases/:id/sources/:sourceId |
centerfy.agents.assignKnowledgeBase(agentId, params) | Assign to an agent | POST /webhooks/inbound/agents/:id/knowledge-base |
centerfy.agents.removeKnowledgeBase(agentId, knowledgeBaseId) | Remove from an agent | DELETE /webhooks/inbound/agents/:id/knowledge-base/:kbId |
Appointments
| Method | Endpoint | Route |
|---|---|---|
centerfy.appointments.list(params) | List appointments (date range) | GET /webhooks/inbound/appointments |
centerfy.appointments.create(params) | Create an appointment | POST /webhooks/inbound/appointments |
centerfy.appointments.get(appointmentId) | Get an appointment | GET /webhooks/inbound/appointments/:id |
centerfy.appointments.update(appointmentId, params) | Update an appointment | PATCH /webhooks/inbound/appointments/:id |
centerfy.appointments.delete(appointmentId) | Delete an appointment | DELETE /webhooks/inbound/appointments/:id |
Messages
| Method | Endpoint | Route |
|---|---|---|
centerfy.messages.send(params) | Send a message to a contact | POST /webhooks/inbound/messages |
centerfy.messages.sendAi(params) | Send an AI message to a contact | POST /webhooks/inbound/messages/ai |
centerfy.messages.listForContact(contactId, params?) | Fetch a contact’s messages | GET /webhooks/inbound/contacts/:id/messages |
Conversations
| Method | Endpoint | Route |
|---|---|---|
centerfy.conversations.list(params?) | List conversations | GET /webhooks/inbound/conversations |
centerfy.conversations.get(conversationId) | Get a conversation | GET /webhooks/inbound/conversations/:id |
centerfy.conversations.listMessages(conversationId, params?) | List messages in a conversation | GET /webhooks/inbound/conversations/:id/messages |
Calls
| Method | Endpoint | Route |
|---|---|---|
centerfy.calls.list(params?) | List call history | GET /webhooks/inbound/calls |
centerfy.calls.stats(params?) | Call stats for the sub-account | GET /webhooks/inbound/calls/stats |
centerfy.calls.get(callId) | Get a call (rich detail) | GET /webhooks/inbound/calls/:id |
Pipelines
| Method | Endpoint | Route |
|---|---|---|
centerfy.pipelines.list(params?) | List pipelines | GET /webhooks/inbound/pipelines |
centerfy.pipelines.create(params) | Create a pipeline | POST /webhooks/inbound/pipelines |
centerfy.pipelines.get(pipelineId) | Get a pipeline | GET /webhooks/inbound/pipelines/:id |
centerfy.pipelines.update(pipelineId, params) | Rename a pipeline | PATCH /webhooks/inbound/pipelines/:id |
centerfy.pipelines.delete(pipelineId, params?) | Delete a pipeline | DELETE /webhooks/inbound/pipelines/:id |
centerfy.pipelines.createStage(pipelineId, params) | Add a stage | POST /webhooks/inbound/pipelines/:id/stages |
centerfy.pipelines.updateStage(pipelineId, stageId, params) | Update a stage | PATCH /webhooks/inbound/pipelines/:id/stages/:stageId |
centerfy.pipelines.deleteStage(pipelineId, stageId, params?) | Delete a stage | DELETE /webhooks/inbound/pipelines/:id/stages/:stageId |
Opportunities
| Method | Endpoint | Route |
|---|---|---|
centerfy.opportunities.list(params?) | List opportunities | GET /webhooks/inbound/opportunities |
centerfy.opportunities.create(params) | Create an opportunity | POST /webhooks/inbound/opportunities |
centerfy.opportunities.get(opportunityId) | Get an opportunity | GET /webhooks/inbound/opportunities/:id |
centerfy.opportunities.update(opportunityId, params) | Update an opportunity | PATCH /webhooks/inbound/opportunities/:id |
centerfy.opportunities.move(opportunityId, params) | Move an opportunity to a stage | POST /webhooks/inbound/opportunities/:id/move |
centerfy.opportunities.delete(opportunityId) | Delete an opportunity | DELETE /webhooks/inbound/opportunities/:id |
Companies
| Method | Endpoint | Route |
|---|---|---|
centerfy.companies.list(params?) | List companies | GET /webhooks/inbound/companies |
centerfy.companies.create(params) | Create a company | POST /webhooks/inbound/companies |
centerfy.companies.get(companyId) | Get a company | GET /webhooks/inbound/companies/:id |
centerfy.companies.update(companyId, params) | Update a company | PATCH /webhooks/inbound/companies/:id |
centerfy.companies.delete(companyId) | Delete a company | DELETE /webhooks/inbound/companies/:id |
centerfy.companies.listContacts(companyId, params?) | List a company’s contacts | GET /webhooks/inbound/companies/:id/contacts |
Smart Lists
| Method | Endpoint | Route |
|---|---|---|
centerfy.smartLists.list(params?) | List smart lists | GET /webhooks/inbound/smart-lists |
centerfy.smartLists.get(smartListId) | Get a smart list | GET /webhooks/inbound/smart-lists/:id |
centerfy.smartLists.listContacts(smartListId, params?) | List a smart list’s contacts | GET /webhooks/inbound/smart-lists/:id/contacts |
Custom Fields
| Method | Endpoint | Route |
|---|---|---|
centerfy.customFields.list(params?) | List custom fields | GET /webhooks/inbound/custom-fields |
centerfy.customFields.create(params) | Create a custom field | POST /webhooks/inbound/custom-fields |
centerfy.customFields.get(customFieldId) | Get a custom field | GET /webhooks/inbound/custom-fields/:id |
centerfy.customFields.update(customFieldId, params) | Update a custom field | PATCH /webhooks/inbound/custom-fields/:id |
centerfy.customFields.delete(customFieldId) | Delete a custom field | DELETE /webhooks/inbound/custom-fields/:id |
centerfy.contacts.getCustomFields(contactId) | Get a contact’s custom field values | GET /webhooks/inbound/contacts/:id/custom-fields |
centerfy.contacts.setCustomFields(contactId, params) | Set a contact’s custom field values | PUT /webhooks/inbound/contacts/:id/custom-fields |
Contact Consent
| Method | Endpoint | Route |
|---|---|---|
centerfy.contacts.setDnc(contactId, params) | Set DNC bypass | PUT /webhooks/inbound/contacts/:id/dnc |
centerfy.contacts.unsubscribe(contactId, params) | Unsubscribe a contact | POST /webhooks/inbound/contacts/:id/unsubscribe |
centerfy.contacts.resubscribe(contactId, params) | Re-subscribe a contact | POST /webhooks/inbound/contacts/:id/resubscribe |
Lead Scoring
| Method | Endpoint | Route |
|---|---|---|
centerfy.leadScoring.listRules(params?) | List lead scoring rules | GET /webhooks/inbound/lead-score-rules |
centerfy.leadScoring.getContactScore(contactId, params?) | Get a contact’s lead score | GET /webhooks/inbound/contacts/:id/lead-score |
centerfy.leadScoring.recompute(contactId) | Recompute a lead score | POST /webhooks/inbound/contacts/:id/lead-score/recompute |
Analytics
| Method | Endpoint | Route |
|---|---|---|
centerfy.analytics.overview(params?) | Insights overview | GET /webhooks/inbound/analytics/overview |
centerfy.analytics.agents(params?) | Agent performance | GET /webhooks/inbound/analytics/agents |
centerfy.analytics.usage(params?) | Usage summary | GET /webhooks/inbound/analytics/usage |
centerfy.analytics.email(params?) | Email performance | GET /webhooks/inbound/analytics/email |
Call Recordings
| Method | Endpoint | Route |
|---|---|---|
centerfy.callRecordings.getRecording(callId, params?) | Get a recording URL | GET /webhooks/inbound/calls/:id/recording |
Wallet
| Method | Endpoint | Route |
|---|---|---|
centerfy.wallet.get() | Get the wallet balance | GET /webhooks/inbound/wallet |
centerfy.wallet.usage(params?) | List billed usage | GET /webhooks/inbound/wallet/usage |
Calendars
| Method | Endpoint | Route |
|---|---|---|
centerfy.calendars.list(params?) | List calendars | GET /webhooks/inbound/calendars |
centerfy.calendars.create(params) | Create a calendar | POST /webhooks/inbound/calendars |
centerfy.calendars.get(calendarId) | Get a calendar | GET /webhooks/inbound/calendars/:id |
centerfy.calendars.update(calendarId, params) | Update a calendar | PATCH /webhooks/inbound/calendars/:id |
centerfy.calendars.delete(calendarId) | Delete a calendar | DELETE /webhooks/inbound/calendars/:id |
centerfy.calendars.freeSlots(calendarId, params) | List free slots | GET /webhooks/inbound/calendars/:id/free-slots |
centerfy.calendars.assignToAgent(agentId, params) | Assign a calendar to an agent | POST /webhooks/inbound/agents/:id/calendars |
centerfy.calendars.removeFromAgent(agentId, calendarId) | Remove a calendar from an agent | DELETE /webhooks/inbound/agents/:id/calendars/:calendarId |
Scheduled Calls
| Method | Endpoint | Route |
|---|---|---|
centerfy.scheduledCalls.create(params) | Schedule a call | POST /webhooks/inbound/scheduled-calls |
centerfy.scheduledCalls.list(params?) | List scheduled calls | GET /webhooks/inbound/scheduled-calls |
centerfy.scheduledCalls.get(scheduledCallId) | Get a scheduled call | GET /webhooks/inbound/scheduled-calls/:id |
centerfy.scheduledCalls.cancel(scheduledCallId) | Cancel a scheduled call | DELETE /webhooks/inbound/scheduled-calls/:id |
Scheduled Messages
| Method | Endpoint | Route |
|---|---|---|
centerfy.scheduledMessages.create(params) | Schedule a message | POST /webhooks/inbound/scheduled-messages |
centerfy.scheduledMessages.list(params?) | List scheduled messages | GET /webhooks/inbound/scheduled-messages |
centerfy.scheduledMessages.get(scheduledMessageId) | Get a scheduled message | GET /webhooks/inbound/scheduled-messages/:id |
centerfy.scheduledMessages.cancel(scheduledMessageId) | Cancel a scheduled message | DELETE /webhooks/inbound/scheduled-messages/:id |
Workflows
| Method | Endpoint | Route |
|---|---|---|
centerfy.workflows.list(params?) | List workflows | GET /webhooks/inbound/workflows |
centerfy.workflows.get(workflowId, params?) | Get a workflow | GET /webhooks/inbound/workflows/:id |
centerfy.workflows.enroll(workflowId, params) | Enroll contacts | POST /webhooks/inbound/workflows/:id/enroll |
centerfy.workflows.removeContact(workflowId, params) | Remove a contact | POST /webhooks/inbound/workflows/:id/remove-contact |
centerfy.workflows.activate(workflowId) | Activate a workflow | POST /webhooks/inbound/workflows/:id/activate |
centerfy.workflows.deactivate(workflowId) | Deactivate a workflow | POST /webhooks/inbound/workflows/:id/deactivate |
centerfy.workflows.listExecutions(workflowId, params?) | List executions | GET /webhooks/inbound/workflows/:id/executions |
Reminder Templates
| Method | Endpoint | Route |
|---|---|---|
centerfy.reminderTemplates.list(params?) | List reminder templates | GET /webhooks/inbound/reminder-templates |
centerfy.reminderTemplates.create(params) | Create a reminder template | POST /webhooks/inbound/reminder-templates |
centerfy.reminderTemplates.get(templateId) | Get a reminder template | GET /webhooks/inbound/reminder-templates/:id |
centerfy.reminderTemplates.update(templateId, params) | Update a reminder template | PATCH /webhooks/inbound/reminder-templates/:id |
centerfy.reminderTemplates.delete(templateId) | Delete a reminder template | DELETE /webhooks/inbound/reminder-templates/:id |
Forms
| Method | Endpoint | Route |
|---|---|---|
centerfy.forms.list(params?) | List forms | GET /webhooks/inbound/forms |
centerfy.forms.get(formId) | Get a form | GET /webhooks/inbound/forms/:id |
centerfy.forms.listSubmissions(formId, params?) | List form submissions | GET /webhooks/inbound/forms/:id/submissions |
centerfy.forms.submit(formId, params) | Submit a form | POST /webhooks/inbound/forms/:id/submit |
centerfy.forms.listContactSubmissions(contactId, params?) | List a contact’s submissions | GET /webhooks/inbound/contacts/:id/form-submissions |
Voice Widget
| Method | Endpoint | Route |
|---|---|---|
centerfy.agentWidget.get(agentId) | Get widget settings | GET /webhooks/inbound/agents/:id/widget |
centerfy.agentWidget.update(agentId, params) | Update widget settings | PATCH /webhooks/inbound/agents/:id/widget |
centerfy.agentWidget.embed(agentId, params?) | Get embed code | GET /webhooks/inbound/agents/:id/widget/embed |
Outbound Webhook Subscriptions
| Method | Endpoint | Route |
|---|---|---|
centerfy.outboundWebhooks.list(params?) | List subscriptions | GET /webhooks/inbound/outbound-webhooks |
centerfy.outboundWebhooks.create(params) | Create a subscription | POST /webhooks/inbound/outbound-webhooks |
centerfy.outboundWebhooks.get(webhookId) | Get a subscription | GET /webhooks/inbound/outbound-webhooks/:id |
centerfy.outboundWebhooks.update(webhookId, params) | Update a subscription | PATCH /webhooks/inbound/outbound-webhooks/:id |
centerfy.outboundWebhooks.delete(webhookId) | Delete a subscription | DELETE /webhooks/inbound/outbound-webhooks/:id |
centerfy.outboundWebhooks.rotateSecret(webhookId) | Rotate the secret | POST /webhooks/inbound/outbound-webhooks/:id/rotate-secret |
centerfy.outboundWebhooks.test(webhookId, params?) | Send a test event | POST /webhooks/inbound/outbound-webhooks/:id/test |
centerfy.outboundWebhooks.listDeliveries(webhookId, params?) | List deliveries | GET /webhooks/inbound/outbound-webhooks/:id/deliveries |
centerfy.outboundWebhooks.redeliver(deliveryId) | Redeliver a delivery | POST /webhooks/inbound/outbound-webhooks/deliveries/:id/redeliver |
Team Users
| Method | Endpoint | Route |
|---|---|---|
centerfy.users.list(params?) | List team members | GET /webhooks/inbound/users |
centerfy.users.changeRole(userId, params) | Change a member’s role | PATCH /webhooks/inbound/users/:id/role |
centerfy.users.remove(userId) | Remove a member | DELETE /webhooks/inbound/users/:id |
centerfy.users.invite(params) | Invite a user | POST /webhooks/inbound/users/invite |
centerfy.users.listInvitations(params?) | List invitations | GET /webhooks/inbound/invitations |
centerfy.users.resendInvitation(invitationId) | Resend an invitation | POST /webhooks/inbound/invitations/:id/resend |
centerfy.users.deleteInvitation(invitationId) | Cancel an invitation | DELETE /webhooks/inbound/invitations/:id |
Campaigns
| Method | Endpoint | Route |
|---|---|---|
centerfy.campaigns.list(params?) | List campaigns | GET /webhooks/inbound/campaigns |
centerfy.campaigns.create(params) | Create a campaign | POST /webhooks/inbound/campaigns |
centerfy.campaigns.get(campaignId) | Get a campaign | GET /webhooks/inbound/campaigns/:id |
centerfy.campaigns.update(campaignId, params) | Update a campaign | PATCH /webhooks/inbound/campaigns/:id |
centerfy.campaigns.delete(campaignId) | Delete a campaign | DELETE /webhooks/inbound/campaigns/:id |
centerfy.campaigns.start(campaignId) | Send a campaign now | POST /webhooks/inbound/campaigns/:id/start |
centerfy.campaigns.schedule(campaignId, params) | Schedule a campaign | POST /webhooks/inbound/campaigns/:id/schedule |
centerfy.campaigns.stats(campaignId) | Get campaign stats | GET /webhooks/inbound/campaigns/:id/stats |
Contract Templates
| Method | Endpoint | Route |
|---|---|---|
centerfy.contractTemplates.list(params?) | List contract templates | GET /webhooks/inbound/contract-templates |
centerfy.contractTemplates.get(templateId) | Get a contract template | GET /webhooks/inbound/contract-templates/:id |
Contracts
| Method | Endpoint | Route |
|---|---|---|
centerfy.contracts.list(params?) | List contracts | GET /webhooks/inbound/contracts |
centerfy.contracts.create(params) | Create a contract | POST /webhooks/inbound/contracts |
centerfy.contracts.get(contractId) | Get a contract | GET /webhooks/inbound/contracts/:id |
centerfy.contracts.send(contractId, params?) | Send for signature | POST /webhooks/inbound/contracts/:id/send |
centerfy.contracts.remind(contractId, params?) | Remind signers | POST /webhooks/inbound/contracts/:id/remind |
centerfy.contracts.void(contractId) | Void a contract | POST /webhooks/inbound/contracts/:id/void |
centerfy.contracts.audit(contractId, params?) | Get the audit trail | GET /webhooks/inbound/contracts/:id/audit |
centerfy.contracts.pdf(contractId) | Download the signed PDF | GET /webhooks/inbound/contracts/:id/pdf |
Reviews
| Method | Endpoint | Route |
|---|---|---|
centerfy.reviews.list(params?) | List reviews | GET /webhooks/inbound/reviews |
centerfy.reviews.get(reviewId) | Get a review | GET /webhooks/inbound/reviews/:id |
Review Requests
| Method | Endpoint | Route |
|---|---|---|
centerfy.reviewRequests.list(params?) | List review requests | GET /webhooks/inbound/review-requests |
centerfy.reviewRequests.send(params) | Send a review request | POST /webhooks/inbound/review-requests |
Invoices
| Method | Endpoint | Route |
|---|---|---|
centerfy.invoices.list(params?) | List invoices | GET /webhooks/inbound/invoices |
centerfy.invoices.create(params) | Create an invoice | POST /webhooks/inbound/invoices |
centerfy.invoices.get(invoiceId) | Get an invoice | GET /webhooks/inbound/invoices/:id |
centerfy.invoices.update(invoiceId, params) | Update an invoice | PATCH /webhooks/inbound/invoices/:id |
centerfy.invoices.delete(invoiceId) | Delete an invoice | DELETE /webhooks/inbound/invoices/:id |
centerfy.invoices.markPaid(invoiceId, params?) | Mark an invoice paid | POST /webhooks/inbound/invoices/:id/mark-paid |
centerfy.invoices.send(invoiceId) | Email an invoice | POST /webhooks/inbound/invoices/:id/send |
Quotes
| Method | Endpoint | Route |
|---|---|---|
centerfy.quotes.list(params?) | List quotes | GET /webhooks/inbound/quotes |
centerfy.quotes.create(params) | Create a quote | POST /webhooks/inbound/quotes |
centerfy.quotes.get(quoteId) | Get a quote | GET /webhooks/inbound/quotes/:id |
centerfy.quotes.update(quoteId, params) | Update a quote | PATCH /webhooks/inbound/quotes/:id |
centerfy.quotes.delete(quoteId, params?) | Delete a quote | DELETE /webhooks/inbound/quotes/:id |
centerfy.quotes.createPaymentLink(quoteId) | Create a payment link | POST /webhooks/inbound/quotes/:id/payment-link |
centerfy.quotes.send(quoteId) | Email a quote | POST /webhooks/inbound/quotes/:id/send |
centerfy.quotes.pdf(quoteId) | Get the printable quote | GET /webhooks/inbound/quotes/:id/pdf |
Phone Number Purchasing
| Method | Endpoint | Route |
|---|---|---|
centerfy.phoneProvisioning.search(params?) | Search available numbers | GET /webhooks/inbound/phone-numbers/available |
centerfy.phoneProvisioning.purchase(params, { idempotencyKey }) | Buy a phone number | POST /webhooks/inbound/phone-numbers/purchase |
centerfy.phoneProvisioning.import(params) | Import a number (SIP) | POST /webhooks/inbound/phone-numbers/import |
centerfy.phoneProvisioning.release(phoneNumberId) | Release a phone number | DELETE /webhooks/inbound/phone-numbers/:id |
Agency · Sub-Accounts
| Method | Endpoint | Route |
|---|---|---|
agency.subAccounts.list(params?) | List sub-accounts | GET /webhooks/inbound/agency/sub-accounts |
agency.subAccounts.create(params) | Create a sub-account | POST /webhooks/inbound/agency/sub-accounts |
agency.subAccounts.get(subAccountId) | Get a sub-account | GET /webhooks/inbound/agency/sub-accounts/:id |
agency.subAccounts.update(subAccountId, params) | Update sub-account settings | PATCH /webhooks/inbound/agency/sub-accounts/:id |
agency.subAccounts.archive(subAccountId) | Archive a sub-account | POST /webhooks/inbound/agency/sub-accounts/:id/archive |
agency.subAccounts.unarchive(subAccountId) | Unarchive a sub-account | POST /webhooks/inbound/agency/sub-accounts/:id/unarchive |
agency.subAccounts.pause(subAccountId, params?) | Pause a sub-account | POST /webhooks/inbound/agency/sub-accounts/:id/pause |
agency.subAccounts.unpause(subAccountId) | Unpause a sub-account | POST /webhooks/inbound/agency/sub-accounts/:id/unpause |
agency.subAccounts.usage(subAccountId) | Get sub-account usage | GET /webhooks/inbound/agency/sub-accounts/:id/usage |
Agency · Sub-Account Users
| Method | Endpoint | Route |
|---|---|---|
agency.subAccountUsers.list(subAccountId, params?) | List members and invitations | GET /webhooks/inbound/agency/sub-accounts/:id/users |
agency.subAccountUsers.invite(subAccountId, params) | Invite a user | POST /webhooks/inbound/agency/sub-accounts/:id/users |
agency.subAccountUsers.remove(subAccountId, userId) | Remove a member | DELETE /webhooks/inbound/agency/sub-accounts/:id/users/:userId |
Agency · Sub-Account API Keys
| Method | Endpoint | Route |
|---|---|---|
agency.subAccountApiKeys.list(subAccountId) | List API keys | GET /webhooks/inbound/agency/sub-accounts/:id/api-keys |
agency.subAccountApiKeys.create(subAccountId, params) | Create an API key | POST /webhooks/inbound/agency/sub-accounts/:id/api-keys |
agency.subAccountApiKeys.revoke(subAccountId, keyId) | Revoke an API key | DELETE /webhooks/inbound/agency/sub-accounts/:id/api-keys/:keyId |
Agency · Agency Wallet
| Method | Endpoint | Route |
|---|---|---|
agency.wallet.get() | Get the agency wallet balance | GET /webhooks/inbound/agency/wallet |