Organization lists
Create, manage, and access organization lists in your Sumble account via the API.
Organization lists let you group target accounts for tracking, enrichment, or export. You can create lists, add organizations to them, and retrieve their contents programmatically.
See Account lists for how lists are created and managed in the web application.
Credit cost
List organization lists
1 credit per list returned
Get organization list details
1 credit per organization returned
Create organization list
No credit cost
Rename organization list
No credit cost
Add organizations to a list
No credit cost
Set a list's Signals inclusion setting
No credit cost
Set a list deleted or restored
No credit cost
List organization lists
Returns your saved organization lists with each list's ID, web app URL, organization count, type, read-only/deletable flags, deleted status, and Signals inclusion setting.
falseSuccessful Response
Validation Error
GET /v9/organization-lists HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "0195f8d2-1f67-7f52-b1d1-4d63c1e6e7b8",
"credits_used": 3,
"credits_remaining": 997,
"organization_lists": [
{
"id": 41,
"name": "My Accounts",
"url": "https://sumble.com/account-lists/41",
"organizations_count": 25,
"type": "user",
"read_only": false,
"deletable": false,
"deleted": false,
"include_in_signals": true
},
{
"id": 42,
"name": "Enterprise Targets",
"url": "https://sumble.com/account-lists/42",
"organizations_count": 150,
"type": "group",
"read_only": true,
"deletable": false,
"deleted": false,
"include_in_signals": true
},
{
"id": 43,
"name": "SMB Pipeline",
"url": "https://sumble.com/account-lists/43",
"organizations_count": 75,
"type": "user",
"read_only": false,
"deletable": true,
"deleted": false,
"include_in_signals": false
}
]
}Get organization list details
Returns one organization list and the organizations currently in it. Each organization includes its Sumble profile URL as sumble_url; url is the organization's own website. For callers with CRM status access, organizations also include account_status (customer, prospect, or not_in_crm) and crm_url when an unambiguous CRM account record can be linked. A missing CRM record returns account_status: "not_in_crm"; null means CRM status is unavailable to the caller.
Pass a .csv file_name to receive file metadata and an authenticated Sumble download URL instead of organization rows. The metadata includes the file kind, row count, columns, and byte size. Opening the download URL requires the file owner's Sumble web session.
Use the list_id returned from the list endpoint.
falseSuccessful Response
Validation Error
GET /v9/organization-lists/{list_id} HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "0195f8d2-1f67-7f52-b1d1-4d63c1e6e7b8",
"credits_used": 1,
"credits_remaining": 997,
"list_info": {
"id": 42,
"name": "Enterprise Targets",
"url": "https://sumble.com/account-lists/42",
"organizations_count": 1,
"type": "group",
"read_only": true,
"deletable": false,
"deleted": false,
"include_in_signals": true
},
"organizations": [
{
"id": 1726684,
"name": "Sumble",
"slug": "sumble",
"sumble_url": "https://sumble.com/orgs/sumble",
"url": "https://sumble.com",
"employee_count": 12,
"account_status": "customer",
"crm_url": "https://example.my.salesforce.com/lightning/r/Account/001XX/view"
}
]
}Create organization list
Create a new, empty organization list. Use the returned id to add organizations to it.
Successful Response
Validation Error
POST /v9/organization-lists HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"name": "Enterprise Targets"
}{
"id": 42,
"name": "Enterprise Targets"
}Rename organization list
Change an existing list's name. The list keeps its id, URL, and organizations — only the name changes, so there is no need to recreate a list to rename it.
List names are not unique, so a rename never conflicts with another of your lists. Group lists (read-only territories synced from your CRM) cannot be renamed, and return 403.
Rename one of your organization lists.
Only the list's name changes: its id, url, and organizations are untouched. Names are not unique, so renaming never conflicts with another list.
Group lists (read-only territories synced from your CRM) cannot be renamed.
Successful Response
Validation Error
POST /v9/organization-lists/{list_id}/name HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29
{
"name": "Enterprise Targets"
}{
"id": 42,
"name": "Enterprise Targets",
"url": "https://sumble.com/account-lists/42"
}Add organizations to a list
Add organizations to an existing list by their Sumble IDs or slugs. Organizations that are already in the list are silently skipped. Invalid IDs or slugs are returned in the failure arrays.
If you have company names or domains but not Sumble IDs or slugs, use the organizations endpoint first to resolve them.
[][]Successful Response
Validation Error
POST /v9/organization-lists/{list_id}/organizations HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84
{
"organization_ids": [
1,
99999999
],
"organization_slugs": [
"sumble",
"non-existing-org"
]
}{
"added": [
1,
1726684
],
"failed_ids": [
99999999
],
"failed_slugs": [
"non-existing-org"
]
}Set a list's Signals inclusion setting
Include or exclude an organization list's accounts from future Signals delivery. Lists are included by default. This mirrors the per-list Signals toggle in the web app.
Include or exclude an organization list's accounts from your signals feed.
Pass include_in_signals=false to exclude this list's accounts from your signals, or true to include them again. Lists are included by default. This mirrors the per-list signals toggle in the dashboard.
Successful Response
Validation Error
POST /v9/organization-lists/{list_id}/signals HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"include_in_signals": false
}{
"id": 42,
"include_in_signals": false
}Set a list deleted or restored
Soft-delete an organization list or restore a previously deleted one. Pass { "deleted": true } to delete the list, or { "deleted": false } to restore it. Deleting a list preserves its organizations; deleting individual organizations from a list is a separate operation.
Deleted lists are hidden by default. To retrieve them with their preserved organization counts and details, pass include_deleted=true on the list and detail endpoints above.
Soft-delete or restore an organization list.
Soft-deletion is reversible: pass deleted=false to restore a list. Deleting or restoring a list does not delete or restore individual organizations in the list. Pass include_deleted=true to the list/detail endpoints to see deleted lists.
Successful Response
Validation Error
POST /v9/organization-lists/{list_id}/deleted HTTP/1.1
Host: api.sumble.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"deleted": true
}{
"id": 42,
"deleted": true
}Last updated