Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
OAuth flow
All
Pages
Start typing to search…
JUMP TO
Getting started
Introduction
Core API
OAuth flow
Access scopes
Webhooks
Rate Limiting
Mantle Extensions
Embedded extensions
Mantle App Bridge
Session tokens
Non-embedded extensions
hmac verification
Become an Extension developer
Public Extension Guidelines
Mantle Core API
Actions
Get list of all flow actions
get
Create a new flow action
post
Update an action
put
Delete an Action
del
Affiliates
List all affiliates
get
Get an affiliate
get
Affiliate Commissions
List all affiliate commissions
get
Get an affiliate commission
get
Affiliate Referrals
List all affiliate referrals
get
Get an affiliate referral
get
Affiliate Payouts
List all affiliate payouts
get
Get an affiliate payout
get
Affiliate Programs
List all affiliate programs
get
Get an affiliate program
get
Apps
List all apps
get
Get an app
get
App Events
Get a single app event
get
Get a list of app events
get
Create a new app event
post
Channels
List all CX channels
get
Create or get a CX channel
post
Charges
List all charges
get
Companies
Get a list of companies
get
Create a company
post
Get a company
get
Update a company
put
Delete a company
del
Contacts
Get a list of contacts
get
Create a contact
post
Get a contact by ID
get
Update a contact by ID
put
Delete a contact by ID
del
Add tags by contact ID
post
Remove tags by contact ID
post
Conversations
Get a conversation
get
Customers
List all customers
get
Create a new customer
post
Get a customer
get
Update a customer
put
Add tags by customer ID
post
Remove tags by customer ID
post
Update an account owner
put
Delete an account owner
del
Get account owners for a customer
get
Add an account owner to a customer
post
Get a customer's timeline
get
Customer Segments
List all customer segments
get
Get a customer segment
get
Custom Data
Upsert custom data value
put
Get custom data values
get
Custom Fields
Get a list of custom fields
get
Get a custom field
get
Update a custom field
put
Delete a custom field
del
Create a custom field
post
Deals
Get a list of deals
get
Create a deal
post
Get a deal by ID
get
Update a deal by ID
put
Archive a deal by ID
del
Get deal events
get
Create a deal event
post
Get deal timeline
get
Deal Activities
Get a list of deal activities
get
Create a deal activity
post
Get a deal activity by ID
get
Update a deal activity by ID
put
Delete a deal activity by ID
del
Deal Flows
Get a list of deal flows
get
Create a deal flow
post
Get a deal flow by ID
get
Update a deal flow by ID
put
Delete a deal flow by ID
del
Docs
List documentation collections
get
Create a documentation collection
post
List documentation groups
get
Create a documentation group
post
List documentation pages
get
Create a documentation page
post
List documentation repositories
get
Update a documentation collection
put
Delete a documentation collection
del
Update a documentation group
put
Delete a documentation group
del
Get a documentation page
get
Update a documentation page
put
Delete a documentation page
del
Get a documentation repository
get
Email
List all email unsubscribe groups
get
Remove email unsubscribe group member
del
List all email unsubscribe group members
get
Add email unsubscribe group members
post
Delete email unsubscribe group members by email addresses
del
Entities
Search across customers and contacts
get
Features
Get a feature
get
Update a feature
put
Delete a feature
del
Get list of features
get
Create a feature
post
Flows
Update a flow action run
put
List flows
get
Create a flow
post
Get flow details
get
Update flow
patch
Delete flow
del
Journal Entries
List journal entries
get
Create a journal entry
post
Get a journal entry by ID
get
Update a journal entry by ID
put
Delete a journal entry by ID
del
Metrics
activeInstalls
get
activeSubscriptions
get
arpu
get
arr
get
logoChurn
get
mrr
get
netInstalls
get
netRevenue
get
netRevenueRetention
get
payout
get
predictedLtv
get
revenueChurn
get
revenueRetention
get
usageEvent
get
usageMetric
get
Organization
Get organization details
get
Plans
Update a plan
put
Archive a plan
put
Unarchive a plan
put
Get a list of plans
get
Create a new plan
post
Get a plan
get
Reviews
Get a review
get
Get a list of reviews
get
Subscriptions
Get a list of subscriptions
get
Get a single subscription
get
Tasks
Get a list of tasks
get
Create a task
post
Get a task by ID
get
Update a task by ID
put
Delete a task by ID
del
Task Todo Items
Get a todo item
get
Update a todo item
put
Delete a todo item
del
List todo items for a task
get
Create a todo item
post
Tickets
List all tickets
get
Get a message by ID
get
List messages for a ticket
get
Get a ticket by ID
get
Create a ticket
post
Get ticket events
get
Create a ticket event
post
Bulk upsert ticket events
put
Create a ticket message
post
Bulk upsert ticket messages
put
Update a ticket by ID
put
Transactions
List all transactions
get
Get a transaction
get
Usage Events
Create a new usage event
post
Get usage events
get
Usage Metrics
Get a usage metric
get
Update a usage metric
put
Delete a usage metric
del
Get list of usage metrics
get
Create a usage metric
post
Users
List all users
get
Get a user
get
Webhooks
List all webhooks
get
Create a new webhook
post
Update a webhook
put
Delete a webhook
del
Webhook Topics
customers/installed
post
customers/uninstalled
post
customers/reinstalled
post
customers/deactivated
post
customers/reactivated
post
customers/reviewed
post
customers/approaching_capped_limit
post
customers/capped_amount_updated
post
customers/usage_charge_exceeds_limit
post
customers/subscribed
post
customers/unsubscribed
post
customers/upgraded
post
customers/downgraded
post
customers/one_time_charge_activated
post
customers/refunded
post
customers/trial_expired
post
customers/first_identify
post
customers/usage_event
post
affiliates/join_requested
post
affiliates/join_approved
post
affiliates/join_denied
post
affiliates/joined
post
affiliates/referral
post
affiliates/referral_requested
post
affiliates/payment_requested
post
customers/trial_extended
post
extensions/uninstalled
post
customers/subscription_frozen
post
customers/subscription_unfrozen
post
helpdesk/thread_created
post
transactions/created
post
customers/platform_plan_changed
post
affiliates/payout_pending
post
helpdesk/thread_message_received
post
Powered by
OAuth flow
Ask AI
Mantle Core API OAuth flow
