The Salesloft REST API provides programmatic access to Salesloft platform data including accounts, people, cadences, calls, emails, tasks, opportunities, and analytics. Uses OAuth 2.0 and Bearer token authentication. Base URL is https://api.salesloft.com/v2.
openapi: 3.0.0
info:
title: Salesloft
description: >-
This data allows integration owners to self-serve and claim more ownership
over API usage, especially when using the Signals API to integrate with
Rhythm. This ...
version: 1.0.0
servers:
- url: http://{{salesloft_api_base_url}}
- url: https://accounts.salesloft.com
- url: http://{{salesloft_api_base_url}}external
components:
securitySchemes:
noauthAuth:
type: http
scheme: noauth
bearerAuth:
type: http
scheme: bearer
oauth2Auth:
type: http
scheme: oauth2
security:
- oauth2Auth: []
tags:
- name: Account and People Redaction
description: >-
[https://developer.salesloft.com/docs/api/account-and-people-redaction/](https://developer.salesloft.com/docs/api/account-and-people-redaction/)
- name: Account Redaction
description: >-
[https://developer.salesloft.com/docs/api/account-redaction/](https://developer.salesloft.com/docs/api/account-redaction/)
- name: Account Stages
description: >-
[https://developer.salesloft.com/docs/api/account-stages/](https://developer.salesloft.com/docs/api/account-stages/)
- name: Account Team Member Roles
description: >-
[https://developer.salesloft.com/docs/api/account-team-member-roles-index/](https://developer.salesloft.com/docs/api/account-team-member-roles-index/)
- name: Account Tiers
description: >-
[https://developer.salesloft.com/docs/api/account-tiers/](https://developer.salesloft.com/docs/api/account-tiers/)
- name: Account Upserts
description: >-
[https://developer.salesloft.com/docs/api/account-upserts/](https://developer.salesloft.com/docs/api/account-upserts/)
- name: Accounts
description: >-
[https://developer.salesloft.com/docs/api/accounts/](https://developer.salesloft.com/docs/api/accounts/)
- name: Actions
description: >-
[https://developer.salesloft.com/docs/api/actions/](https://developer.salesloft.com/docs/api/actions/)
- name: Activities
description: >-
[https://developer.salesloft.com/docs/api/activities/](https://developer.salesloft.com/docs/api/activities/)
- name: Activity Histories
description: >-
[https://developer.salesloft.com/docs/api/activity-histories/](https://developer.salesloft.com/docs/api/activity-histories/)
- name: Bulk Jobs
description: >-
[https://developer.salesloft.com/docs/api/bulk-jobs/](https://developer.salesloft.com/docs/api/bulk-jobs/)
- name: Bulk Jobs - Job Data
description: >-
[https://developer.salesloft.com/docs/api/bulk-jobs-job-data/](https://developer.salesloft.com/docs/api/bulk-jobs-job-data/)
- name: Bulk Jobs - Results
description: >-
[https://developer.salesloft.com/docs/api/bulk-jobs-results/](https://developer.salesloft.com/docs/api/bulk-jobs-results/)
- name: Bulk Reschedule Tasks
description: >-
[https://developer.salesloft.com/docs/api/bulk-reschedule-tasks/](https://developer.salesloft.com/docs/api/bulk-reschedule-tasks/)
- name: Cadence Exports
description: >-
[https://developer.salesloft.com/docs/api/cadence-exports/](https://developer.salesloft.com/docs/api/cadence-exports/)
- name: Cadence Imports
description: >-
[https://developer.salesloft.com/docs/api/cadence-imports/](https://developer.salesloft.com/docs/api/cadence-imports/)
- name: Cadence Memberships
description: >-
[https://developer.salesloft.com/docs/api/cadence-memberships/](https://developer.salesloft.com/docs/api/cadence-memberships/)
- name: Cadence Stats
description: >-
[https://developer.salesloft.com/docs/api/cadence-stats/](https://developer.salesloft.com/docs/api/cadence-stats/)
- name: Cadences
description: >-
[https://developer.salesloft.com/docs/api/cadences/](https://developer.salesloft.com/docs/api/cadences/)
- name: Calendar Events
description: >-
[https://developer.salesloft.com/docs/api/calendar-events/](https://developer.salesloft.com/docs/api/calendar-events/)
- name: Call Data Records
description: >-
[https://developer.salesloft.com/docs/api/call-data-records/](https://developer.salesloft.com/docs/api/call-data-records/)
- name: Call Dispositions
description: >-
[https://developer.salesloft.com/docs/api/call-dispositions/](https://developer.salesloft.com/docs/api/call-dispositions/)
- name: Call Instructions
description: >-
[https://developer.salesloft.com/docs/api/call-instructions/](https://developer.salesloft.com/docs/api/call-instructions/)
- name: Call Sentiments
description: >-
[https://developer.salesloft.com/docs/api/call-sentiments/](https://developer.salesloft.com/docs/api/call-sentiments/)
- name: Caller Ids
description: >-
[https://developer.salesloft.com/docs/api/caller-ids/](https://developer.salesloft.com/docs/api/caller-ids/)
- name: Calls
description: >-
[https://developer.salesloft.com/docs/api/calls/](https://developer.salesloft.com/docs/api/calls/)
- name: Client Credentials Access Token
description: >-
If you are building a private OAuth app, it's likely easier to use Client
Credentials rather than OAuth2.0 refresh tokens. Use the request in this
folder to retreive an access_token for your private OAuth app using client
credentials. The request includes a Postman script to add the returned
access_token as a variable in the collection. To use this token in
subsequent requests, adjust the authorization of the request to Bearer
Token and add {{client_credentials_token}} in the token field.
- name: Conversations
description: >-
[https://developer.salesloft.com/docs/api/conversations/](https://developer.salesloft.com/docs/api/conversations/)
- name: Conversations Calls
description: >-
[https://developer.salesloft.com/docs/api/conversations-calls/](https://developer.salesloft.com/docs/api/conversations-calls/)
- name: Counts
description: >-
[https://developer.salesloft.com/docs/api/counts/](https://developer.salesloft.com/docs/api/counts/)
- name: Crm Account Team Members
description: >-
[https://developers.salesloft.com/docs/api/crm-account-team-members/](https://developers.salesloft.com/docs/api/crm-account-team-members/)
- name: Crm Activities
description: >-
[https://developer.salesloft.com/docs/api/crm-activities/](https://developer.salesloft.com/docs/api/crm-activities/)
- name: Crm Activity Fields
description: >-
[https://developer.salesloft.com/docs/api/crm-activity-fields/](https://developer.salesloft.com/docs/api/crm-activity-fields/)
- name: Crm Users
description: >-
[https://developer.salesloft.com/docs/api/crm-users/](https://developer.salesloft.com/docs/api/crm-users/)
- name: Custom Fields
description: >-
[https://developer.salesloft.com/docs/api/custom-fields/](https://developer.salesloft.com/docs/api/custom-fields/)
- name: Custom Roles
description: >-
[https://developer.salesloft.com/docs/api/custom-roles/](https://developer.salesloft.com/docs/api/custom-roles/)
- name: Email Missing Tags
description: >-
[https://developer.salesloft.com/docs/api/email-missing-tags/](https://developer.salesloft.com/docs/api/email-missing-tags/)
- name: Email Template Attachments
description: >-
[https://developer.salesloft.com/docs/api/email-template-attachments/](https://developer.salesloft.com/docs/api/email-template-attachments/)
- name: Email Templates
description: >-
[https://developer.salesloft.com/docs/api/email-templates/](https://developer.salesloft.com/docs/api/email-templates/)
- name: Emails
description: >-
[https://developer.salesloft.com/docs/api/emails/](https://developer.salesloft.com/docs/api/emails/)
- name: External Emails
description: >-
[https://developer.salesloft.com/docs/api/external-emails/](https://developer.salesloft.com/docs/api/external-emails/)
- name: External Id Configuration
description: >-
[https://developer.salesloft.com/docs/api/external-id-configuration/](https://developer.salesloft.com/docs/api/external-id-configuration/)
- name: External Id Mapping
description: >-
[https://developer.salesloft.com/docs/api/external-id-mapping/](https://developer.salesloft.com/docs/api/external-id-mapping/)
- name: Groups
description: >-
[https://developer.salesloft.com/docs/api/groups/](https://developer.salesloft.com/docs/api/groups/)
- name: Imports
description: >-
[https://developer.salesloft.com/docs/api/imports/](https://developer.salesloft.com/docs/api/imports/)
- name: Live Feed Items
description: >-
[https://developer.salesloft.com/docs/api/live-feed-items/](https://developer.salesloft.com/docs/api/live-feed-items/)
- name: Live Website Tracking Parameters
description: >-
[https://developer.salesloft.com/docs/api/live-website-tracking-parameters/](https://developer.salesloft.com/docs/api/live-website-tracking-parameters/)
- name: Me
description: >-
[https://developer.salesloft.com/docs/api/me/](https://developer.salesloft.com/docs/api/me/)
- name: Meetings
description: >-
[https://developer.salesloft.com/docs/api/meetings/](https://developer.salesloft.com/docs/api/meetings/)
- name: Mime Email Payloads
description: >-
[https://developer.salesloft.com/docs/api/mime-email-payloads/](https://developer.salesloft.com/docs/api/mime-email-payloads/)
- name: Notes
description: >-
[https://developer.salesloft.com/docs/api/notes/](https://developer.salesloft.com/docs/api/notes/)
- name: Ongoing Actions
description: >-
[https://developer.salesloft.com/docs/api/ongoing-actions/](https://developer.salesloft.com/docs/api/ongoing-actions/)
- name: Opportunities
description: >-
[https://developers.salesloft.com/docs/api/opportunities/](https://developers.salesloft.com/docs/api/opportunities/)
- name: Opportunity People
description: >-
[https://developers.salesloft.com/docs/api/opportunity-people/](https://developers.salesloft.com/docs/api/opportunity-people/)
- name: Opportunity Stages
description: >-
[https://developers.salesloft.com/docs/api/opportunity-stages/](https://developers.salesloft.com/docs/api/opportunity-stages/)
- name: Pending Emails
description: >-
[https://developer.salesloft.com/docs/api/pending-emails/](https://developer.salesloft.com/docs/api/pending-emails/)
- name: People
description: >-
[https://developer.salesloft.com/docs/api/people/](https://developer.salesloft.com/docs/api/people/)
- name: People Soft Deletion
description: >-
[https://developer.salesloft.com/docs/api/people-soft-deletion/](https://developer.salesloft.com/docs/api/people-soft-deletion/)
- name: Person Stages
description: >-
[https://developer.salesloft.com/docs/api/person-stages/](https://developer.salesloft.com/docs/api/person-stages/)
- name: Person Upserts
description: >-
[https://developer.salesloft.com/docs/api/person-upserts/](https://developer.salesloft.com/docs/api/person-upserts/)
- name: Phone Number Assignments
description: >-
[https://developer.salesloft.com/docs/api/phone-number-assignments/](https://developer.salesloft.com/docs/api/phone-number-assignments/)
- name: Play Registrations
description: >-
[https://developer.salesloft.com/docs/api/play-registrations/](https://developer.salesloft.com/docs/api/play-registrations/)
- name: Profiles
description: >-
[https://developers.salesloft.com/docs/api/profiles/](https://developers.salesloft.com/docs/api/profiles/)
- name: Recording Settings
description: >-
[https://developer.salesloft.com/docs/api/recording-settings/](https://developer.salesloft.com/docs/api/recording-settings/)
- name: Requests
description: >-
[https://developer.salesloft.com/docs/api/requests/](https://developer.salesloft.com/docs/api/requests/)
- name: Reschedule Links
description: >-
[https://developer.salesloft.com/docs/api/reschedule-links/](https://developer.salesloft.com/docs/api/reschedule-links/)
- name: Right to Be Forgotten
description: >-
[https://developer.salesloft.com/docs/api/right-to-be-forgotten/](https://developer.salesloft.com/docs/api/right-to-be-forgotten/)
- name: Saved List Views
description: >-
[https://developer.salesloft.com/docs/api/saved-list-views/](https://developer.salesloft.com/docs/api/saved-list-views/)
- name: Searches
description: >-
[https://developer.salesloft.com/docs/api/searches/](https://developer.salesloft.com/docs/api/searches/)
- name: Settings
description: >-
[https://developer.salesloft.com/docs/api/settings/](https://developer.salesloft.com/docs/api/settings/)
- name: Signal Registrations
description: >-
[https://developer.salesloft.com/docs/api/signal-registrations/](https://developer.salesloft.com/docs/api/signal-registrations/)
- name: Signals
description: >-
[https://developer.salesloft.com/docs/api/signals/](https://developer.salesloft.com/docs/api/signals/)
- name: Steps
description: >-
[https://developer.salesloft.com/docs/api/steps/](https://developer.salesloft.com/docs/api/steps/)
- name: Successes
description: >-
[https://developer.salesloft.com/docs/api/successes/](https://developer.salesloft.com/docs/api/successes/)
- name: Tasks
description: >-
[https://developer.salesloft.com/docs/api/tasks/](https://developer.salesloft.com/docs/api/tasks/)
- name: Team
description: >-
[https://developer.salesloft.com/docs/api/team/](https://developer.salesloft.com/docs/api/team/)
- name: Team Template Attachments
description: >-
[https://developer.salesloft.com/docs/api/team-template-attachments/](https://developer.salesloft.com/docs/api/team-template-attachments/)
- name: Team Templates
description: >-
[https://developer.salesloft.com/docs/api/team-templates/](https://developer.salesloft.com/docs/api/team-templates/)
- name: Transcriptions
description: >-
[https://developer.salesloft.com/docs/api/transcriptions/](https://developer.salesloft.com/docs/api/transcriptions/)
- name: Users
description: >-
[https://developer.salesloft.com/docs/api/users/](https://developer.salesloft.com/docs/api/users/)
- name: Webhook Subscriptions
description: >-
[https://developer.salesloft.com/docs/api/webhook-subscriptions/](https://developer.salesloft.com/docs/api/webhook-subscriptions/)
paths:
/me:
get:
tags:
- Me
summary: Salesloft Get Current User
responses:
'200':
description: Successful response
content:
application/json: {}
/team:
get:
tags:
- Team
summary: Salesloft Get Current Team
responses:
'200':
description: Successful response
content:
application/json: {}
/data_control/account_redaction:
post:
tags:
- Account Redaction
summary: Salesloft Execute an Account Redaction Workflow
requestBody:
content:
application/json:
schema:
type: object
example:
team_id: 0
schedule: {}
dry_run: true
account_id: 0
responses:
'200':
description: Successful response
content:
application/json: {}
/account_stages:
get:
tags:
- Account Stages
summary: Salesloft List Account Stages
parameters:
- name: ids
in: query
schema:
type: string
- name: updated_at[gt]
in: query
schema:
type: string
- name: updated_at[gte]
in: query
schema:
type: string
- name: updated_at[lt]
in: query
schema:
type: string
- name: updated_at[lte]
in: query
schema:
type: string
- name: active
in: query
schema:
type: string
- name: sort_by
in: query
schema:
type: string
- name: sort_driection
in: query
schema:
type: string
- name: per_page
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: include_paging_counts
in: query
schema:
type: string
- name: limit_paging_counts
in: query
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json: {}
/account_stages/{id}:
get:
tags:
- Account Stages
summary: Salesloft Fetch an Account Stage
parameters:
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/account_team_member_roles:
get:
tags:
- Account Team Member Roles
summary: Salesloft List CRM Account Team Member Roles
parameters:
- name: sort_by
in: query
schema:
type: string
- name: sort_direction
in: query
schema:
type: string
- name: per_page
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: include_paging_counts
in: query
schema:
type: string
- name: limit_paging_counts
in: query
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json: {}
/account_tiers:
get:
tags:
- Account Tiers
summary: Salesloft List Account Tiers
parameters:
- name: ids
in: query
schema:
type: string
- name: name
in: query
schema:
type: string
- name: active
in: query
schema:
type: string
- name: sort_by
in: query
schema:
type: string
- name: sort_direction
in: query
schema:
type: string
- name: per_page
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: include_paging_counts
in: query
schema:
type: string
- name: limit_paging_counts
in: query
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json: {}
/account_tiers/{id}:
get:
tags:
- Account Tiers
summary: Salesloft Fetch an Account Tier
parameters:
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/account_upserts:
post:
tags:
- Account Upserts
summary: Salesloft Upsert an Account
requestBody:
content:
application/json:
schema:
type: object
example:
id: string
name: string
domain: string
conversational_name: string
description: string
phone: string
website: string
linkedin_url: string
twitter_handle: string
street: string
city: string
state: string
postal_code: string
country: string
locale: string
industry: string
company_type: string
founded: string
revenue_range: string
size: string
do_not_contact: string
custom_fields: {}
tags: string
owner_id: string
company_stage_id: string
account_tier_id: string
crm_id_type: string
crm_id: string
responses:
'200':
description: Successful response
content:
application/json: {}
/data_control/account_and_people_redaction:
post:
tags:
- Account and People Redaction
summary: Salesloft Submit an Account and People Redaction Request
requestBody:
content:
application/json:
schema:
type: object
example:
team_id: 0
schedule: {}
dry_run: true
account_id: 0
responses:
'200':
description: Successful response
content:
application/json: {}
/accounts:
get:
tags:
- Accounts
summary: Salesloft List Accounts
parameters:
- name: ids
in: query
schema:
type: string
- name: crm_id
in: query
schema:
type: string
- name: tag
in: query
schema:
type: string
- name: tag_id
in: query
schema:
type: string
- name: created_at[gt]
in: query
schema:
type: string
- name: created_at[gte]
in: query
schema:
type: string
- name: created_at[lt]
in: query
schema:
type: string
- name: created_at[lte]
in: query
schema:
type: string
- name: updated_at[gt]
in: query
schema:
type: string
- name: updated_at[gte]
in: query
schema:
type: string
- name: updated_at[lt]
in: query
schema:
type: string
- name: updated_at[lte]
in: query
schema:
type: string
- name: domain
in: query
schema:
type: string
- name: website
in: query
schema:
type: string
- name: archived
in: query
schema:
type: string
- name: name
in: query
schema:
type: string
- name: account_stage_id
in: query
schema:
type: string
- name: account_tier_id
in: query
schema:
type: string
- name: owner_id
in: query
schema:
type: string
- name: owner_is_active
in: query
schema:
type: string
- name: last_contacted[gt]
in: query
schema:
type: string
- name: last_contacted[gte]
in: query
schema:
type: string
- name: last_contacted[lt]
in: query
schema:
type: string
- name: last_contacted[lte]
in: query
schema:
type: string
- name: custom_fields
in: query
schema:
type: string
- name: industry
in: query
schema:
type: string
- name: country
in: query
schema:
type: string
- name: state
in: query
schema:
type: string
- name: city
in: query
schema:
type: string
- name: owner_crm_id
in: query
schema:
type: string
- name: locales
in: query
schema:
type: string
- name: user_relationships
in: query
schema:
type: string
- name: sort_by
in: query
schema:
type: string
- name: sort_direction
in: query
schema:
type: string
- name: per_page
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: include_paging_counts
in: query
schema:
type: string
- name: limit_paging_counts
in: query
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json: {}
post:
tags:
- Accounts
summary: Salesloft Create an Account
requestBody:
content:
application/json:
schema:
type: object
example:
name: string
domain: string
conversational_name: string
description: string
phone: string
website: string
linkedin_url: string
twitter_handle: string
street: string
city: string
state: string
postal_code: string
country: string
locale: string
industry: string
company_type: string
founded: string
revenue_range: string
size: string
do_not_contact: true
custom_fields: {}
tags:
- string
owner_id: string
company_stage_id: string
account_tier_id: string
crm_id_type: string
crm_id: string
responses:
'200':
description: Successful response
content:
application/json: {}
/accounts/{id}:
get:
tags:
- Accounts
summary: Salesloft Fetch an Account
parameters:
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
delete:
tags:
- Accounts
summary: Salesloft Delete an Account
parameters:
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/accounts/53457352:
put:
tags:
- Accounts
summary: Salesloft Update an Existing Account
requestBody:
content:
application/json:
schema:
type: object
example:
name: string
domain: string
conversational_name: string
description: string
phone: string
website: string
linkedin_url: string
twitter_handle: string
street: string
city: string
state: string
postal_code: string
country: string
locale: string
industry: string
company_type: string
founded: string
revenue_range: string
size: string
do_not_contact: true
custom_fields: {}
tags:
- string
owner_id: string
company_stage_id: string
account_tier_id: string
crm_id_tyep: string
crm_id: string
archived: false
responses:
'200':
description: Successful response
content:
application/json: {}
/actions:
get:
tags:
- Actions
summary: Salesloft List Actions
parameters:
- name: ids
in: query
schema:
type: string
- name: step_id
in: query
schema:
type: string
- name: type
in: query
schema:
type: string
- name: due_on[gt]
in: query
schema:
type: string
- name: due_on[gte]
in: query
schema:
type: string
- name: due_on[lt]
in: query
schema:
type: string
- name: due_on[lte]
in: query
schema:
type: string
- name: user_guid
in: query
schema:
type: string
- name: person_id
in: query
schema:
type: string
- name: cadence_id
in: query
schema:
type: string
- name: multitouch_group_id
in: query
schema:
type: string
- name: updated_at[gt]
in: query
schema:
type: string
- name: updated_at[gte]
in: query
schema:
type: string
- name: updated_at[lt]
in: query
schema:
type: string
- name: updated_at[lte]
in: query
schema:
type: string
- name: sort_by
in: query
schema:
type: string
- name: sort_direction
in: query
schema:
type: string
- name: per_page
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: include_paging_counts
in: query
schema:
type: string
- name: limit_paging_counts
in: query
schema:
type: string
responses:
'200':
description: Successful response
content:
application/json: {}
/actions/{id}:
get:
tags:
- Actions
summary: Salesloft Fetch an Action
parameters:
- name: id
in: path
schema:
type: string
required: true
responses:
'200':
description: Successful response
content:
application/json: {}
/activities:
get:
tags:
- Activities
summary: Salesloft Create an Activity
responses:
'200':
description: Successful response
content:
application/json: {}
/activity_histories:
get:
tags:
- Activity Histories
summary: Salesloft List Past Activities
parameters:
- name: per_page
in: query
schema:
type: string
- name: page
in: query
schema:
type: string
- name: include_paging_counts
in: query
schema:
type: string
- name: limit_paging_counts
in: query
schema:
type: string
- name: sort_by
in: query
schema:
type: string
- name: sort_direction
in: query
schema:
type: string
- name: type
in: query
schema:
type: string
- name: occurred_at[gt]
in: query
schema:
type: string
- name: occurred_at[gte]
in: query
schema:
type: string
- name: occurred_at[lt]
in: query
schema:
type: string
- name: occurred_at[lte]
in: query
schema:
type: string
- name: pinned
in: query
schema:
type: string
- name: resource_type
in: query
schema:
type: string
- name: resource_id
in: query
schema:
type: string
- name: ids
# --- truncated at 32 KB (146 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesloft/refs/heads/main/openapi/salesloft-openapi.yml