Contact lists

Create, manage, and access contact lists (people lists) in your Sumble account via the API.

Contact lists let you save and organize people for outreach, tracking, or export. You can create lists, add people to them by their Sumble person IDs, and retrieve the full list with enriched contact details.

See Contact lists for how lists are created and managed in the web application.

Credit cost

Operation
Cost

List contact lists

1 credit per list returned

Get contact list details

1 credit per person returned

Create contact list

No credit cost

Add people to a list

No credit cost

List contact lists

Returns your saved contact lists with each list's ID, name, and people count.

List contact lists

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
require_mcpbooleanOptionalDefault: false
Responses
chevron-right
200

Successful Response

application/json
idstring · uuidRequired
credits_usedintegerRequired
credits_remainingintegerRequired
get
/v5/contact-lists

Get contact list details

Returns one contact list and the people currently in it, with enriched profile data including name, job title, job function, LinkedIn URL, organization, and contact information (emails and phone when available).

Use the list_id returned from the list endpoint.

Get contact list details

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
list_idintegerRequired
Query parameters
require_mcpbooleanOptionalDefault: false
Responses
chevron-right
200

Successful Response

application/json
idstring · uuidRequired
credits_usedintegerRequired
credits_remainingintegerRequired
get
/v5/contact-lists/{list_id}

Create contact list

Create a new, empty contact list. Use the returned id to add people to it.

Create a contact list

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
require_mcpbooleanOptionalDefault: false
Body
namestringRequired
Responses
chevron-right
200

Successful Response

application/json
idintegerRequired
namestringRequired
urlstring · uri · min: 1 · max: 2083Required
post
/v5/contact-lists

Add people to a list

Add people to an existing contact list by their Sumble person IDs. People already on the list are silently skipped. The response tells you how many were added and how many were already present.

You can obtain person IDs from the People find or People find-related-people endpoints.

Add people to a contact list

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
list_idintegerRequired
Query parameters
require_mcpbooleanOptionalDefault: false
Body
people_idsinteger[]Required
Responses
chevron-right
200

Successful Response

application/json
urlstring · uri · min: 1 · max: 2083Required
addedintegerRequired
already_on_listintegerRequired
post
/v5/contact-lists/{list_id}/people

Last updated