Operations (sample payloads)

Main operations
Copy

Create account
Copy

Creates an account.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "fields": {
4        "full_name": "Acme Corporation",
5        "domain": "acmecorp.com",
6        "conversational_name": "Acme",
7        "description": "A leading provider of innovative solutions",
8        "phone": "1234567890",
9        "website": "https://www.acmecorp.com",
10        "linkedin_url": "https://www.linkedin.com/company/acmecorp",
11        "twitter_handle": "@acmecorp",
12        "street": "123 Main St",
13        "city": "San Francisco",
14        "state": "CA",
15        "postal_code": "94105",
16        "country": "USA",
17        "locale": "en_US",
18        "industry": "Technology",
19        "company_type": "B2B",
20        "founded": "2005",
21        "revenue_range": "$10M - $50M",
22        "size": "100-500",
23        "do_not_contact": false,
24        "custom_fields": [
25            {
26                "key": "Customer Segment",
27                "value": "Enterprise"
28            }
29        ],
30        "tags": [
31            "tech",
32            "saas",
33            "enterprise"
34        ],
35        "owner_id": 12345,
36        "company_stage_id": 2,
37        "account_tier_id": 3
38    }
39}

Sample Output

1{
2    "data": {
3        "id": 67890,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-15T10:30:00Z",
6        "archived_at": null,
7        "name": "Acme Corporation",
8        "domain": "acmecorp.com",
9        "conversational_name": "Acme",
10        "description": "A leading provider of innovative solutions",
11        "phone": "1234567890",
12        "website": "https://www.acmecorp.com",
13        "linkedin_url": "https://www.linkedin.com/company/acmecorp",
14        "twitter_handle": "@acmecorp",
15        "street": "123 Main St",
16        "city": "San Francisco",
17        "state": "CA",
18        "postal_code": "94105",
19        "country": "USA",
20        "locale": "en_US",
21        "industry": "Technology",
22        "company_type": "B2B",
23        "founded": "2005",
24        "revenue_range": "$10M - $50M",
25        "size": "100-500",
26        "crm_id": "CRM12345",
27        "crm_url": "https://crm.example.com/account/CRM12345",
28        "crm_object_type": "Account",
29        "owner_crm_id": "OWNER98765",
30        "last_contacted_at": null,
31        "last_contacted_type": null,
32        "do_not_contact": false,
33        "custom_fields": {
34            "Customer Segment": "Enterprise"
35        },
36        "tags": [
37            "tech",
38            "saas",
39            "enterprise"
40        ],
41        "counts": {
42            "people": 0
43        },
44        "owner": {
45            "_href": "https://api.salesloft.com/v2/users/12345",
46            "id": 12345
47        },
48        "creator": {
49            "_href": "https://api.salesloft.com/v2/users/54321",
50            "id": 54321
51        },
52        "last_contacted_by": null,
53        "last_contacted_person": null,
54        "company_stage": {
55            "_href": "https://api.salesloft.com/v2/company_stages/2",
56            "id": 2
57        },
58        "account_tier": {
59            "id": 3,
60            "_href": "https://api.salesloft.com/v2/account_tiers/3"
61        }
62    }
63}

Create bulk job
Copy

Creates a bulk job.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "bulk_job_type": "person/upsert",
4    "bulk_job_name": "New Customer Import June 2023"
5}

Sample Output

1{
2    "data": {
3        "created_at": "2023-06-15T14:30:22Z",
4        "errors": 0,
5        "id": 12345,
6        "name": "New Customer Import June 2023",
7        "processed": 0,
8        "ready_to_execute": true,
9        "scopes": [
10            "person_write"
11        ],
12        "state": "pending",
13        "total": 0,
14        "type": "person/upsert"
15    }
16}

Create bulk job data
Copy

Creates job data for the specified bulk job.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "bulk_jobs_id": 12345,
4    "bulk_job_data": [
5        {
6            "first_name": "John",
7            "upsert_key": "email_address",
8            "upsert_key_value": "john.doe@example.com"
9        },
10        {
11            "first_name": "Jane",
12            "upsert_key": "crm_id",
13            "upsert_key_value": "CRM123456"
14        },
15        {
16            "first_name": "Mike",
17            "upsert_key": "id",
18            "upsert_key_value": 789012
19        }
20    ]
21}

Sample Output

1{
2    "data": {
3        "records": 3
4    }
5}

Create cadence membership
Copy

Adds a person to a cadence. A person cannot be added to a cadence on behalf of a teammate unless the cadence is a team cadence, or the cadence is owned by the teammate.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "person_id": 12345,
4    "cadence_id": 67890,
5    "user_id": 54321
6}

Sample Output

1{
2    "data": {
3        "id": 98765,
4        "added_at": "2023-05-15T10:30:00Z",
5        "created_at": "2023-05-15T10:30:00Z",
6        "updated_at": "2023-05-15T10:30:00Z",
7        "person_deleted": false,
8        "currently_on_cadence": true,
9        "current_state": "active",
10        "cadence": {
11            "_href": "https://api.salesloft.com/v2/cadences/67890",
12            "id": 67890
13        },
14        "person": {
15            "_href": "https://api.salesloft.com/v2/people/12345",
16            "id": 12345
17        },
18        "user": {
19            "_href": "https://api.salesloft.com/v2/users/54321",
20            "id": 54321
21        },
22        "latest_action": {
23            "id": 11111
24        },
25        "counts": {
26            "views": 0,
27            "clicks": 0,
28            "replies": 0,
29            "calls": 0,
30            "sent_emails": 0,
31            "bounces": 0
32        }
33    }
34}

Create call
Copy

Creates a call. The parameters of this endpoint can be used to create an action and ensure that the CRM Task is mapped correctly.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "person_id": 12345,
4    "to": "+1 (555) 123-4567",
5    "duration": 300,
6    "disposition": "Interested",
7    "sentiment": "Positive",
8    "notes": "Had a great conversation about our product. The client showed interest in scheduling a demo next week.",
9    "user_guid": "user_abc123",
10    "action_id": 67890,
11    "crm_params": [
12        {
13            "key": "Subject",
14            "value": "Product Demo Call"
15        },
16        {
17            "key": "Description",
18            "value": "Discussed product features and benefits"
19        }
20    ],
21    "linked_call_data_record_ids": [
22        98765,
23        87654
24    ]
25}

Sample Output

1{
2    "data": {
3        "id": 123456,
4        "to": "+1 (555) 123-4567",
5        "duration": 300,
6        "sentiment": "Positive",
7        "disposition": "Interested",
8        "created_at": "2023-05-15T14:30:00Z",
9        "updated_at": "2023-05-15T14:35:00Z",
10        "recordings": [
11            {
12                "url": "https://example.com/recordings/123456.mp3",
13                "recording_status": "completed",
14                "status": "available"
15            }
16        ],
17        "user": {
18            "id": 7890,
19            "_href": "https://api.salesloft.com/v2/users/7890"
20        },
21        "action": {
22            "id": 67890
23        },
24        "called_person": {
25            "id": 12345,
26            "_href": "https://api.salesloft.com/v2/people/12345"
27        },
28        "crm_activity": {
29            "id": 54321,
30            "_href": "https://api.salesloft.com/v2/crm_activities/54321"
31        },
32        "note": {
33            "id": 98765,
34            "_href": "https://api.salesloft.com/v2/notes/98765"
35        },
36        "cadence": {
37            "id": 11111,
38            "_href": "https://api.salesloft.com/v2/cadences/11111"
39        },
40        "step": {
41            "id": 22222,
42            "_href": "https://api.salesloft.com/v2/steps/22222"
43        }
44    }
45}

Create custom field
Copy

Creates a custom field.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "name": "Customer Satisfaction Score",
4    "field_type": "person"
5}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "name": "Customer Satisfaction Score",
5        "field_type": "person",
6        "value_type": "number",
7        "created_at": "2023-05-15T14:30:00Z",
8        "updated_at": "2023-05-15T14:30:00Z"
9    }
10}

Create import
Copy

Creates an import.

Sample Input

1{
2    "access_token": "your_oauth_access_token_here",
3    "user_id": "12345",
4    "name": "Q4 2023 Lead Import"
5}

Sample Output

1{
2    "data": {
3        "id": 67890,
4        "created_at": "2023-10-15T14:30:22Z",
5        "updated_at": "2023-10-15T14:30:22Z",
6        "name": "Q4 2023 Lead Import",
7        "current_people_count": 0,
8        "imported_people_count": 0
9    }
10}

Create note
Copy

Creates a note.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "content": "Met with client to discuss new product features. They showed interest in our upcoming AI integration.",
4    "associated_with_type": "person",
5    "associated_with_id": "12345",
6    "skip_crm_sync": false,
7    "call_id": 67890,
8    "subject": "Client Meeting Notes",
9    "user_guid": "user_abc123"
10}

Sample Output

1{
2    "data": {
3        "id": 98765,
4        "content": "Met with client to discuss new product features. They showed interest in our upcoming AI integration.",
5        "created_at": "2023-05-15T14:30:00Z",
6        "updated_at": "2023-05-15T14:30:00Z",
7        "user": {
8            "_href": "https://api.salesloft.com/v2/users/456",
9            "id": 456
10        },
11        "associated_with": {
12            "_href": "https://api.salesloft.com/v2/people/12345",
13            "id": 12345
14        },
15        "call": {
16            "_href": "https://api.salesloft.com/v2/calls/67890",
17            "id": 67890
18        }
19    }
20}

Create person
Copy

Creates a person. Either email address or phone/last_name must be provided as a unique lookup on the team.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "fields": {
4        "email_address": "john.doe@example.com",
5        "first_name": "John",
6        "last_name": "Doe",
7        "phone": "1234567890",
8        "title": "Sales Manager",
9        "city": "New York",
10        "state": "NY",
11        "country": "USA",
12        "person_company_name": "Acme Corp",
13        "person_company_website": "https://www.acmecorp.com",
14        "person_company_industry": "Technology",
15        "job_seniority": "manager",
16        "do_not_contact": false,
17        "linkedin_url": "https://www.linkedin.com/in/johndoe",
18        "twitter_handle": "@johndoe",
19        "tags": [
20            "prospect",
21            "tech industry"
22        ],
23        "custom_fields": [
24            {
25                "key": "Lead Source",
26                "value": "Website"
27            },
28            {
29                "key": "Last Interaction",
30                "value": "2023-04-15"
31            }
32        ],
33        "account_id": 12345,
34        "owner_id": 67890
35    }
36}

Sample Output

1{
2    "data": {
3        "id": 987654,
4        "created_at": "2023-04-16T10:30:00Z",
5        "updated_at": "2023-04-16T10:30:00Z",
6        "last_contacted_at": null,
7        "last_replied_at": null,
8        "first_name": "John",
9        "last_name": "Doe",
10        "display_name": "John Doe",
11        "email_address": "john.doe@example.com",
12        "full_email_address": "John Doe <john.doe@example.com>",
13        "secondary_email_address": null,
14        "personal_email_address": null,
15        "phone": "1234567890",
16        "phone_extension": null,
17        "home_phone": null,
18        "mobile_phone": null,
19        "linkedin_url": "https://www.linkedin.com/in/johndoe",
20        "title": "Sales Manager",
21        "city": "New York",
22        "state": "NY",
23        "country": "USA",
24        "work_city": null,
25        "work_state": null,
26        "work_country": null,
27        "crm_url": null,
28        "crm_id": null,
29        "crm_object_type": null,
30        "owner_crm_id": null,
31        "person_company_name": "Acme Corp",
32        "person_company_website": "https://www.acmecorp.com",
33        "person_company_industry": "Technology",
34        "do_not_contact": false,
35        "bouncing": false,
36        "locale": null,
37        "personal_website": null,
38        "twitter_handle": "@johndoe",
39        "last_contacted_type": null,
40        "job_seniority": "manager",
41        "custom_fields": {
42            "Lead Source": "Website",
43            "Last Interaction": "2023-04-15"
44        },
45        "tags": [
46            "prospect",
47            "tech industry"
48        ],
49        "contact_restrictions": [],
50        "counts": {
51            "emails_sent": 0,
52            "emails_viewed": 0,
53            "emails_clicked": 0,
54            "emails_replied_to": 0,
55            "emails_bounced": 0,
56            "calls": 0
57        },
58        "account": {
59            "id": 12345,
60            "_href": "https://api.salesloft.com/v2/accounts/12345"
61        },
62        "owner": {
63            "id": 67890,
64            "_href": "https://api.salesloft.com/v2/users/67890"
65        },
66        "last_contacted_by": null,
67        "import": null,
68        "person_stage": null
69    }
70}

Create person stage
Copy

Creates a person stage.

Sample Input

1{
2    "access_token": "your_oauth_access_token_here",
3    "person_stage_name": "Qualified Lead"
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "name": "Qualified Lead",
5        "created_at": "2023-05-15T14:30:22Z",
6        "updated_at": "2023-05-15T14:30:22Z",
7        "order": 2
8    }
9}

Create task
Copy

Creates a task.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "subject": "Follow up on product demo",
4    "person_id": 12345,
5    "user_id": 67890,
6    "task_type": "call",
7    "due_date": "2023-06-15T14:00:00Z",
8    "current_state": "scheduled",
9    "due_at": "2023-06-15T14:00:00Z",
10    "remind_at": "2023-06-15T10:00:00Z",
11    "idempotency_key": "unique_task_identifier_123"
12}

Sample Output

1{
2    "data": {
3        "id": 987654,
4        "created_at": "2023-06-10T09:30:00Z",
5        "updated_at": "2023-06-10T09:30:00Z",
6        "due_date": "2023-06-15",
7        "due_at": "2023-06-15T14:00:00Z",
8        "subject": "Follow up on product demo",
9        "current_state": "scheduled",
10        "task_type": "call",
11        "remind_at": "2023-06-15T10:00:00Z",
12        "completed_at": null,
13        "person": {
14            "_href": "/v2/people/12345",
15            "id": 12345
16        },
17        "user": {
18            "_href": "/v2/users/67890",
19            "id": 67890
20        },
21        "created_by_user": {
22            "_href": "/v2/users/67890",
23            "id": 67890
24        },
25        "completed_by": null
26    }
27}

Delete account
Copy

Deletes an account. This operation is not reversible without contacting SalesLoft support.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "account_id": 12345
4}

Sample Output

1{
2    "success": true
3}

Delete cadence membership
Copy

Deletes a cadence membership.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
3    "cadence_membership_id": "5f9b2c1e3a4b8d7e6f0c9a12"
4}

Sample Output

1{
2    "success": true
3}

Delete custom field
Copy

Deletes a custom field.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "custom_field_id": 12345
4}

Sample Output

1{
2    "success": true
3}

Delete import
Copy

Deletes an import, by ID only. The associated people can be deleted as part of the deletion process.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "import_id": 12345,
4    "undo": "single"
5}

Sample Output

1{
2    "success": true
3}

Delete note
Copy

Deletes a note.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "note_id": 12345
4}

Sample Output

1{
2    "success": true
3}

Delete person
Copy

Deletes a person.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "person_id": 12345
4}

Sample Output

1{
2    "success": true
3}

Delete person stage
Copy

Deletes a person stage.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "person_stage_id": 12345
4}

Sample Output

1{
2    "success": true
3}

Get account
Copy

Returns information about an account.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "account_id": "12345"
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-20T14:45:00Z",
6        "archived_at": null,
7        "name": "Acme Corporation",
8        "domain": "acmecorp.com",
9        "conversational_name": "Acme",
10        "description": "Leading provider of innovative solutions",
11        "phone": "+1 (555) 123-4567",
12        "website": "https://www.acmecorp.com",
13        "linkedin_url": "https://www.linkedin.com/company/acmecorp",
14        "twitter_handle": "@AcmeCorp",
15        "street": "123 Main St",
16        "city": "San Francisco",
17        "state": "CA",
18        "postal_code": "94105",
19        "country": "United States",
20        "locale": "en-US",
21        "industry": "Technology",
22        "company_type": "Corporation",
23        "founded": "1995",
24        "revenue_range": "$100M-$500M",
25        "size": "1000-5000",
26        "crm_id": "CRM12345",
27        "crm_url": "https://crm.example.com/accounts/CRM12345",
28        "crm_object_type": "Account",
29        "owner_crm_id": "OWNER789",
30        "last_contacted_at": "2023-05-18T09:15:00Z",
31        "last_contacted_type": "email",
32        "do_not_contact": false,
33        "custom_fields": {
34            "Custom Company Field": "VIP Client"
35        },
36        "tags": [
37            "Enterprise",
38            "Tech",
39            "West Coast"
40        ],
41        "counts": {
42            "people": 25
43        },
44        "owner": {
45            "_href": "/v2/users/67890",
46            "id": 67890
47        },
48        "creator": {
49            "_href": "/v2/users/54321",
50            "id": 54321
51        },
52        "last_contacted_by": {
53            "_href": "/v2/users/98765",
54            "id": 98765
55        },
56        "last_contacted_person": {
57            "_href": "/v2/people/11223",
58            "id": 11223
59        },
60        "company_stage": {
61            "_href": "/v2/company_stages/3",
62            "id": 3
63        },
64        "account_tier": {
65            "id": 2,
66            "_href": "/v2/account_tiers/2"
67        }
68    }
69}

Get bulk job
Copy

Retrieves a bulk job.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "bulk_jobs_id": 12345
4}

Sample Output

1{
2    "data": {
3        "created_at": "2023-05-15T10:30:00Z",
4        "errors": 0,
5        "id": 12345,
6        "name": "Weekly Contact Import",
7        "processed": 5000,
8        "ready_to_execute": false,
9        "scopes": [
10            "contacts",
11            "accounts"
12        ],
13        "state": "processing",
14        "total": 10000,
15        "type": "import"
16    }
17}

Get cadence
Copy

Retrieves a cadence by ID.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "cadence_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-20T14:45:00Z",
6        "archived_at": null,
7        "team_cadence": true,
8        "shared": false,
9        "remove_bounces_enabled": true,
10        "remove_replies_enabled": true,
11        "opt_out_link_included": true,
12        "draft": false,
13        "cadence_framework_id": "abcdef123456",
14        "cadence_function": "outreach",
15        "name": "Q2 Sales Outreach",
16        "tags": [
17            "sales",
18            "outreach",
19            "q2"
20        ],
21        "creator": {
22            "_href": "/v2/users/789",
23            "id": 789
24        },
25        "owner": {
26            "_href": "/v2/users/456",
27            "id": 456
28        },
29        "bounced_stage": {
30            "id": 101,
31            "_href": "/v2/cadence_stages/101"
32        },
33        "replied_stage": {
34            "id": 102,
35            "_href": "/v2/cadence_stages/102"
36        },
37        "added_stage": {
38            "id": 103,
39            "_href": "/v2/cadence_stages/103"
40        },
41        "finished_stage": {
42            "id": 104,
43            "_href": "/v2/cadence_stages/104"
44        },
45        "cadence_priority": "normal",
46        "counts": {
47            "cadence_people": 500,
48            "people_acted_on_count": 350,
49            "target_daily_people": 50,
50            "opportunities_created": 25,
51            "meetings_booked": 15
52        }
53    }
54}

Get cadence membership
Copy

Returns information about a cadence membership.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "cadence_membership_id": "12345"
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "added_at": "2023-05-15T10:30:00Z",
5        "created_at": "2023-05-15T10:30:00Z",
6        "updated_at": "2023-05-16T14:45:00Z",
7        "person_deleted": false,
8        "currently_on_cadence": true,
9        "current_state": "active",
10        "cadence": {
11            "_href": "https://api.salesloft.com/v2/cadences/67890",
12            "id": 67890
13        },
14        "person": {
15            "_href": "https://api.salesloft.com/v2/people/54321",
16            "id": 54321
17        },
18        "user": {
19            "_href": "https://api.salesloft.com/v2/users/98765",
20            "id": 98765
21        },
22        "latest_action": {
23            "id": 23456
24        },
25        "counts": {
26            "views": 15,
27            "clicks": 7,
28            "replies": 3,
29            "calls": 2,
30            "sent_emails": 5,
31            "bounces": 0
32        }
33    }
34}

Get call
Copy

Gets a call by ID.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "call_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "to": "+14155551234",
5        "duration": 180,
6        "sentiment": "positive",
7        "disposition": "completed",
8        "created_at": "2023-05-15T14:30:00Z",
9        "updated_at": "2023-05-15T14:33:00Z",
10        "recordings": [
11            {
12                "url": "https://example.com/recordings/12345.mp3",
13                "recording_status": "completed",
14                "status": "available"
15            }
16        ],
17        "user": {
18            "id": 67890,
19            "_href": "https://api.salesloft.com/v2/users/67890"
20        },
21        "action": {
22            "id": 54321
23        },
24        "called_person": {
25            "id": 98765,
26            "_href": "https://api.salesloft.com/v2/people/98765"
27        },
28        "crm_activity": {
29            "id": 11111,
30            "_href": "https://api.salesloft.com/v2/crm_activities/11111"
31        },
32        "note": {
33            "id": 22222,
34            "_href": "https://api.salesloft.com/v2/notes/22222"
35        },
36        "cadence": {
37            "id": 33333,
38            "_href": "https://api.salesloft.com/v2/cadences/33333"
39        },
40        "step": {
41            "id": 44444,
42            "_href": "https://api.salesloft.com/v2/steps/44444"
43        }
44    }
45}

Get custom field
Copy

Returns information about a custom field.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "custom_field_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "name": "Customer Segment",
5        "field_type": "dropdown",
6        "value_type": "string",
7        "created_at": "2023-05-15T10:30:00Z",
8        "updated_at": "2023-05-15T10:30:00Z"
9    }
10}

Get email
Copy

Gets an email record.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "email_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-15T10:35:00Z",
6        "recipient_email_address": "john.doe@example.com",
7        "status": "sent",
8        "bounced": false,
9        "send_after": "2023-05-15T10:29:00Z",
10        "sent_at": "2023-05-15T10:30:00Z",
11        "view_tracking": true,
12        "click_tracking": true,
13        "headers": {
14            "cc": "jane.smith@example.com",
15            "bcc": "manager@example.com"
16        },
17        "counts": {
18            "clicks": 2,
19            "views": 5,
20            "replies": 1,
21            "unique_devices": 3,
22            "unique_locations": 2,
23            "attachments": 1
24        },
25        "user": {
26            "id": 67890,
27            "_href": "https://api.salesloft.com/v2/users/67890"
28        },
29        "recipient": {
30            "id": 54321,
31            "_href": "https://api.salesloft.com/v2/people/54321"
32        },
33        "mailing": {
34            "id": 98765
35        },
36        "action": {
37            "id": 11111
38        },
39        "crm_activity": {
40            "id": 22222,
41            "_href": "https://api.salesloft.com/v2/crm_activities/22222"
42        },
43        "cadence": {
44            "id": 33333,
45            "_href": "https://api.salesloft.com/v2/cadences/33333"
46        },
47        "step": {
48            "id": 44444,
49            "_href": "https://api.salesloft.com/v2/cadence_steps/44444"
50        }
51    }
52}

Get import
Copy

Fetches an import, by ID only.

Sample Input

1{
2    "access_token": "your_oauth_access_token_here",
3    "import_id": "12345"
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-15T11:45:00Z",
6        "name": "Q2 Lead Import",
7        "current_people_count": 500,
8        "imported_people_count": 450
9    }
10}

Get note
Copy

Gets a note.

Sample Input

1{
2    "access_token": "your_oauth_access_token_here",
3    "note_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "content": "Discussed product features with the client. They showed interest in our premium package.",
5        "created_at": "2023-05-15T14:30:00Z",
6        "updated_at": "2023-05-15T14:30:00Z",
7        "user": {
8            "_href": "https://api.salesloft.com/v2/users/67890",
9            "id": 67890
10        },
11        "associated_with": {
12            "_href": "https://api.salesloft.com/v2/people/54321",
13            "id": 54321
14        },
15        "call": {
16            "_href": "https://api.salesloft.com/v2/calls/98765",
17            "id": 98765
18        }
19    }
20}

Get person
Copy

Get a person by ID.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "person_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-20T14:45:00Z",
6        "last_contacted_at": "2023-05-18T09:15:00Z",
7        "last_replied_at": "2023-05-18T11:30:00Z",
8        "first_name": "John",
9        "last_name": "Doe",
10        "display_name": "John Doe",
11        "email_address": "john.doe@example.com",
12        "full_email_address": "John Doe <john.doe@example.com>",
13        "secondary_email_address": "johnd@personal.com",
14        "personal_email_address": "johnd@gmail.com",
15        "phone": "+1 (555) 123-4567",
16        "phone_extension": "123",
17        "home_phone": "+1 (555) 987-6543",
18        "mobile_phone": "+1 (555) 234-5678",
19        "linkedin_url": "https://www.linkedin.com/in/johndoe",
20        "title": "Sales Manager",
21        "city": "New York",
22        "state": "NY",
23        "country": "United States",
24        "work_city": "New York",
25        "work_state": "NY",
26        "work_country": "United States",
27        "crm_url": "https://crm.example.com/contact/12345",
28        "crm_id": "CRM123456",
29        "crm_object_type": "Contact",
30        "owner_crm_id": "OWNER789",
31        "person_company_name": "Acme Corporation",
32        "person_company_website": "https://www.acmecorp.com",
33        "person_company_industry": "Technology",
34        "do_not_contact": false,
35        "bouncing": false,
36        "locale": "en-US",
37        "personal_website": "https://www.johndoe.com",
38        "twitter_handle": "@johndoe",
39        "last_contacted_type": "email",
40        "job_seniority": "Manager",
41        "custom_fields": {
42            "MyField": "Custom Value",
43            "Other": "Another Custom Value"
44        },
45        "tags": [
46            "VIP",
47            "High Priority",
48            "Tech Industry"
49        ],
50        "contact_restrictions": [
51            "email",
52            "phone"
53        ],
54        "counts": {
55            "emails_sent": 15,
56            "emails_viewed": 12,
57            "emails_clicked": 8,
58            "emails_replied_to": 5,
59            "emails_bounced": 0,
60            "calls": 3
61        },
62        "account": {
63            "id": 98765,
64            "_href": "https://api.salesloft.com/v2/accounts/98765"
65        },
66        "owner": {
67            "id": 54321,
68            "_href": "https://api.salesloft.com/v2/users/54321"
69        },
70        "last_contacted_by": {
71            "id": 67890,
72            "_href": "https://api.salesloft.com/v2/users/67890"
73        },
74        "import": {
75            "id": 11111,
76            "_href": "https://api.salesloft.com/v2/imports/11111"
77        },
78        "person_stage": {
79            "id": 22222,
80            "_href": "https://api.salesloft.com/v2/person_stages/22222"
81        }
82    }
83}

Get person stage
Copy

Gets a person stage by ID.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
3    "person_stage_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "name": "Qualified Lead",
5        "created_at": "2023-05-15T10:30:00Z",
6        "updated_at": "2023-05-16T14:45:00Z",
7        "order": 2
8    }
9}

Get step
Copy

Gets a step by ID.

Sample Input

1{
2    "access_token": "your_oauth_access_token_here",
3    "step_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-15T14:45:00Z",
6        "disabled": false,
7        "type": "email",
8        "display_name": "Follow-up Email",
9        "day": 3,
10        "step_number": 2,
11        "details": {
12            "_href": "https://api.salesloft.com/v2/steps/12345",
13            "id": 12345
14        },
15        "cadence": {
16            "_href": "https://api.salesloft.com/v2/cadences/67890",
17            "id": 67890
18        }
19    }
20}

Get task
Copy

Retrieves a task by ID.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "task_id": "12345"
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-05-15T10:30:00Z",
5        "updated_at": "2023-05-16T14:45:00Z",
6        "due_date": "2023-05-20",
7        "due_at": "2023-05-20T17:00:00Z",
8        "subject": "Follow up with potential client",
9        "current_state": "pending",
10        "task_type": "call",
11        "remind_at": "2023-05-19T09:00:00Z",
12        "completed_at": null,
13        "person": {
14            "_href": "/v2/people/67890",
15            "id": 67890
16        },
17        "user": {
18            "_href": "/v2/users/54321",
19            "id": 54321
20        },
21        "created_by_user": {
22            "_href": "/v2/users/54321",
23            "id": 54321
24        },
25        "completed_by": null
26    }
27}

Get user
Copy

Gets a user by ID.

Sample Input

1{
2    "access_token": "your_oauth_access_token_here",
3    "user_id": 12345
4}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "guid": "abc123def456ghi789",
5        "created_at": "2023-05-15T10:30:00Z",
6        "updated_at": "2023-05-20T14:45:00Z",
7        "name": "John Doe",
8        "first_name": "John",
9        "last_name": "Doe",
10        "job_role": "Sales Representative",
11        "active": true,
12        "time_zone": "America/New_York",
13        "slack_username": "johndoe",
14        "twitter_handle": "@johndoe",
15        "email": "john.doe@example.com",
16        "email_client_email_address": "john.doe@mail.example.com",
17        "sending_email_address": "john.doe@sales.example.com",
18        "from_address": "John Doe <john.doe@sales.example.com>",
19        "full_email_address": "John Doe <john.doe@sales.example.com>",
20        "bcc_email_address": "john.doe.bcc@example.com",
21        "email_signature": "Best regards,\nJohn Doe\nSales Representative",
22        "email_signature_type": "text",
23        "email_signature_click_tracking_disabled": false,
24        "team_admin": false,
25        "local_dial_enabled": true,
26        "click_to_call_enabled": true,
27        "email_client_configured": true,
28        "crm_connected": true,
29        "external_feature_flags": {
30            "ma_enabled": true,
31            "ma_live_feed": true,
32            "ma_person_page": true,
33            "ma_push_notifications": false,
34            "ma_websockets": true,
35            "ma_edit_person": true,
36            "hot_leads": true
37        },
38        "phone_client": {
39            "id": 67890
40        },
41        "phone_number_assignment": {
42            "id": 54321,
43            "_href": "https://api.salesloft.com/v2/phone_number_assignments/54321"
44        },
45        "group": {
46            "id": 98765,
47            "_href": "https://api.salesloft.com/v2/groups/98765"
48        },
49        "team": {
50            "id": 11111,
51            "_href": "https://api.salesloft.com/v2/teams/11111"
52        }
53    }
54}

List account stages
Copy

Returns a list of available account stages.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "ids": [
4        1,
5        2,
6        3
7    ],
8    "updated_at": {
9        "gt": "2023-01-01T00:00:00Z"
10    },
11    "sort_by": "updated_at",
12    "sort_direction": "DESC",
13    "include_paging_counts": true,
14    "per_page": 25,
15    "page": 1
16}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "1",
6                "2",
7                "3"
8            ],
9            "updated_at": {
10                "gt": "2023-01-01T00:00:00Z"
11            }
12        },
13        "paging": {
14            "per_page": 25,
15            "current_page": 1,
16            "next_page": 2,
17            "prev_page": null
18        },
19        "sorting": {
20            "sort_by": "updated_at",
21            "sort_direction": "DESC"
22        }
23    },
24    "data": [
25        {
26            "id": 1,
27            "name": "Prospecting",
28            "created_at": "2022-12-01T10:00:00Z",
29            "updated_at": "2023-03-15T14:30:00Z",
30            "order": 1
31        },
32        {
33            "id": 2,
34            "name": "Qualified",
35            "created_at": "2022-12-01T10:05:00Z",
36            "updated_at": "2023-03-10T09:45:00Z",
37            "order": 2
38        },
39        {
40            "id": 3,
41            "name": "Proposal",
42            "created_at": "2022-12-01T10:10:00Z",
43            "updated_at": "2023-02-28T16:20:00Z",
44            "order": 3
45        }
46    ]
47}

List account tiers
Copy

Returns a list of available account tiers.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "ids": [
4        1,
5        2,
6        3
7    ],
8    "name": [
9        "Basic",
10        "Professional"
11    ],
12    "sort_by": "order",
13    "sort_direction": "ASC",
14    "include_paging_counts": true,
15    "per_page": 10,
16    "page": 1
17}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "1",
6                "2",
7                "3"
8            ],
9            "name": [
10                "Basic",
11                "Professional"
12            ]
13        },
14        "paging": {
15            "per_page": 10,
16            "current_page": 1,
17            "next_page": 2,
18            "prev_page": null
19        },
20        "sorting": {
21            "sort_by": "order",
22            "sort_direction": "ASC"
23        }
24    },
25    "data": [
26        {
27            "id": 1,
28            "name": "Basic",
29            "order": 1,
30            "created_at": "2023-01-01T00:00:00Z",
31            "updated_at": "2023-01-01T00:00:00Z"
32        },
33        {
34            "id": 2,
35            "name": "Professional",
36            "order": 2,
37            "created_at": "2023-01-02T00:00:00Z",
38            "updated_at": "2023-01-02T00:00:00Z"
39        },
40        {
41            "id": 3,
42            "name": "Enterprise",
43            "order": 3,
44            "created_at": "2023-01-03T00:00:00Z",
45            "updated_at": "2023-01-03T00:00:00Z"
46        }
47    ]
48}

List accounts
Copy

Returns a list of accounts.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "per_page": 10,
4    "page": 1,
5    "sort_by": "updated_at",
6    "sort_direction": "DESC",
7    "include_paging_counts": true,
8    "tag": [
9        "VIP",
10        "Enterprise"
11    ],
12    "account_tier_id": [
13        1,
14        2
15    ],
16    "updated_at": {
17        "gte": "2023-01-01T00:00:00Z",
18        "lt": "2023-06-01T00:00:00Z"
19    }
20}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "tag": [
5                "VIP",
6                "Enterprise"
7            ],
8            "account_tier_id": [
9                "1",
10                "2"
11            ],
12            "updated_at": {
13                "gte": "2023-01-01T00:00:00Z",
14                "lt": "2023-06-01T00:00:00Z"
15            }
16        },
17        "paging": {
18            "per_page": 10,
19            "current_page": 1,
20            "next_page": 2,
21            "prev_page": null
22        },
23        "sorting": {
24            "sort_by": "updated_at",
25            "sort_direction": "DESC"
26        }
27    },
28    "data": [
29        {
30            "id": 12345,
31            "created_at": "2022-11-15T09:30:00Z",
32            "updated_at": "2023-05-20T14:45:00Z",
33            "archived_at": null,
34            "name": "Acme Corporation",
35            "domain": "acmecorp.com",
36            "conversational_name": "Acme",
37            "description": "Leading provider of innovative solutions",
38            "phone": "+1 (555) 123-4567",
39            "website": "https://www.acmecorp.com",
40            "linkedin_url": "https://www.linkedin.com/company/acmecorp",
41            "twitter_handle": "@AcmeCorp",
42            "street": "123 Main St",
43            "city": "San Francisco",
44            "state": "CA",
45            "postal_code": "94105",
46            "country": "United States",
47            "locale": "en-US",
48            "industry": "Technology",
49            "company_type": "Public",
50            "founded": "1985",
51            "revenue_range": "$100M-$500M",
52            "size": "1000-5000",
53            "crm_id": "0015A00000XYZ123",
54            "crm_url": "https://example.salesforce.com/0015A00000XYZ123",
55            "crm_object_type": "Account",
56            "owner_crm_id": "00580000001XYZ",
57            "last_contacted_at": "2023-05-18T10:30:00Z",
58            "last_contacted_type": "email",
59            "do_not_contact": false,
60            "custom_fields": {
61                "Custom Company Field": "VIP Client"
62            },
63            "tags": [
64                "VIP",
65                "Enterprise"
66            ],
67            "counts": {
68                "people": 25
69            },
70            "owner": {
71                "_href": "/v2/users/67890",
72                "id": 67890
73            },
74            "creator": {
75                "_href": "/v2/users/12345",
76                "id": 12345
77            },
78            "last_contacted_by": {
79                "_href": "/v2/users/23456",
80                "id": 23456
81            },
82            "last_contacted_person": {
83                "_href": "/v2/people/34567",
84                "id": 34567
85            },
86            "company_stage": {
87                "_href": "/v2/company_stages/2",
88                "id": 2
89            },
90            "account_tier": {
91                "id": 1,
92                "_href": "/v2/account_tiers/1"
93            }
94        }
95    ]
96}

List actions
Copy

Lists multiple action records. If the requesters is not an admin, this endpoint will only return actions belonging to the requester. If the requester is an admin, this endpoint will return actions for the entire team. Additionally, an admin may use the user GUID parameter to request actions that belong to specific users on the team.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "type": "email",
4    "due_on": {
5        "gte": "2023-05-01T00:00:00Z",
6        "lte": "2023-05-31T23:59:59Z"
7    },
8    "person_ids": [
9        123,
10        456
11    ],
12    "cadence_ids": [
13        789,
14        101
15    ],
16    "sort_by": "created_at",
17    "sort_direction": "ASC",
18    "include_paging_counts": true,
19    "per_page": 50,
20    "page": 1
21}

Sample Output

1{
2    "metadata": {
3        "filtering": {},
4        "paging": {
5            "per_page": 50,
6            "current_page": 1,
7            "next_page": 2,
8            "prev_page": null
9        },
10        "sorting": {
11            "sort_by": "created_at",
12            "sort_direction": "ASC"
13        }
14    },
15    "data": [
16        {
17            "id": 1001,
18            "due": true,
19            "created_at": "2023-05-02T10:30:00Z",
20            "updated_at": "2023-05-02T10:30:00Z",
21            "type": "email",
22            "status": "pending",
23            "due_on": "2023-05-05T14:00:00Z",
24            "action_details": {
25                "id": 5001,
26                "_href": "https://api.salesloft.com/v2/action_details/5001"
27            },
28            "user": {
29                "id": 201,
30                "_href": "https://api.salesloft.com/v2/users/201"
31            },
32            "person": {
33                "id": 123,
34                "_href": "https://api.salesloft.com/v2/people/123"
35            },
36            "cadence": {
37                "id": 789,
38                "_href": "https://api.salesloft.com/v2/cadences/789"
39            }
40        },
41        {
42            "id": 1002,
43            "due": false,
44            "created_at": "2023-05-03T09:15:00Z",
45            "updated_at": "2023-05-03T15:45:00Z",
46            "type": "email",
47            "status": "completed",
48            "due_on": "2023-05-04T11:00:00Z",
49            "action_details": {
50                "id": 5002,
51                "_href": "https://api.salesloft.com/v2/action_details/5002"
52            },
53            "user": {
54                "id": 202,
55                "_href": "https://api.salesloft.com/v2/users/202"
56            },
57            "person": {
58                "id": 456,
59                "_href": "https://api.salesloft.com/v2/people/456"
60            },
61            "cadence": {
62                "id": 101,
63                "_href": "https://api.salesloft.com/v2/cadences/101"
64            }
65        }
66    ]
67}

List bulk job results
Copy

Retrieves multiple job data records for a completed bulk job.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "bulk_jobs_id": 12345,
4    "bulk_jobs_status": [
5        "success",
6        "error"
7    ],
8    "cursor_id": 1000,
9    "per_page": 50
10}

Sample Output

1{
2    "data": [
3        {
4            "id": 1001,
5            "status": "success",
6            "record": {
7                "email_address": "john.doe@example.com",
8                "first_name": "John",
9                "upsert_key": "john.doe@example.com"
10            },
11            "resource": {
12                "person": {
13                    "id": 5001,
14                    "first_name": "John",
15                    "last_name": "Doe",
16                    "email_address": "john.doe@example.com",
17                    "title": "Sales Manager",
18                    "phone": "+1-555-123-4567",
19                    "mobile_phone": "+1-555-987-6543",
20                    "work_city": "New York",
21                    "work_state": "NY",
22                    "work_country": "USA",
23                    "created_at": "2023-05-01T10:00:00Z",
24                    "updated_at": "2023-05-15T14:30:00Z",
25                    "last_contacted_at": "2023-05-10T09:15:00Z",
26                    "do_not_contact": false,
27                    "linkedin_url": "https://www.linkedin.com/in/johndoe",
28                    "twitter_handle": "@johndoe",
29                    "tags": [
30                        "VIP",
31                        "Enterprise"
32                    ],
33                    "custom_fields": {
34                        "lead_source": "Website",
35                        "potential_value": 100000
36                    }
37                },
38                "upsert_type": "create"
39            }
40        },
41        {
42            "id": 1002,
43            "status": "error",
44            "error": "Invalid email address format",
45            "record": {
46                "email_address": "jane.smith@invalid",
47                "first_name": "Jane",
48                "upsert_key": "jane.smith@invalid"
49            }
50        }
51    ],
52    "metadata": {
53        "filtering": {},
54        "paging": {
55            "per_page": 50
56        }
57    }
58}

List cadence memberships
Copy

Returns a list of cadence memberships.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "per_page": 10,
4    "page": 1,
5    "person_id": 12345,
6    "cadence_id": 67890,
7    "updated_at": {
8        "gte": "2023-05-01T00:00:00Z",
9        "lt": "2023-06-01T00:00:00Z"
10    },
11    "currently_on_cadence": true,
12    "sort_by": "updated_at",
13    "sort_direction": "DESC",
14    "include_paging_counts": true
15}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "person_id": "12345",
5            "cadence_id": "67890"
6        },
7        "paging": {
8            "per_page": 10,
9            "current_page": 1,
10            "next_page": 2,
11            "prev_page": null
12        },
13        "sorting": {
14            "sort_by": "updated_at",
15            "sort_direction": "DESC"
16        }
17    },
18    "data": [
19        {
20            "id": 987654,
21            "added_at": "2023-05-15T14:30:00Z",
22            "created_at": "2023-05-15T14:30:00Z",
23            "updated_at": "2023-05-28T09:45:00Z",
24            "person_deleted": false,
25            "currently_on_cadence": true,
26            "current_state": "active",
27            "cadence": {
28                "_href": "/v2/cadences/67890",
29                "id": 67890
30            },
31            "person": {
32                "_href": "/v2/people/12345",
33                "id": 12345
34            },
35            "user": {
36                "_href": "/v2/users/54321",
37                "id": 54321
38            },
39            "latest_action": {
40                "id": 123456
41            },
42            "counts": {
43                "views": 5,
44                "clicks": 2,
45                "replies": 1,
46                "calls": 1,
47                "sent_emails": 3,
48                "bounces": 0
49            }
50        }
51    ]
52}

List cadences
Copy

Lists multiple cadence records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "cadence_ids": [
4        123,
5        "456",
6        789
7    ],
8    "updated_at": {
9        "gte": "2023-01-01T00:00:00Z",
10        "lt": "2023-06-01T00:00:00Z"
11    },
12    "team_cadence": true,
13    "shared": false,
14    "owned_by_guid_filter": [
15        "user_guid_1",
16        "user_guid_2"
17    ],
18    "people_addable": true,
19    "name": [
20        "Sales Outreach",
21        "Marketing Campaign"
22    ],
23    "sort_by": "updated_at",
24    "sort_direction": "DESC",
25    "include_paging_counts": true,
26    "per_page": 50,
27    "page": 1
28}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "123",
6                "456",
7                "789"
8            ]
9        },
10        "paging": {
11            "per_page": 50,
12            "current_page": 1,
13            "next_page": 2,
14            "prev_page": null
15        },
16        "sorting": {
17            "sort_by": "updated_at",
18            "sort_direction": "DESC"
19        }
20    },
21    "data": [
22        {
23            "id": 123,
24            "created_at": "2023-01-15T10:30:00Z",
25            "updated_at": "2023-05-20T14:45:00Z",
26            "archived_at": null,
27            "team_cadence": true,
28            "shared": false,
29            "remove_bounces_enabled": true,
30            "remove_replies_enabled": true,
31            "opt_out_link_included": true,
32            "name": "Sales Outreach",
33            "tags": [
34                "sales",
35                "outreach",
36                "q2"
37            ],
38            "creator": {
39                "id": 1001,
40                "_href": "https://api.salesloft.com/v2/users/1001"
41            },
42            "owner": {
43                "id": 1002,
44                "_href": "https://api.salesloft.com/v2/users/1002"
45            },
46            "bounced_stage": {
47                "id": 201,
48                "_href": "https://api.salesloft.com/v2/cadence_stages/201"
49            },
50            "replied_stage": {
51                "id": 202,
52                "_href": "https://api.salesloft.com/v2/cadence_stages/202"
53            },
54            "added_stage": {
55                "id": 203,
56                "_href": "https://api.salesloft.com/v2/cadence_stages/203"
57            },
58            "finished_stage": {
59                "id": 204,
60                "_href": "https://api.salesloft.com/v2/cadence_stages/204"
61            },
62            "counts": {
63                "cadence_people": 150,
64                "target_daily_people": 30
65            }
66        },
67        {
68            "id": 456,
69            "created_at": "2023-02-01T09:00:00Z",
70            "updated_at": "2023-05-15T11:30:00Z",
71            "archived_at": null,
72            "team_cadence": true,
73            "shared": false,
74            "remove_bounces_enabled": true,
75            "remove_replies_enabled": false,
76            "opt_out_link_included": true,
77            "name": "Marketing Campaign",
78            "tags": [
79                "marketing",
80                "campaign",
81                "q2"
82            ],
83            "creator": {
84                "id": 1003,
85                "_href": "https://api.salesloft.com/v2/users/1003"
86            },
87            "owner": {
88                "id": 1004,
89                "_href": "https://api.salesloft.com/v2/users/1004"
90            },
91            "bounced_stage": {
92                "id": 301,
93                "_href": "https://api.salesloft.com/v2/cadence_stages/301"
94            },
95            "replied_stage": {
96                "id": 302,
97                "_href": "https://api.salesloft.com/v2/cadence_stages/302"
98            },
99            "added_stage": {
100                "id": 303,
101                "_href": "https://api.salesloft.com/v2/cadence_stages/303"
102            },
103            "finished_stage": {
104                "id": 304,
105                "_href": "https://api.salesloft.com/v2/cadence_stages/304"
106            },
107            "counts": {
108                "cadence_people": 200,
109                "target_daily_people": 40
110            }
111        }
112    ]
113}

List call data records
Copy

Lists multiple call data records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "call_data_record_ids": [
4        123,
5        456,
6        "789"
7    ],
8    "has_call": true,
9    "updated_at": {
10        "gt": "2023-01-01T00:00:00Z",
11        "lt": "2023-12-31T23:59:59Z"
12    },
13    "created_at": {
14        "gte": "2023-06-01T00:00:00Z"
15    },
16    "user_guid_filter": [
17        "user_guid_1",
18        "user_guid_2"
19    ],
20    "sort_by": "created_at",
21    "sort_direction": "DESC",
22    "include_paging_counts": true,
23    "per_page": 50,
24    "page": 1
25}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "updated_at": {
5                "gt": "2023-01-01T00:00:00Z",
6                "lt": "2023-12-31T23:59:59Z"
7            },
8            "created_at": {
9                "gt": "2023-06-01T00:00:00Z"
10            }
11        },
12        "paging": {
13            "per_page": 50,
14            "current_page": 1,
15            "next_page": 2,
16            "prev_page": null
17        },
18        "sorting": {
19            "sort_by": "created_at",
20            "sort_direction": "DESC"
21        }
22    },
23    "data": [
24        {
25            "id": 123,
26            "created_at": "2023-07-15T14:30:00Z",
27            "updated_at": "2023-07-15T14:35:00Z",
28            "to": "+1234567890",
29            "from": "+9876543210",
30            "duration": 300,
31            "direction": "outbound",
32            "status": "completed",
33            "call_type": "voice",
34            "call_uuid": "abc123-def456-ghi789",
35            "recording": {
36                "url": "https://example.com/recordings/abc123.mp3",
37                "status": "completed",
38                "recording_status": "available"
39            },
40            "call": {
41                "_href": "/v2/calls/789",
42                "id": 789
43            },
44            "user": {
45                "_href": "/v2/users/456",
46                "id": 456
47            },
48            "called_person": {
49                "_href": "/v2/people/101",
50                "id": 101
51            }
52        }
53    ]
54}

List call dispositions
Copy

Lists multiple call disposition records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "sort_by": "updated_at",
4    "sort_direction": "DESC",
5    "include_paging_counts": true,
6    "per_page": 50,
7    "page": 1
8}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": []
5        },
6        "paging": {
7            "per_page": 50,
8            "current_page": 1,
9            "next_page": 2,
10            "prev_page": null,
11            "total_pages": 3,
12            "total_count": 125
13        },
14        "sorting": {
15            "sort_by": "updated_at",
16            "sort_direction": "DESC"
17        }
18    },
19    "data": [
20        {
21            "id": 1234,
22            "created_at": "2023-05-15T10:30:00Z",
23            "updated_at": "2023-05-20T14:45:00Z",
24            "name": "Interested"
25        },
26        {
27            "id": 5678,
28            "created_at": "2023-05-10T09:15:00Z",
29            "updated_at": "2023-05-19T16:30:00Z",
30            "name": "Not Interested"
31        },
32        {
33            "id": 9101,
34            "created_at": "2023-05-05T11:00:00Z",
35            "updated_at": "2023-05-18T13:20:00Z",
36            "name": "Call Back Later"
37        }
38    ]
39}

List call sentiments
Copy

Lists multiple call sentiment records.

Sample Input

1{
2    "access_token": "your_oauth_access_token_here",
3    "sort_by": "updated_at",
4    "sort_direction": "DESC",
5    "include_paging_counts": true,
6    "per_page": 50,
7    "page": 1
8}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": []
5        },
6        "paging": {
7            "per_page": 50,
8            "current_page": 1,
9            "next_page": 2,
10            "prev_page": null,
11            "total_pages": 3,
12            "total_count": 125
13        },
14        "sorting": {
15            "sort_by": "updated_at",
16            "sort_direction": "DESC"
17        }
18    },
19    "data": [
20        {
21            "id": 1001,
22            "created_at": "2023-05-15T14:30:00Z",
23            "updated_at": "2023-05-15T15:45:00Z",
24            "name": "Positive"
25        },
26        {
27            "id": 1002,
28            "created_at": "2023-05-15T13:00:00Z",
29            "updated_at": "2023-05-15T14:30:00Z",
30            "name": "Neutral"
31        },
32        {
33            "id": 1003,
34            "created_at": "2023-05-15T11:30:00Z",
35            "updated_at": "2023-05-15T13:15:00Z",
36            "name": "Negative"
37        }
38    ]
39}

List caller IDs
Copy

Returns a possible caller ID match for the number. Multiple entries may be returned if the phone number is present on more than one person in the system. Phone number should be in E.164 format.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
3    "phone_number": "+14155552671"
4}

Sample Output

1{
2    "data": [
3        {
4            "display_name": "John Smith",
5            "title": "Sales Manager",
6            "account_name": "Acme Corporation",
7            "person": {
8                "_href": "/v2/people/12345",
9                "id": 12345
10            }
11        },
12        {
13            "display_name": "Jane Doe",
14            "title": "Account Executive",
15            "account_name": "Acme Corporation",
16            "person": {
17                "_href": "/v2/people/67890",
18                "id": 67890
19            }
20        }
21    ]
22}

List calls
Copy

Lists multiple call records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "call_ids": [
4        123,
5        456,
6        789
7    ],
8    "updated_at": {
9        "gte": "2023-05-01T00:00:00Z",
10        "lt": "2023-05-31T23:59:59Z"
11    },
12    "person_ids": [
13        1001,
14        1002
15    ],
16    "sort_by": "created_at",
17    "sort_direction": "DESC",
18    "include_paging_counts": true,
19    "per_page": 50,
20    "page": 1
21}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "person_id": [
5                "1001",
6                "1002"
7            ]
8        },
9        "paging": {
10            "per_page": 50,
11            "current_page": 1,
12            "next_page": 2,
13            "prev_page": null,
14            "total_pages": 3,
15            "total_count": 125
16        },
17        "sorting": {
18            "sort_by": "created_at",
19            "sort_direction": "DESC"
20        }
21    },
22    "data": [
23        {
24            "id": 123,
25            "to": "+14155551234",
26            "duration": 180,
27            "sentiment": "positive",
28            "disposition": "completed",
29            "created_at": "2023-05-15T14:30:00Z",
30            "updated_at": "2023-05-15T14:33:00Z",
31            "recordings": [
32                {
33                    "url": "https://example.com/recordings/123.mp3",
34                    "recording_status": "completed",
35                    "status": "available"
36                }
37            ],
38            "user": {
39                "id": 5001,
40                "_href": "https://api.salesloft.com/v2/users/5001"
41            },
42            "action": {
43                "id": 7001
44            },
45            "called_person": {
46                "id": 1001,
47                "_href": "https://api.salesloft.com/v2/people/1001"
48            },
49            "crm_activity": {
50                "id": 9001,
51                "_href": "https://api.salesloft.com/v2/crm_activities/9001"
52            },
53            "note": {
54                "id": 11001,
55                "_href": "https://api.salesloft.com/v2/notes/11001"
56            },
57            "cadence": {
58                "id": 13001,
59                "_href": "https://api.salesloft.com/v2/cadences/13001"
60            },
61            "step": {
62                "id": 15001,
63                "_href": "https://api.salesloft.com/v2/steps/15001"
64            }
65        },
66        {
67            "id": 456,
68            "to": "+14155555678",
69            "duration": 240,
70            "sentiment": "neutral",
71            "disposition": "completed",
72            "created_at": "2023-05-14T10:15:00Z",
73            "updated_at": "2023-05-14T10:19:00Z",
74            "recordings": [
75                {
76                    "url": "https://example.com/recordings/456.mp3",
77                    "recording_status": "completed",
78                    "status": "available"
79                }
80            ],
81            "user": {
82                "id": 5002,
83                "_href": "https://api.salesloft.com/v2/users/5002"
84            },
85            "action": {
86                "id": 7002
87            },
88            "called_person": {
89                "id": 1002,
90                "_href": "https://api.salesloft.com/v2/people/1002"
91            },
92            "crm_activity": {
93                "id": 9002,
94                "_href": "https://api.salesloft.com/v2/crm_activities/9002"
95            },
96            "note": {
97                "id": 11002,
98                "_href": "https://api.salesloft.com/v2/notes/11002"
99            },
100            "cadence": {
101                "id": 13002,
102                "_href": "https://api.salesloft.com/v2/cadences/13002"
103            },
104            "step": {
105                "id": 15002,
106                "_href": "https://api.salesloft.com/v2/steps/15002"
107            }
108        }
109    ]
110}

List CRM activities
Copy

Lists multiple CRM activity records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "crm_activity_ids": [
4        1234,
5        5678,
6        9012
7    ],
8    "updated_at": {
9        "gte": "2023-05-01T00:00:00Z",
10        "lt": "2023-06-01T00:00:00Z"
11    },
12    "sort_by": "updated_at",
13    "sort_direction": "DESC",
14    "include_paging_counts": true,
15    "per_page": 50,
16    "page": 1
17}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "1234",
6                "5678",
7                "9012"
8            ]
9        },
10        "paging": {
11            "per_page": 50,
12            "current_page": 1,
13            "next_page": 2,
14            "prev_page": null
15        },
16        "sorting": {
17            "sort_by": "updated_at",
18            "sort_direction": "DESC"
19        }
20    },
21    "data": [
22        {
23            "id": 9012,
24            "created_at": "2023-05-28T14:30:00Z",
25            "updated_at": "2023-05-29T09:15:00Z",
26            "subject": "Follow-up call with client",
27            "description": "Discussed project timeline and next steps",
28            "crm_id": "CRM123456",
29            "activity_type": "Call",
30            "error": null,
31            "custom_crm_fields": {
32                "ecorp__Call_Type__c": "Follow-up"
33            },
34            "person": {
35                "id": 54321,
36                "_href": "https://api.salesloft.com/v2/people/54321"
37            },
38            "user": {
39                "id": 98765,
40                "_href": "https://api.salesloft.com/v2/users/98765"
41            }
42        },
43        {
44            "id": 5678,
45            "created_at": "2023-05-15T10:00:00Z",
46            "updated_at": "2023-05-15T11:30:00Z",
47            "subject": "Demo presentation",
48            "description": "Presented product features to potential client",
49            "crm_id": "CRM789012",
50            "activity_type": "Meeting",
51            "error": null,
52            "custom_crm_fields": {
53                "ecorp__Call_Type__c": "Demo"
54            },
55            "person": {
56                "id": 67890,
57                "_href": "https://api.salesloft.com/v2/people/67890"
58            },
59            "user": {
60                "id": 12345,
61                "_href": "https://api.salesloft.com/v2/users/12345"
62            }
63        }
64    ]
65}

List CRM activity fields
Copy

Lists multiple CRM activity field records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "source": "salesforce",
4    "sort_by": "updated_at",
5    "sort_direction": "DESC",
6    "include_paging_counts": true,
7    "per_page": 50,
8    "page": 1
9}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "source": "salesforce"
5        },
6        "paging": {
7            "per_page": 50,
8            "current_page": 1,
9            "next_page": 2,
10            "prev_page": null
11        },
12        "sorting": {
13            "sort_by": "updated_at",
14            "sort_direction": "DESC"
15        }
16    },
17    "data": [
18        {
19            "id": 12345,
20            "created_at": "2023-05-15T10:30:00Z",
21            "updated_at": "2023-05-16T14:45:00Z",
22            "title": "Call Outcome",
23            "salesforce_object_type": "Task",
24            "source": "salesforce",
25            "field": "Call_Outcome__c",
26            "field_type": "picklist",
27            "value": "Successful",
28            "picklist_values": {
29                "High": "Successful",
30                "Low": "No Answer"
31            }
32        },
33        {
34            "id": 12346,
35            "created_at": "2023-05-14T09:15:00Z",
36            "updated_at": "2023-05-15T11:20:00Z",
37            "title": "Meeting Notes",
38            "salesforce_object_type": "Event",
39            "source": "salesforce",
40            "field": "Meeting_Notes__c",
41            "field_type": "text",
42            "value": "Discussed product features and pricing",
43            "picklist_values": {}
44        }
45    ]
46}

List custom fields
Copy

Returns a list of custom fields.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "field_type": "person",
4    "updated_at": {
5        "gte": "2023-01-01T00:00:00Z"
6    },
7    "sort_by": "updated_at",
8    "sort_direction": "DESC",
9    "include_paging_counts": true,
10    "per_page": 50,
11    "page": 1
12}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": []
5        },
6        "sorting": {
7            "sort_by": "updated_at",
8            "sort_direction": "DESC"
9        },
10        "paging": {
11            "per_page": 50,
12            "current_page": 1,
13            "next_page": 2,
14            "prev_page": null
15        }
16    },
17    "data": [
18        {
19            "id": 12345,
20            "name": "Job Title",
21            "field_type": "person",
22            "value_type": "text",
23            "created_at": "2023-02-15T10:30:00Z",
24            "updated_at": "2023-05-20T14:45:00Z"
25        },
26        {
27            "id": 12346,
28            "name": "Industry",
29            "field_type": "person",
30            "value_type": "picklist",
31            "created_at": "2023-03-01T09:00:00Z",
32            "updated_at": "2023-05-18T11:20:00Z"
33        },
34        {
35            "id": 12347,
36            "name": "Last Contact Date",
37            "field_type": "person",
38            "value_type": "date",
39            "created_at": "2023-01-10T16:00:00Z",
40            "updated_at": "2023-05-15T08:30:00Z"
41        }
42    ]
43}

List emails
Copy

Lists multiple email records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "email_ids": [
4        123,
5        456,
6        789
7    ],
8    "updated_at": {
9        "gte": "2023-01-01T00:00:00Z",
10        "lt": "2023-06-01T00:00:00Z"
11    },
12    "bounced": false,
13    "crm_activity_ids": [
14        1001,
15        1002
16    ],
17    "action_ids": [
18        2001,
19        2002
20    ],
21    "sort_by": "updated_at",
22    "sort_direction": "DESC",
23    "include_paging_counts": true,
24    "per_page": 50,
25    "page": 1
26}

Sample Output

1{
2    "metadata": {
3        "filtering": {},
4        "paging": {
5            "per_page": 50,
6            "current_page": 1,
7            "next_page": 2,
8            "prev_page": null
9        },
10        "sorting": {
11            "sort_by": "updated_at",
12            "sort_direction": "DESC"
13        }
14    },
15    "data": [
16        {
17            "id": 123,
18            "created_at": "2023-05-15T10:30:00Z",
19            "updated_at": "2023-05-15T14:45:00Z",
20            "recipient_email_address": "john.doe@example.com",
21            "status": "sent",
22            "bounced": false,
23            "send_after": "2023-05-15T10:30:00Z",
24            "sent_at": "2023-05-15T10:31:00Z",
25            "view_tracking": true,
26            "click_tracking": true,
27            "headers": {
28                "cc": "jane.smith@example.com",
29                "bcc": "manager@example.com"
30            },
31            "counts": {
32                "clicks": 3,
33                "views": 5,
34                "replies": 1,
35                "unique_devices": 2,
36                "unique_locations": 1,
37                "attachments": 1
38            },
39            "user": {
40                "id": 1001,
41                "_href": "https://api.salesloft.com/v2/users/1001"
42            },
43            "recipient": {
44                "id": 2001,
45                "_href": "https://api.salesloft.com/v2/people/2001"
46            },
47            "mailing": {
48                "id": 3001
49            },
50            "action": {
51                "id": 2001
52            },
53            "crm_activity": {
54                "id": 1001,
55                "_href": "https://api.salesloft.com/v2/crm_activities/1001"
56            },
57            "cadence": {
58                "id": 4001,
59                "_href": "https://api.salesloft.com/v2/cadences/4001"
60            },
61            "step": {
62                "id": 5001,
63                "_href": "https://api.salesloft.com/v2/cadence_steps/5001"
64            }
65        }
66    ]
67}

List groups
Copy

Returns a list of available groups.

Sample Input

1{
2    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
3}

Sample Output

1{
2    "metadata": {
3        "filtering": {},
4        "sorting": {
5            "sort_by": "name",
6            "sort_direction": "asc"
7        }
8    },
9    "data": [
10        {
11            "id": 1,
12            "name": "Sales Team",
13            "parent_id": null
14        },
15        {
16            "id": 2,
17            "name": "Marketing Team",
18            "parent_id": null
19        },
20        {
21            "id": 3,
22            "name": "Inside Sales",
23            "parent_id": 1
24        },
25        {
26            "id": 4,
27            "name": "Field Sales",
28            "parent_id": 1
29        },
30        {
31            "id": 5,
32            "name": "Content Marketing",
33            "parent_id": 2
34        }
35    ]
36}

List imports
Copy

Lists multiple imports.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "import_ids": [
4        123,
5        456,
6        789
7    ],
8    "user_ids": [
9        1001,
10        1002
11    ],
12    "sort_by": "created_at",
13    "sort_direction": "DESC",
14    "include_paging_counts": true,
15    "per_page": 25,
16    "page": 1
17}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "123",
6                "456",
7                "789"
8            ]
9        },
10        "paging": {
11            "per_page": 25,
12            "current_page": 1,
13            "next_page": 2,
14            "prev_page": null,
15            "total_pages": 3,
16            "total_count": 75
17        },
18        "sorting": {
19            "sort_by": "created_at",
20            "sort_direction": "DESC"
21        }
22    },
23    "data": [
24        {
25            "id": 789,
26            "created_at": "2023-05-15T14:30:00Z",
27            "updated_at": "2023-05-15T14:35:00Z",
28            "name": "May 2023 Leads",
29            "current_people_count": 150,
30            "imported_people_count": 200
31        },
32        {
33            "id": 456,
34            "created_at": "2023-04-20T10:15:00Z",
35            "updated_at": "2023-04-20T10:20:00Z",
36            "name": "April 2023 Contacts",
37            "current_people_count": 100,
38            "imported_people_count": 120
39        },
40        {
41            "id": 123,
42            "created_at": "2023-03-05T09:00:00Z",
43            "updated_at": "2023-03-05T09:10:00Z",
44            "name": "March 2023 Prospects",
45            "current_people_count": 75,
46            "imported_people_count": 80
47        }
48    ]
49}

List notes
Copy

Lists multiple note records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "associated_with_type": "person",
4    "associated_with_id": "12345",
5    "note_ids": [
6        67890,
7        67891
8    ],
9    "updated_at": {
10        "gte": "2023-05-01T00:00:00Z",
11        "lt": "2023-06-01T00:00:00Z"
12    },
13    "sort_by": "updated_at",
14    "sort_direction": "DESC",
15    "include_paging_counts": true,
16    "per_page": 25,
17    "page": 1
18}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "67890",
6                "67891"
7            ]
8        },
9        "paging": {
10            "per_page": 25,
11            "current_page": 1,
12            "next_page": 2,
13            "prev_page": null,
14            "total_pages": 3,
15            "total_count": 75
16        },
17        "sorting": {
18            "sort_by": "updated_at",
19            "sort_direction": "DESC"
20        }
21    },
22    "data": [
23        {
24            "id": 67890,
25            "content": "Had a great call with the client. They're interested in our new product line.",
26            "created_at": "2023-05-15T14:30:00Z",
27            "updated_at": "2023-05-20T09:45:00Z",
28            "user": {
29                "_href": "/v2/users/789",
30                "id": 789
31            },
32            "associated_with": {
33                "_href": "/v2/people/12345",
34                "id": 12345
35            },
36            "call": {
37                "_href": "/v2/calls/54321",
38                "id": 54321
39            }
40        },
41        {
42            "id": 67891,
43            "content": "Follow-up meeting scheduled for next week to discuss implementation details.",
44            "created_at": "2023-05-18T11:00:00Z",
45            "updated_at": "2023-05-18T11:00:00Z",
46            "user": {
47                "_href": "/v2/users/790",
48                "id": 790
49            },
50            "associated_with": {
51                "_href": "/v2/people/12345",
52                "id": 12345
53            },
54            "call": null
55        }
56    ]
57}

List person stages
Copy

Lists multiple person stage records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "person_stage_ids": [
4        1,
5        2,
6        3
7    ],
8    "sort_by": "updated_at",
9    "sort_direction": "DESC",
10    "include_paging_counts": true,
11    "per_page": 25,
12    "page": 1
13}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "1",
6                "2",
7                "3"
8            ]
9        },
10        "paging": {
11            "per_page": 25,
12            "current_page": 1,
13            "next_page": 2,
14            "prev_page": null
15        },
16        "sorting": {
17            "sort_by": "updated_at",
18            "sort_direction": "DESC"
19        }
20    },
21    "data": [
22        {
23            "id": 1,
24            "name": "New Lead",
25            "created_at": "2023-05-01T10:00:00Z",
26            "updated_at": "2023-05-15T14:30:00Z",
27            "order": 1
28        },
29        {
30            "id": 2,
31            "name": "Qualified",
32            "created_at": "2023-05-02T11:00:00Z",
33            "updated_at": "2023-05-14T09:45:00Z",
34            "order": 2
35        },
36        {
37            "id": 3,
38            "name": "Opportunity",
39            "created_at": "2023-05-03T09:30:00Z",
40            "updated_at": "2023-05-13T16:20:00Z",
41            "order": 3
42        }
43    ]
44}

List steps
Copy

Lists multiple step records.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "step_ids": [
4        123,
5        456,
6        789
7    ],
8    "cadence_id": 1001,
9    "type": "email",
10    "has_due_actions": true,
11    "sort_by": "updated_at",
12    "sort_direction": "DESC",
13    "include_paging_counts": true,
14    "per_page": 25,
15    "page": 1
16}

Sample Output

1{
2    "metadata": {
3        "filtering": {},
4        "paging": {
5            "per_page": 25,
6            "current_page": 1,
7            "next_page": 2,
8            "prev_page": null
9        },
10        "sorting": {
11            "sort_by": "updated_at",
12            "sort_direction": "DESC"
13        }
14    },
15    "data": [
16        {
17            "id": 123,
18            "created_at": "2023-05-01T10:00:00Z",
19            "updated_at": "2023-05-02T15:30:00Z",
20            "disabled": false,
21            "type": "email",
22            "display_name": "Follow-up Email",
23            "day": 2,
24            "step_number": 1,
25            "details": {
26                "id": 456,
27                "_href": "https://api.salesloft.com/v2/steps/456"
28            },
29            "cadence": {
30                "id": 1001,
31                "_href": "https://api.salesloft.com/v2/cadences/1001"
32            }
33        },
34        {
35            "id": 456,
36            "created_at": "2023-05-01T11:00:00Z",
37            "updated_at": "2023-05-02T14:45:00Z",
38            "disabled": false,
39            "type": "email",
40            "display_name": "Second Follow-up",
41            "day": 4,
42            "step_number": 2,
43            "details": {
44                "id": 789,
45                "_href": "https://api.salesloft.com/v2/steps/789"
46            },
47            "cadence": {
48                "id": 1001,
49                "_href": "https://api.salesloft.com/v2/cadences/1001"
50            }
51        }
52    ]
53}

Fetches a list of the tags used for a team.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "search": "sales",
4    "ids": [
5        123,
6        456,
7        789
8    ],
9    "sort_by": "name",
10    "sort_direction": "ASC",
11    "include_paging_counts": true,
12    "per_page": 50,
13    "page": 1
14}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "ids": [
5                "123",
6                "456",
7                "789"
8            ]
9        },
10        "paging": {
11            "per_page": 50,
12            "current_page": 1,
13            "next_page": 2,
14            "prev_page": null
15        },
16        "sorting": {
17            "sort_by": "name",
18            "sort_direction": "ASC"
19        }
20    },
21    "data": [
22        {
23            "id": 123,
24            "name": "Cold Lead"
25        },
26        {
27            "id": 456,
28            "name": "Hot Lead"
29        },
30        {
31            "id": 789,
32            "name": "Sales Qualified"
33        }
34    ]
35}

List tasks
Copy

Retrieves multiple task records. The records can be filtered, paged, and sorted according to the respective parameters.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "user_ids": [
4        123,
5        456
6    ],
7    "person_ids": [
8        789,
9        1011
10    ],
11    "current_state": "scheduled",
12    "task_type": "call",
13    "time_interval_filter": "this_week",
14    "tasks_sort_by": "due_date",
15    "sort_direction": "ASC",
16    "per_page": 50,
17    "page": 1,
18    "include_paging_counts": true,
19    "idempotency_key": "unique_request_id_123"
20}

Sample Output

1{
2    "metadata": {
3        "filtering": {},
4        "paging": {
5            "per_page": 50,
6            "current_page": 1,
7            "next_page": "https://api.salesloft.com/v2/tasks?page=2",
8            "prev_page": null
9        },
10        "sorting": {
11            "sort_by": "due_date",
12            "sort_direction": "ASC"
13        },
14        "counts": {
15            "all": 150,
16            "overdue": 10,
17            "today": 25,
18            "tomorrow": 30,
19            "this_week": 75,
20            "next_week": 40
21        }
22    },
23    "data": [
24        {
25            "id": 12345,
26            "created_at": "2023-05-01T10:00:00Z",
27            "updated_at": "2023-05-01T10:30:00Z",
28            "due_date": "2023-05-03",
29            "due_at": "2023-05-03T14:00:00Z",
30            "subject": "Follow up on product demo",
31            "current_state": "scheduled",
32            "task_type": "call",
33            "remind_at": "2023-05-03T13:45:00Z",
34            "completed_at": null,
35            "person": {
36                "_href": "https://api.salesloft.com/v2/people/789",
37                "id": 789
38            },
39            "user": {
40                "_href": "https://api.salesloft.com/v2/users/123",
41                "id": 123
42            },
43            "created_by_user": {
44                "_href": "https://api.salesloft.com/v2/users/123",
45                "id": 123
46            },
47            "completed_by": null
48        },
49        {
50            "id": 12346,
51            "created_at": "2023-05-01T11:00:00Z",
52            "updated_at": "2023-05-01T11:15:00Z",
53            "due_date": "2023-05-04",
54            "due_at": "2023-05-04T10:00:00Z",
55            "subject": "Send proposal",
56            "current_state": "scheduled",
57            "task_type": "email",
58            "remind_at": "2023-05-04T09:45:00Z",
59            "completed_at": null,
60            "person": {
61                "_href": "https://api.salesloft.com/v2/people/1011",
62                "id": 1011
63            },
64            "user": {
65                "_href": "https://api.salesloft.com/v2/users/456",
66                "id": 456
67            },
68            "created_by_user": {
69                "_href": "https://api.salesloft.com/v2/users/456",
70                "id": 456
71            },
72            "completed_by": null
73        }
74    ]
75}

List users
Copy

Returns a list of users associated with your team.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "per_page": 10,
4    "page": 1,
5    "active": true,
6    "visible_only": true,
7    "sort_by": "name",
8    "sort_direction": "ASC",
9    "include_paging_counts": true,
10    "search": [
11        "John",
12        "sales"
13    ]
14}

Sample Output

1{
2    "metadata": {
3        "filtering": {
4            "visible_only": true
5        }
6    },
7    "data": [
8        {
9            "id": 12345,
10            "guid": "abc123def456",
11            "created_at": "2023-01-15T10:30:00Z",
12            "updated_at": "2023-05-20T14:45:00Z",
13            "name": "John Smith",
14            "first_name": "John",
15            "last_name": "Smith",
16            "job_role": "Sales Representative",
17            "active": true,
18            "time_zone": "America/New_York",
19            "slack_username": "johnsmith",
20            "twitter_handle": "@johnsmith",
21            "email": "john.smith@example.com",
22            "email_client_email_address": "john.smith@mail.example.com",
23            "sending_email_address": "john.smith@example.com",
24            "from_address": "John Smith <john.smith@example.com>",
25            "full_email_address": "John Smith <john.smith@example.com>",
26            "bcc_email_address": "john.smith.bcc@example.com",
27            "email_signature": "Best regards,\nJohn Smith\nSales Representative",
28            "email_signature_type": "text",
29            "email_signature_click_tracking_disabled": false,
30            "team_admin": false,
31            "local_dial_enabled": true,
32            "click_to_call_enabled": true,
33            "email_client_configured": true,
34            "crm_connected": true,
35            "external_feature_flags": {
36                "ma_enabled": true,
37                "ma_live_feed": true,
38                "ma_person_page": true,
39                "ma_push_notifications": false,
40                "ma_websockets": true,
41                "ma_edit_person": true,
42                "hot_leads": true
43            },
44            "phone_client": {
45                "id": 67890
46            },
47            "phone_number_assignment": {
48                "_href": "/api/v2/phone_number_assignments/54321",
49                "id": 54321
50            },
51            "group": 9876,
52            "team": {
53                "_href": "/api/v2/teams/5432",
54                "id": 5432
55            }
56        }
57    ]
58}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "method": "GET",
4    "url": {
5        "endpoint": "/v2/people"
6    },
7    "headers": [
8        {
9            "key": "Content-Type",
10            "value": "application/json"
11        }
12    ],
13    "query_parameters": [
14        {
15            "key": "per_page",
16            "value": "50"
17        },
18        {
19            "key": "page",
20            "value": "1"
21        }
22    ],
23    "body": {
24        "none": null
25    },
26    "include_raw_body": false,
27    "parse_response": "true"
28}

Sample Output

1{
2    "response": {
3        "status_code": 200,
4        "headers": {
5            "Content-Type": "application/json; charset=utf-8",
6            "X-RateLimit-Limit": "120",
7            "X-RateLimit-Remaining": "119"
8        },
9        "body": {
10            "data": [
11                {
12                    "id": 123456,
13                    "created_at": "2023-05-01T12:00:00Z",
14                    "updated_at": "2023-05-01T12:00:00Z",
15                    "first_name": "John",
16                    "last_name": "Doe",
17                    "email_address": "john.doe@example.com",
18                    "title": "Sales Representative",
19                    "phone": "+1 (555) 123-4567"
20                },
21                {
22                    "id": 789012,
23                    "created_at": "2023-05-02T10:30:00Z",
24                    "updated_at": "2023-05-02T10:30:00Z",
25                    "first_name": "Jane",
26                    "last_name": "Smith",
27                    "email_address": "jane.smith@example.com",
28                    "title": "Account Manager",
29                    "phone": "+1 (555) 987-6543"
30                }
31            ],
32            "metadata": {
33                "paging": {
34                    "current_page": 1,
35                    "per_page": 50,
36                    "total_pages": 5,
37                    "total_count": 230
38                }
39            }
40        }
41    }
42}

Update account
Copy

Updates an account.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "fields": {
4        "account_id": "12345",
5        "full_name": "Acme Corporation",
6        "domain": "acmecorp.com",
7        "conversational_name": "Acme",
8        "description": "Leading provider of innovative solutions",
9        "phone": "1234567890",
10        "website": "https://www.acmecorp.com",
11        "linkedin_url": "https://www.linkedin.com/company/acmecorp",
12        "twitter_handle": "@acmecorp",
13        "street": "123 Main St",
14        "city": "San Francisco",
15        "state": "CA",
16        "postal_code": "94105",
17        "country": "USA",
18        "locale": "en_US",
19        "industry": "Technology",
20        "company_type": "Public",
21        "founded": "1990",
22        "revenue_range": "$100M-$500M",
23        "size": "1000-5000",
24        "do_not_contact": false,
25        "custom_fields": [
26            {
27                "key": "Funding Amount",
28                "value": "$50M"
29            },
30            {
31                "key": "Custom Company Field",
32                "value": "Value"
33            }
34        ],
35        "tags": [
36            "enterprise",
37            "tech"
38        ],
39        "owner_id": 67890,
40        "company_stage_id": 2,
41        "account_tier_id": 3,
42        "archived": false
43    }
44}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-01-15T10:30:00Z",
5        "updated_at": "2023-06-01T14:45:00Z",
6        "archived_at": null,
7        "name": "Acme Corporation",
8        "domain": "acmecorp.com",
9        "conversational_name": "Acme",
10        "description": "Leading provider of innovative solutions",
11        "phone": "1234567890",
12        "website": "https://www.acmecorp.com",
13        "linkedin_url": "https://www.linkedin.com/company/acmecorp",
14        "twitter_handle": "@acmecorp",
15        "street": "123 Main St",
16        "city": "San Francisco",
17        "state": "CA",
18        "postal_code": "94105",
19        "country": "USA",
20        "locale": "en_US",
21        "industry": "Technology",
22        "company_type": "Public",
23        "founded": "1990",
24        "revenue_range": "$100M-$500M",
25        "size": "1000-5000",
26        "crm_id": "CRM123456",
27        "crm_url": "https://crm.example.com/account/CRM123456",
28        "crm_object_type": "Account",
29        "owner_crm_id": "OWNER987654",
30        "last_contacted_at": "2023-05-30T09:15:00Z",
31        "last_contacted_type": "email",
32        "do_not_contact": false,
33        "custom_fields": {
34            "Funding Amount": "$50M",
35            "Custom Company Field": "Value"
36        },
37        "tags": [
38            "enterprise",
39            "tech"
40        ],
41        "counts": {
42            "people": 25
43        },
44        "owner": {
45            "_href": "/v2/users/67890",
46            "id": 67890
47        },
48        "creator": {
49            "_href": "/v2/users/54321",
50            "id": 54321
51        },
52        "last_contacted_by": {
53            "_href": "/v2/users/98765",
54            "id": 98765
55        },
56        "last_contacted_person": {
57            "_href": "/v2/people/11223",
58            "id": 11223
59        },
60        "company_stage": {
61            "_href": "/v2/company_stages/2",
62            "id": 2
63        },
64        "account_tier": {
65            "id": 3,
66            "_href": "/v2/account_tiers/3"
67        }
68    }
69}

Update bulk job
Copy

Updates a bulk job.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "bulk_jobs_id": 12345,
4    "update_bulk_job_name": "Updated Sales Contacts Import",
5    "ready_to_execute": true
6}

Sample Output

1{
2    "data": {
3        "created_at": "2023-05-15T10:30:00Z",
4        "errors": 0,
5        "id": 12345,
6        "name": "Updated Sales Contacts Import",
7        "processed": 0,
8        "ready_to_execute": true,
9        "scopes": [
10            "contact.create",
11            "contact.update"
12        ],
13        "state": "pending",
14        "total": 1000,
15        "type": "import"
16    }
17}

Update custom field
Copy

Update a custom field. (This invalidates the old custom field ID).

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "custom_field_id": "12345",
4    "name": "Customer Lifetime Value",
5    "field_type": "person"
6}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "name": "Customer Lifetime Value",
5        "field_type": "person",
6        "value_type": "number",
7        "created_at": "2023-05-15T10:30:00Z",
8        "updated_at": "2023-05-20T14:45:00Z"
9    }
10}

Update import
Copy

Updates an import.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "import_id": "12345",
4    "user_id": 67890,
5    "name": "Updated Q2 2023 Lead Import"
6}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-04-15T10:30:00Z",
5        "updated_at": "2023-06-20T14:45:30Z",
6        "name": "Updated Q2 2023 Lead Import",
7        "current_people_count": 5000,
8        "imported_people_count": 4800
9    }
10}

Update note
Copy

Updates a note.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "note_id": 12345,
4    "content": "Updated meeting notes: Discussed new product features and pricing strategy. Follow up next week.",
5    "call_id": 67890
6}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "content": "Updated meeting notes: Discussed new product features and pricing strategy. Follow up next week.",
5        "created_at": "2023-05-15T10:30:00Z",
6        "updated_at": "2023-05-15T14:45:00Z",
7        "user": {
8            "_href": "https://api.salesloft.com/v2/users/98765",
9            "id": 98765
10        },
11        "associated_with": {
12            "_href": "https://api.salesloft.com/v2/people/54321",
13            "id": 54321
14        },
15        "call": {
16            "_href": "https://api.salesloft.com/v2/calls/67890",
17            "id": 67890
18        }
19    }
20}

Update person
Copy

Updates a person.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "fields": {
4        "person_id": 12345,
5        "email_address": "john.doe@example.com",
6        "first_name": "John",
7        "last_name": "Doe",
8        "phone": "1234567890",
9        "title": "Sales Manager",
10        "city": "New York",
11        "state": "NY",
12        "country": "USA",
13        "job_seniority": "manager",
14        "do_not_contact": false,
15        "tags": [
16            "VIP",
17            "Follow-up"
18        ],
19        "contact_restrictions": [
20            "call"
21        ],
22        "custom_fields": [
23            {
24                "key": "Lead Source",
25                "value": "Website"
26            },
27            {
28                "key": "Last Meeting",
29                "value": "2023-05-15"
30            }
31        ],
32        "account_id": 67890,
33        "owner_id": 54321
34    }
35}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "created_at": "2023-01-01T12:00:00Z",
5        "updated_at": "2023-05-20T15:30:00Z",
6        "last_contacted_at": "2023-05-18T10:15:00Z",
7        "last_replied_at": "2023-05-18T11:30:00Z",
8        "first_name": "John",
9        "last_name": "Doe",
10        "display_name": "John Doe",
11        "email_address": "john.doe@example.com",
12        "full_email_address": "John Doe <john.doe@example.com>",
13        "phone": "1234567890",
14        "title": "Sales Manager",
15        "city": "New York",
16        "state": "NY",
17        "country": "USA",
18        "person_company_name": "Acme Corp",
19        "do_not_contact": false,
20        "bouncing": false,
21        "job_seniority": "manager",
22        "custom_fields": {
23            "Lead Source": "Website",
24            "Last Meeting": "2023-05-15"
25        },
26        "tags": [
27            "VIP",
28            "Follow-up"
29        ],
30        "contact_restrictions": [
31            "call"
32        ],
33        "counts": {
34            "emails_sent": 10,
35            "emails_viewed": 8,
36            "emails_clicked": 5,
37            "emails_replied_to": 3,
38            "emails_bounced": 0,
39            "calls": 2
40        },
41        "account": {
42            "id": 67890,
43            "_href": "https://api.salesloft.com/v2/accounts/67890"
44        },
45        "owner": {
46            "id": 54321,
47            "_href": "https://api.salesloft.com/v2/users/54321"
48        }
49    }
50}

Update person stage
Copy

Updates a person stage.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "person_stage_id": 12345,
4    "person_stage_name": "Qualified Lead"
5}

Sample Output

1{
2    "data": {
3        "id": 12345,
4        "name": "Qualified Lead",
5        "created_at": "2023-05-15T10:30:00Z",
6        "updated_at": "2023-05-20T14:45:00Z",
7        "order": 2
8    }
9}

Upsert person
Copy

Upserts a person record.

Sample Input

1{
2    "access_token": "your_access_token_here",
3    "fields": {
4        "upsert_key": "email_address",
5        "email_address": "john.doe@example.com",
6        "first_name": "John",
7        "last_name": "Doe",
8        "phone": "1234567890",
9        "title": "Sales Manager",
10        "city": "New York",
11        "state": "NY",
12        "country": "USA",
13        "job_seniority": "manager",
14        "do_not_contact": false,
15        "tags": [
16            "VIP",
17            "High Priority"
18        ],
19        "contact_restrictions": [
20            "call"
21        ],
22        "custom_fields": [
23            {
24                "key": "Lead Source",
25                "value": "Website"
26            },
27            {
28                "key": "Last Meeting Date",
29                "value": "2023-05-15"
30            }
31        ],
32        "account_id": 12345,
33        "owner_id": 67890
34    }
35}

Sample Output

1{
2    "data": {
3        "upsert_type": "created",
4        "person": {
5            "id": 987654,
6            "created_at": "2023-05-20T10:30:00Z",
7            "updated_at": "2023-05-20T10:30:00Z",
8            "last_contacted_at": null,
9            "last_replied_at": null,
10            "first_name": "John",
11            "last_name": "Doe",
12            "display_name": "John Doe",
13            "email_address": "john.doe@example.com",
14            "full_email_address": "John Doe <john.doe@example.com>",
15            "secondary_email_address": null,
16            "personal_email_address": null,
17            "phone": "1234567890",
18            "phone_extension": null,
19            "home_phone": null,
20            "mobile_phone": null,
21            "linkedin_url": null,
22            "title": "Sales Manager",
23            "city": "New York",
24            "state": "NY",
25            "country": "USA",
26            "work_city": null,
27            "work_state": null,
28            "work_country": null,
29            "crm_url": null,
30            "crm_id": null,
31            "crm_object_type": null,
32            "owner_crm_id": null,
33            "person_company_name": null,
34            "person_company_website": null,
35            "person_company_industry": null,
36            "do_not_contact": "false",
37            "bouncing": false,
38            "locale": null,
39            "eu_resident": false,
40            "personal_website": null,
41            "twitter_handle": null,
42            "last_contacted_type": null,
43            "job_seniority": "manager",
44            "custom_fields": {
45                "Lead Source": "Website",
46                "Last Meeting Date": "2023-05-15"
47            },
48            "tags": [
49                "VIP",
50                "High Priority"
51            ],
52            "contact_restrictions": [
53                "call"
54            ],
55            "counts": {
56                "emails_sent": 0,
57                "emails_viewed": 0,
58                "emails_clicked": 0,
59                "emails_replied_to": 0,
60                "emails_bounced": 0,
61                "calls": 0
62            },
63            "account": {
64                "_href": "/v2/accounts/12345",
65                "id": 12345
66            },
67            "owner": {
68                "_href": "/v2/users/67890",
69                "id": 67890
70            },
71            "last_contacted_by": null,
72            "import": null,
73            "person_stage": null,
74            "most_recent_cadence": null,
75            "last_completed_step_cadence": null,
76            "last_completed_step": null
77        }
78    }
79}