For AI agents: visit https://sisu-web-api.readme.io/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
enroll
Sisu PWA API
activity
/api/v3/activity
get
/api/v3/activity
patch
admin
/api/v3/admin/commission/categories
get
/api/v3/admin/commission/categories
post
/api/v3/admin/commission/categories
patch
/api/v3/admin/commission/categories
del
/api/v3/admin/commission/categories/options
get
/api/v3/admin/commission/cda/instructions
get
/api/v3/admin/commission/cda/instructions
post
/api/v3/admin/commission/cda/instructions
patch
/api/v3/admin/commission/cda/instructions
del
/api/v3/admin/commission/cda/instructions/default
patch
/api/v3/admin/commission/entities
get
/api/v3/admin/commission/entities
post
/api/v3/admin/commission/entities
patch
/api/v3/admin/commission/entities
del
/api/v3/admin/commission/preferences
get
/api/v3/admin/commission/preferences
patch
/api/v3/admin/commission/templates
get
/api/v3/admin/commission/templates
patch
/api/v3/admin/commission/templates
del
/api/v3/admin/custom-fields
get
/api/v3/admin/custom-fields
post
/api/v3/admin/custom-fields
patch
/api/v3/admin/custom-fields
del
/api/v3/admin/emails
get
/api/v3/admin/form/field/order
patch
/api/v3/admin/forms
get
/api/v3/admin/forms
post
/api/v3/admin/forms
patch
/api/v3/admin/forms
del
/api/v3/admin/group
get
/api/v3/admin/group
post
/api/v3/admin/lead-source
post
/api/v3/admin/lead-source-group
get
/api/v3/admin/lead-source-group
post
/api/v3/admin/lead-source-group/{lead_source_group_id}
get
/api/v3/admin/lead-source-group/{lead_source_group_id}
patch
/api/v3/admin/lead-source-group/{lead_source_group_id}
del
/api/v3/admin/lead-source-group/{lead_source_group_id}/lead-source
get
/api/v3/admin/lead-source-group/{lead_source_group_id}/lead-source
post
/api/v3/admin/lead-source-group/{lead_source_group_id}/lead-source
del
/api/v3/admin/lead-source-merge
post
/api/v3/admin/lead-source/{lead_source_id}
get
/api/v3/admin/lead-source/{lead_source_id}
patch
/api/v3/admin/lead-source/{lead_source_id}/at-bats
post
/api/v3/admin/lead-source/{lead_source_id}/counts-expenses
get
/api/v3/admin/lead-source/{lead_source_id}/counts-expenses
post
/api/v3/admin/manage-billing
get
/api/v3/admin/notification-templates
get
/api/v3/admin/notification-templates/fields
get
/api/v3/admin/notification_settings
get
/api/v3/admin/notification_settings
patch
Get Admin controlled preferences for team
get
/api/v3/admin/preferences
post
/api/v3/admin/preferences
patch
/api/v3/admin/task/statuses
get
/api/v3/admin/task/statuses
patch
/api/v3/admin/task/statuses/{task_status_id}/toggle
get
/api/v3/admin/team
get
/api/v3/admin/team
patch
/api/v3/admin/team-settings/card-key-fields
get
/api/v3/admin/team-settings/card-key-fields
patch
/api/v3/admin/team/blackout-day
post
/api/v3/admin/team/blackout-day
del
/api/v3/admin/team/blackout-days
get
/api/v3/admin/team/blackout-days/options
get
/api/v3/admin/team/logo
get
/api/v3/admin/team/logo
post
/api/v3/admin/team/logo
del
/api/v3/admin/team/subscription
get
/api/v3/admin/transaction/stages
get
/api/v3/admin/transaction/stages
post
/api/v3/admin/transaction/stages
patch
/api/v3/admin/transaction/stages
del
/api/v3/admin/transaction/stages/order
patch
/api/v3/admin/transaction/tags
get
/api/v3/admin/transaction/tags
post
/api/v3/admin/transaction/tags
patch
/api/v3/admin/transaction/tags
del
/api/v3/admin/user
get
/api/v3/admin/user
post
/api/v3/admin/user
patch
/api/v3/admin/user
del
/api/v3/admin/user/activate
patch
/api/v3/admin/user/login-history
get
/api/v3/admin/user/password
put
/api/v3/admin/user/password
patch
/api/v3/admin/user/transactions/reassign
get
/api/v3/admin/user/transactions/reassign
patch
/api/v3/admin/users
get
/api/v3/admin/users/download
get
/api/v3/admin/view-restrictions
get
/api/v3/admin/view-restrictions
patch
/api/v3/api-credentials
get
Regenerate API key for a team
post
/api/v3/transactions/manager/stage
patch
/api/v3/transactions/manager/status
patch
/api/v3/admin/lead-source
get
/api/v3/admin/notification-templates/{template_id}/task-blueprints
get
/api/v3/admin/task-blueprints/email-subject-override
patch
List API keys for the authenticated team
get
Create a new API key
post
Rename an API key
patch
Revoke (soft-delete) an API key
del
back office
/api/v3/back-office/agent-mappings
get
/api/v3/back-office/search
get
/api/v3/back-office/team
get
/api/v3/back-office/team
post
/api/v3/back-office/team
patch
/api/v3/back-office/team/features
patch
/api/v3/back-office/team/options
get
/api/v3/back-office/team/user
post
/api/v3/back-office/team/user
patch
/api/v3/back-office/team/user
del
/api/v3/back-office/token
post
/api/v3/back-office/user
get
/api/v3/back-office/user/import
post
/api/v3/back-office/user/import/view
post
/api/v3/back-office/reporting/sunburst/team-usage
get
/api/v3/back-office/team/external-api-credentials
get
/api/v3/back-office/team/external-api-credentials
post
/api/v3/back-office/team/sweeper-delay
get
/api/v3/back-office/team/sweeper-delay
post
/api/v3/back-office/team/sweeper-delay
del
comments
/api/v3/comment
get
/api/v3/comment
post
/api/v3/comment
patch
/api/v3/comment/status
patch
/api/v3/comments/bulk
patch
/api/v3/comments/by-object
get
/api/v3/comments/by-trans
get
/api/v3/comments/by-user
get
/api/v3/comments/count
get
/api/v3/mention-choices
get
contact
/api/v3/contact
get
/api/v3/contact
post
/api/v3/contact
patch
/api/v3/contact/find
get
/api/v3/contact/info
get
/api/v3/contact/log-out
patch
/api/v3/contact/notification-settings
get
/api/v3/contact/otp
get
/api/v3/contact/otp
post
/api/v3/contact/portal_access/info
get
/api/v3/contact/search
get
/api/v3/contact/token
get
/api/v3/contact/token-from-secret
get
/api/v3/contacts/merge
get
/api/v3/contacts/merge
put
/api/v3/contacts/records
get
/api/v3/contacts
get
dashboard
Retrieve dashboard links for the current team
get
Create a new dashboard link for the current team
post
Delete a dashboard link
del
/api/v3/dashboard/display/config
get
/api/v3/dashboard/rankings
get
/api/v3/dashboards/rename
patch
Public endpoint for shared dashboard links
get
/api/v3/dashboard/snapshot
get
/api/v3/dashboard/snapshot/graph
get
/api/v3/dashboard/stat-categories
get
/api/v3/dashboard/stat-category/defaults
get
/api/v3/dashboard/tiles
get
/api/v3/dashboards
get
Slide configuration for a shared dashboard link
get
Dashboard data for a shared link
get
esignature
Get eSign Platform Report
get
Get Contact eSignatures
get
Get eSignature Packet Blueprints
get
Create eSignature Packet Blueprint
post
Update eSignature Packet Blueprint
put
Delete eSignature Packet Blueprint
del
Create eSignature Request
post
Get eSignature Request Options
get
Refresh eSignature Request by Public ID
put
Search eSignature Requests (Paginated)
post
Total Signed eSignature Requests
get
Get eSignature Request by ID
get
Archive eSignature Request by ID
del
Get eSignature Request Audit Log
get
Download eSignature Request Documents
get
Refresh eSignature Request
put
Get eSignature Templates
get
Create eSignature Template
post
Get Team eSignature Template Fields
get
Create eSignature Template Packet
post
Get eSignature Template by ID
get
Update eSignature Template
put
Delete eSignature Template
del
Get eSignature Template Builder Auth
get
Clone eSignature Template
post
Refresh eSignature Template
post
Get eSignature by Public ID
get
Refresh eSignature
put
Get eSignature by ID
get
Resend eSignature email
post
Update eSignature signer information
put
Get Team SisuSign Settings
get
Update Team SisuSign Settings
post
Get SisuSign User Settings
get
Update SisuSign User Settings
post
Get Transaction eSignature Requests
get
leaderboard
/api/v3/leaderboard
get
/api/v3/leaderboard/options
get
mcp
/api/v3/mcp/internal/tools
get
/api/v3/mcp/internal/tools/{name}
post
/api/v3/mcp/prompts
get
/api/v3/mcp/tools
get
/api/v3/mcp/tools/{name}
post
rtc
/api/v3/rtc
get
/api/v3/rtc
post
/api/v3/rtc
patch
/api/v3/rtc
del
/api/v3/rtc/associations
get
/api/v3/rtc/associations
del
/api/v3/rtc/step
post
/api/v3/rtc/step
patch
/api/v3/rtc/step
del
/api/v3/rtc/step/notification-cadence/options
get
/api/v3/rtc/step/options
get
/api/v3/rtc/validate/name
get
/api/v3/transaction/details
get
/api/v3/transaction/rtc
get
/api/v3/transaction/rtc
post
/api/v3/transaction/rtc
patch
/api/v3/transaction/rtc/bulk
post
/api/v3/transaction/rtc/bulk
del
/api/v3/transaction/rtc/portal-link
get
/api/v3/transaction/rtc/portal-link
post
/api/v3/transaction/rtc/step
post
/api/v3/transaction/rtc/step
patch
/api/v3/transaction/rtc/step
del
tasks
/api/v3/task
post
/api/v3/task
patch
/api/v3/task/blueprint
get
/api/v3/task/blueprint
post
/api/v3/task/blueprint
patch
/api/v3/task/blueprint
del
/api/v3/task/blueprints
get
/api/v3/task/bulk
patch
/api/v3/task/bulk
del
/api/v3/task/comment
post
/api/v3/task/comment
del
/api/v3/task/comments
get
/api/v3/task/date-fields
get
/api/v3/task/due-status/options
get
/api/v3/task/list
get
/api/v3/task/list
post
/api/v3/task/list
patch
/api/v3/task/list
del
/api/v3/task/list/apply
post
/api/v3/task/list/blueprint
post
/api/v3/task/list/blueprint
del
/api/v3/task/list/blueprint/move
patch
/api/v3/task/list/copy/{task_list_id}
post
/api/v3/task/list/move
patch
/api/v3/task/lists
get
/api/v3/task/lists/download
get
/api/v3/task/notification/message
get
/api/v3/task/notification/message/template
patch
/api/v3/task/notification/message/template
del
/api/v3/task/notification/send
post
/api/v3/task/status/options
get
/api/v3/tasks
get
/api/v3/tasks/available_task_lists
get
/api/v3/tasks/manager
get
/api/v3/tasks/notification-subject-fields
get
/api/v3/tasks/search
get
/api/v3/tasks/send-queue
get
/api/v3/tasks/statuses
patch
/api/v3/tasks/unified
post
/api/v3/tasks/unified
patch
/api/v3/tasks/unified
del
/api/v3/tasks/unified/{task_id}
get
/api/v3/tasks/unified/{task_id}
del
/api/v3/admin/task/blueprint
get
/api/v3/admin/task/blueprint
post
/api/v3/admin/task/blueprint
patch
/api/v3/admin/task/blueprint
del
/api/v3/tasks
post
/api/v3/tasks/{task_id}
patch
/api/v3/transaction/{tx_id}/roles/bulk
del
/api/v3/transaction/{tx_id}/roles/{assignment_id}
del
team
/api/v3/team/dm
get
/api/v3/team/dm
post
/api/v3/team/dm
patch
/api/v3/team/dm/count
get
/api/v3/team/dm/status
patch
/api/v3/team/dm/status/bulk
patch
/api/v3/team/dms
get
/api/v3/team/features
get
(Deprecated) Get a team's theme
get
/api/v3/team/{team_id}/add-existing-user
post
Get a team's theme
get
Update a team's theme colors and logo URLs
patch
Upload a team theme logo or icon
post
Get the calling team's Sunburst onboarding progress
get
Update the calling team's progress on a single Sunburst onboarding step
patch
transaction
Get transaction form definition and rendered field data
get
Create a new transaction
post
Update an existing transaction
patch
/api/v3/transaction/action/options
get
/api/v3/transaction/date
get
/api/v3/transaction/date
patch
/api/v3/transaction/details
put
/api/v3/transaction/fields
get
/api/v3/transaction/fields
patch
/api/v3/transaction/filter/form
get
/api/v3/transaction/filters
get
/api/v3/transaction/filters
post
/api/v3/transaction/filters
patch
/api/v3/transaction/filters
del
/api/v3/transaction/filters/copy
post
/api/v3/transaction/form/select-element/options
get
/api/v3/transaction/form/select-options
get
/api/v3/transaction/forms
get
/api/v3/transaction/history
get
/api/v3/transaction/permissions
get
/api/v3/transaction/portal_access/info
get
/api/v3/transaction/select-options
get
/api/v3/transaction/send
get
/api/v3/transaction/send
post
/api/v3/transaction/stage/options
get
/api/v3/transaction/status/choices
get
/api/v3/transaction/vendors
get
/api/v3/transactions/archive
post
/api/v3/transactions/bulk
get
/api/v3/transactions/bulk
put
/api/v3/transactions/delete
del
/api/v3/transactions/duplicate
get
/api/v3/transactions/fields
get
/api/v3/transactions/image
get
/api/v3/transactions/image
post
/api/v3/transactions/image
del
/api/v3/transactions/lock
get
/api/v3/transactions/manager
get
/api/v3/transactions/manager/status
get
/api/v3/transactions/merge
get
/api/v3/transactions/merge
put
/api/v3/transactions/records
get
/api/v3/transactions/records/download
get
/api/v3/transactions/render-email-template
post
/api/v3/transactions/statuses
get
/api/v3/transactions/trigger/choices
get
/api/v3/transactions/unarchive
get
/api/v3/transactions/unlock
get
/api/v3/transactions/watchers
get
/api/v3/transactions/watchers
post
/api/v3/transactions/watchers
del
/api/v3/transactions/watchers/potential
get
/api/v3/transactions/{transaction_id}/splits
get
/api/v3/transaction/roles
get
/api/v3/transaction/{tx_id}/roles
get
/api/v3/transaction/{tx_id}/roles
post
/api/v3/transaction/{tx_id}/roles/bulk
put
contact
user
Get external authentication status
get
Revoke external authentication
del
Initiate Gmail OAuth authorization
get
Gmail OAuth callback
get
/api/v3/user-team/enroll
post
/api/v3/user/alert
get
/api/v3/user/alert
patch
/api/v3/user/alert-count
get
/api/v3/user/alerts
get
/api/v3/user/available-scopes
get
/api/v3/user/captcha
get
/api/v3/user/change-password
patch
/api/v3/user/forgot-password
post
/api/v3/user/forms
get
/api/v3/user/info
get
/api/v3/user/keep-alive
get
/api/v3/user/landing-page-choices
get
/api/v3/user/log-out
patch
/api/v3/user/login
post
/api/v3/user/lookup
get
/api/v3/user/notification_settings
get
/api/v3/user/notification_settings
patch
/api/v3/user/otp
get
/api/v3/user/otp
post
/api/v3/user/ping
get
/api/v3/user/profile
get
/api/v3/user/profile
patch
/api/v3/user/profile/defaults
get
/api/v3/user/profile/defaults
patch
/api/v3/user/profile/image
post
/api/v3/user/profile/image
del
/api/v3/user/reset-password
get
/api/v3/user/reset-password
patch
/api/v3/user/selected-date-range
get
/api/v3/user/selected-date-range
patch
/api/v3/user/sso
post
/api/v3/user/sso-key
get
/api/v3/user/token-from-secret
get
/api/v3/user/search
post
/api/v3/user/{agent_id}/welcome-email
post
/api/v3/users/lookup
get
QuickBooks OAuth callback
get
List verified Gmail sending aliases
get
Select a Gmail sending alias
patch
challenges
/api/v3/challenges
get
/api/v3/challenges
post
/api/v3/challenges
del
/api/v3/challenges/challenge-chart
get
/api/v3/challenge-data
get
/api/v3/challenges/challenge-list
get
/api/v3/challenges/details
get
/api/v3/challenges/display
get
/api/v3/challenges/form-options
get
/api/v3/challenges/run
post
/api/v3/challenges/scoreboard
get
/api/v3/challenges/scoreboard/details
get
Public endpoint for shared challenge links
get
/api/v3/challenges/toggle-priority
get
Challenge display data for a shared link
get
client_portal_fields
/api/v3/client-portal-fields
get
/api/v3/client-portal-fields
post
/api/v3/client-portal-fields
patch
/api/v3/client-portal-fields
del
commission
/api/v3/caps
get
/api/v3/commission
get
/api/v3/commission/adjustment
get
/api/v3/commission/adjustment
post
/api/v3/commission/adjustment
patch
/api/v3/commission/adjustment
del
/api/v3/commission/adjustment/category
get
/api/v3/commission/adjustment/options
get
/api/v3/commission/cda
get
/api/v3/commission/cda
post
/api/v3/commission/cda/instruction-template
get
/api/v3/commission/cda/options
get
/api/v3/commission/certify
patch
/api/v3/commission/de-certify
patch
/api/v3/commission/send
get
/api/v3/commission/send
post
/api/v3/commission/split
get
/api/v3/commission/split
post
/api/v3/commission/split
patch
/api/v3/commission/split
del
/api/v3/commission/split/options
get
/api/v3/commission/template
post
/api/v3/commission/template/apply
post
/api/v3/commission/template/records
get
/api/v3/commission/templates
get
custom dashboards
/api/v3/dashboards/configurations
get
/api/v3/dashboards/configurations
post
/api/v3/dashboards/configurations
patch
/api/v3/dashboards/configurations
del
/api/v3/dashboards/configurations/copy
post
/api/v3/dashboards/metrics
get
/api/v3/dashboards/run
get
/api/v3/dashboards/special-dates
get
/api/v3/dashboards/tiles
get
/api/v3/dashboards/tiles
post
/api/v3/dashboards/tiles
patch
/api/v3/dashboards/tiles
del
/api/v3/dashboards/widget-types
get
/api/v3/dashboards/widgets
get
/api/v3/dashboards/widgets
post
/api/v3/dashboards/widgets
patch
/api/v3/dashboards/widgets
del
/api/v3/dashboards/widgets/copy
post
documents
/api/v3/documents
get
/api/v3/documents
post
/api/v3/documents
patch
/api/v3/documents
del
/api/v3/documents/applicable-types
get
/api/v3/documents/applicable-types
patch
/api/v3/documents/approve-all
patch
/api/v3/documents/archive
post
/api/v3/documents/bulk-delete
del
/api/v3/documents/bulk-move
patch
/api/v3/documents/categories
get
/api/v3/documents/categories
del
/api/v3/documents/comments
get
/api/v3/documents/comments
post
/api/v3/documents/comments
patch
/api/v3/documents/file
get
/api/v3/documents/folders
get
/api/v3/documents/folders
post
/api/v3/documents/folders
patch
/api/v3/documents/folders
del
/api/v3/documents/review
get
/api/v3/documents/search
get
/api/v3/documents/send
post
/api/v3/documents/send-to-options
get
/api/v3/documents/shared/{key}
get
/api/v3/documents/types
get
/api/v3/documents/types
patch
/api/v3/documents/types
del
/api/v3/documents/{document_id}
get
/api/v3/documents/{document_id}
patch
/api/v3/documents/{document_id}
del
/api/v3/documents/{document_id}/file
get
/api/v3/documents/{document_id}/types
get
/api/v3/documents/{document_id}/types
patch
/api/v3/documents/{document_id}/types
del
expenses
/api/v3/admin/expenses
get
general
/api/v3/app/version
get
/api/v3/general/agent/options
get
/api/v3/general/lead/options
get
/api/v3/tooltips
get
enroll
goals
/api/v3/goal_calculator
post
/api/v3/goal_groups
get
/api/v3/goal_percents
get
/api/v3/goals
get
/api/v3/goals/update
post
/api/v3/goal-groups
get
/api/v3/goal-percents
get
/api/v3/goals/{year}/percents
get
integrations
/api/v3/configurations
get
/api/v3/configurations
post
/api/v3/configurations
patch
/api/v3/configurations
del
/api/v3/instances
get
/api/v3/instances
post
/api/v3/instances
patch
/api/v3/instances
del
/api/v3/instances/{integration_instance_id}
get
/api/v3/integration-categories
get
/api/v3/integration-hub
get
/api/v3/integrations
get
/api/v3/integrations
post
/api/v3/integrations
patch
/api/v3/integrations
del
/api/v3/integrations/dotloop/info
get
/api/v3/integrations/{integration_name}
get
lost transaction reasons
/api/v3/lost-reasons
get
/api/v3/lost-reasons
post
/api/v3/lost-reasons/merge
post
/api/v3/lost-reasons/{lost_reason_id}
get
/api/v3/lost-reasons/{lost_reason_id}
put
/api/v3/lost-reasons/{lost_reason_id}
del
/api/v3/lost-reasons/{lost_reason_id}/restore
post
organization
/api/v3/organization/model-agent
get
/api/v3/organization/model-agent
post
/api/v3/organization/model-team
get
/api/v3/organization/model-team
post
Get org-admin scope context
get
Get org-coach scope context
get
/api/v3/organization/{organization_id}/teams
get
reports
/api/v3/report/active_listings_and_buyers
get
/api/v3/report/activity
get
/api/v3/report/activity_log
get
/api/v3/report/agent_accountability
get
/api/v3/report/agent_income
get
/api/v3/report/agent_opportunity_cost
get
/api/v3/report/caps
get
/api/v3/report/commission
get
/api/v3/report/commission_adjustments_splits
get
/api/v3/report/commission_cda_payments
get
/api/v3/report/commission_cda_payments_alpha
get
/api/v3/report/commission_payments
get
/api/v3/report/commission_payments_alpha
get
/api/v3/report/commissions_alpha
get
/api/v3/report/filters
get
/api/v3/report/income
get
/api/v3/report/income_by_org
get
/api/v3/report/income_monthly_summaries
get
/api/v3/report/integrated_vendors
get
/api/v3/report/isa
get
/api/v3/report/isa_by_agent
get
/api/v3/report/lead_source_opportunity_cost
get
/api/v3/report/lead_source_roi
get
/api/v3/report/lead_source_roi_by_agent
get
/api/v3/report/lead_source_roi_by_agent_test
get
/api/v3/report/lead_source_roi_by_lead_source
get
/api/v3/report/lead_source_roi_by_lead_source_test
get
/api/v3/report/lead_sources_by_agent
get
/api/v3/report/lead_sources_by_agent/download
get
/api/v3/report/lead_sources_by_status
get
/api/v3/report/lead_sources_by_status/download
get
/api/v3/report/new_income
get
/api/v3/report/performance_and_conversion/download
get
/api/v3/report/price_change
get
/api/v3/report/production
get
/api/v3/report/production_and_activity
get
/api/v3/report/summary_dashboard
get
/api/v3/report/tasks_overdue
get
/api/v3/report/transaction_kpis
get
/api/v3/report/vendor
get
/api/v3/report/vendor/download
get
Get Ad Hoc Report
get
Get Ad Hoc Report Options
get
/api/v3/report/commission/modal
get
/api/v3/reports/lead-sources
get
settings
/api/v3/settings/vendor-invites
get
/api/v3/settings/vendor-invites
patch
sunburst
/api/v3/sunburst/canned/{prompt_id}
post
/api/v3/sunburst/chat
get
/api/v3/sunburst/chat
post
/api/v3/sunburst/chat/insights
get
/api/v3/sunburst/chat/share
post
/api/v3/sunburst/enroll
get
/api/v3/sunburst/enroll
post
/api/v3/sunburst/enroll/notify
post
/api/v3/sunburst/enroll/track
post
/api/v3/sunburst/feedback
post
/api/v3/sunburst/files/upload
post
/api/v3/sunburst/files/{file_id}/download
get
/api/v3/sunburst/history
get
/api/v3/sunburst/history
del
/api/v3/sunburst/interview/begin
post
/api/v3/sunburst/interview/config
get
/api/v3/sunburst/interview/config
post
/api/v3/sunburst/interview/config
patch
/api/v3/sunburst/interview/end
post
/api/v3/sunburst/interview/history
get
/api/v3/sunburst/interview/periods
get
/api/v3/sunburst/prompts
get
/api/v3/sunburst/scheduled-prompt
get
/api/v3/sunburst/scheduled-prompt
post
/api/v3/sunburst/scheduled-prompt
patch
/api/v3/sunburst/scheduled-prompt
del
/api/v3/sunburst/scheduled-prompts/list
get
/api/v3/sunburst/transactions/{client_id}/documents/{document_id}/evaluate
get
/api/v3/sunburst/transactions/{client_id}/insights/most-likely-buyer
get
/api/v3/sunburst/usage
get
/api/v3/sunburst/interview/commitments/summarize
post
/api/v3/sunburst/interview/dashboard
get
/api/v3/sunburst/interview/{log_id}/review
patch
/api/v3/sunburst/interview/log
get
/api/v3/sunburst/projects
get
/api/v3/sunburst/projects
post
/api/v3/sunburst/projects/{project_id}
get
/api/v3/sunburst/projects/{project_id}
patch
/api/v3/sunburst/projects/{project_id}
del
/api/v3/sunburst/projects/{project_id}/files
post
/api/v3/sunburst/projects/{project_id}/files/{project_file_id}
del
/api/v3/sunburst/team/objective
get
/api/v3/sunburst/team/objective
post
/api/v3/sunburst/team/objective
patch
/api/v3/sunburst/interview/{log_id}
del
/api/v3/sunburst/scheduled/{prompt_id}
post
/api/v3/sunburst/interview/config/notification-rules
get
/api/v3/sunburst/interview/config/notification-rules
put
/api/v3/sunburst/onboarding/{step_key}
post
vendors
/api/v3/enroll/vendor/link/info
get
/api/v3/user/profile/image
get
/api/v3/enroll/vendor
post
/api/v3/vendor/search
get
/api/v3/vendors
get
/api/v3/vendors
post
/api/v3/vendors/types
get
/api/v3/vendors/{vendor_id}
get
/api/v3/vendors/{vendor_id}
patch
/api/v3/vendors/{vendor_id}
del
/api/v3/vendors/{vendor_id}/send-platform-invite
post
activities
/api/v3/activities
get
/api/v3/activities
patch
activity-types
/api/v3/activity-types
get
/api/v3/activity-types
post
/api/v3/activity-types/{activity_type}
patch
/api/v3/activity-types/{activity_type}
del
agents
Bulk-create agents on a team
post
contacts
/api/v3/contacts
post
/api/v3/contacts/find
get
/api/v3/contacts/search
get
/api/v3/contacts/{contact_id}
get
/api/v3/contacts/{contact_id}
patch
/api/v3/contacts/{contact_id}/info
get
custom-fields
/api/v3/custom-fields
get
/api/v3/custom-fields
post
/api/v3/custom-fields/{field_name}
patch
/api/v3/custom-fields/{field_name}
del
document-categories
/api/v3/document-categories
get
/api/v3/document-categories
post
/api/v3/document-categories/{team_document_category_id}
patch
/api/v3/document-categories/{team_document_category_id}
del
document-folders
/api/v3/document-folders
get
/api/v3/document-folders
post
/api/v3/document-folders/{folder_id}
get
/api/v3/document-folders/{folder_id}
patch
/api/v3/document-folders/{folder_id}
del
document-types
/api/v3/document-types
get
/api/v3/document-types
post
/api/v3/document-types/{team_document_type_id}
patch
/api/v3/document-types/{team_document_type_id}
del
/api/v3/documents/types/manage
get
/api/v3/documents/types/manage
post
/api/v3/documents/types/manage
patch
/api/v3/documents/types/manage
del
external-services
/api/v3/external-services
get
/api/v3/external-services/{external_service_id}/contacts/{external_id}
get
/api/v3/external-services/{external_service_id}/transactions/{external_id}
get
/api/v3/external-services/{external_service_id}/users/{external_id}
get
forms
/api/v3/forms
get
/api/v3/forms
post
/api/v3/forms/{form_id}
patch
/api/v3/forms/{form_id}
del
/api/v3/forms/{form_id}/default
patch
/api/v3/forms/{form_id}/fields
get
/api/v3/forms/{form_id}/fields
patch
/api/v3/forms/{form_id}/fields
del
/api/v3/forms/{form_id}/fields/available
get
/api/v3/forms/{form_id}/fields/available
patch
/api/v3/forms/{form_id}/fields/order
patch
kpi
Get KPI by ID
get
/api/v3/kpi
post
/api/v3/kpi
del
/api/v3/kpi/data
get
/api/v3/kpi/data
post
/api/v3/kpi/data
del
lead-sources
/api/v3/lead-sources
get
/api/v3/lead-sources
post
/api/v3/lead-sources/merge
post
/api/v3/lead-sources/{lead_source_id}
get
/api/v3/lead-sources/{lead_source_id}
patch
/api/v3/lead-sources/{lead_source_id}/at-bats
post
/api/v3/lead-sources/{lead_source_id}/counts-expenses
get
/api/v3/lead-sources/{lead_source_id}/counts-expenses
post
Metabase
Create a guest embedding token for a Metabase entity
post
profile
/api/v3/profile
get
/api/v3/profile
patch
Push Devices
Retrieve push devices for the authenticated agent
get
Register or refresh a push device for the authenticated agent
post
Send a test push notification
post
Update a push device registration for the authenticated agent
patch
Delete a push device registration for the authenticated agent
del
team-library
/api/v3/team-library
get
Update team library content (admin only)
patch
/api/v3/team-library/documents/file/{team_document_id}
get
Upload one or more documents to the team library
post
Rename a team library document
patch
Delete a team library document
del
Archive or unarchive a team library document
patch
teams
/api/v3/teams/{team_id}
get
/api/v3/teams/{team_id}
patch
transaction-forms
/api/v3/transaction-forms
get
transaction-stages
/api/v3/transaction-stages
get
/api/v3/transaction-stages
post
/api/v3/transaction-stages/{client_stage_id}
patch
/api/v3/transaction-stages/{client_stage_id}
del
/api/v3/transaction-stages/{client_stage_id}/order
patch
transaction-tags
/api/v3/transaction-tags
get
/api/v3/transaction-tags
post
/api/v3/transaction-tags/{tag_id}
get
/api/v3/transaction-tags/{tag_id}
patch
/api/v3/transaction-tags/{tag_id}
del
transactions
/api/v3/transaction/{transaction_id}/parameter
get
/api/v3/transaction/{transaction_id}/parameter
patch
/api/v3/transaction/{transaction_id}/parameter
del
/api/v3/transactions/lead-history
get
/api/v3/transactions/tags
get
/api/v3/transactions/toggle-hide-from-boards
patch
/api/v3/transactions
get
/api/v3/transactions
post
/api/v3/transactions/{client_id}
get
/api/v3/transactions/{client_id}
patch
/api/v3/transactions/{client_id}/details
get
/api/v3/transactions/{client_id}/details
put
/api/v3/transactions/{transaction_id}/archive
post
/api/v3/transactions/new
get
users
/api/v3/users
get
/api/v3/users
post
/api/v3/users/{agent_id}
get
/api/v3/users/{agent_id}
patch
/api/v3/users/{agent_id}
del
Webhooks
Retrieve all webhooks for the current team
get
Create a new webhook subscription
post
Send a test message to all webhooks
post
Update a webhook's display name
patch
Delete a webhook by its webhook_id
del
List all webhook event types
get
List all entity-wide webhook triggers for the team
get
Create an entity-wide webhook trigger
post
Partially update an entity-wide webhook trigger
patch
Delete an entity-wide webhook trigger
del
List all triggers for a webhook
get
Upsert triggers for a webhook
put
Delete a single trigger from a webhook
del
external-id-migrations
Bulk update external IDs
post
/api/v3/catalyst/measure-integrity
Set or clear the measure integrity start month for this team
patch
/api/v3/catalyst/measure
Return cohort-based conversion measurement for the resolved scope (24h cached)
get
/api/v3/catalyst/plans
List Conversion Catalyst plans for the authenticated team
get
Create a new Conversion Catalyst plan
post
/api/v3/catalyst/plans/{plan_id}
Get a Conversion Catalyst plan with full payload
get
Update a Conversion Catalyst plan; pass expected_revision for optimistic concurrency
patch
Delete a Conversion Catalyst plan and its history
del
/api/v3/catalyst/plans/{plan_id}/history
List archived revisions for a plan
get
/api/v3/catalyst/playbooks
List all playbooks
get
Create a playbook (admin only)
post
/api/v3/catalyst/playbooks/{playbook_id}
Update a playbook (admin only)
patch
Delete a playbook (admin only)
del
/api/v3/catalyst/plays
List all standard plays in the catalog
get
Create a custom play in the catalog (admin only)
post
/api/v3/catalyst/plays/{play_id}
Update a play in the catalog (admin only)
patch
Delete a play from the catalog (admin only)
del
/api/v3/catalyst/settings
Get per-team Catalyst settings (including measure_integrity_start_ym)
get
Powered by
Copy Page
enroll
Updated over 1 year ago
/api/v3/tooltips
goals
Updated over 1 year ago
/api/v3/tooltips
goals
