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

Operation	Cost
List organization lists	1 credit per list returned
Get organization list details	1 credit per organization returned
Create 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.

List organization lists

get

Authorizations

api_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

include_deletedbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

idstring · uuidRequired

credits_usedintegerRequired

credits_remainingintegerRequired

422

Validation Error

application/json

get/v9/organization-lists

HTTPcURLJavaScriptPython

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.

Use the list_id returned from the list endpoint.

Get organization list details

get

Authorizations

api_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

list_idintegerRequired

Query parameters

include_deletedbooleanOptionalDefault: false

Responses

200

Successful Response

application/json

idstring · uuidRequired

credits_usedintegerRequired

credits_remainingintegerRequired

422

Validation Error

application/json

get/v9/organization-lists/{list_id}

HTTPcURLJavaScriptPython

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.

Create an organization list

post

Authorizations

api_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

namestringRequired

Responses

200

Successful Response

application/json

idintegerRequired

namestringRequired

urlstring · uri · min: 1 · max: 2083Required

422

Validation Error

application/json

post/v9/organization-lists

HTTPcURLJavaScriptPython

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"
}

---

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.

Add organizations to a list

post

Authorizations

api_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

list_idintegerRequired

Body

application/json

organization_idsinteger[]OptionalDefault: []

organization_slugsstring[]OptionalDefault: []

Responses

200

Successful Response

application/json

addedinteger[]Required

failed_idsinteger[]Required

failed_slugsstring[]Required

422

Validation Error

application/json

post/v9/organization-lists/{list_id}/organizations

HTTPcURLJavaScriptPython

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.

Set a list's signals inclusion setting

post

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.

Authorizations

api_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

list_idintegerRequired

Body

application/json

include_in_signalsbooleanRequired

Responses

200

Successful Response

application/json

idintegerRequired

include_in_signalsbooleanRequired

422

Validation Error

application/json

post/v9/organization-lists/{list_id}/signals

HTTPcURLJavaScriptPython

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.

Set an organization list's deleted status

post

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.

Authorizations

api_token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

list_idintegerRequired

Body

application/json

deletedbooleanRequired

Responses

200

Successful Response

application/json

idintegerRequired

deletedbooleanRequired

422

Validation Error

application/json

post/v9/organization-lists/{list_id}/deleted

HTTPcURLJavaScriptPython

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
}