Skip to Content
Campaigns

Lead lists

The import lists of a campaign.

Campaigns3 endpointsKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Path parameters

The endpoints whose path names one of these take it as described here. An endpoint's own table lists a path parameter only when it describes it differently.

NameInTypeRequiredDescription
listIdpathinteger (int64)requiredId of the list.

Headers

The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.

NameInTypeRequiredDescription
Ken-Versionheaderstring, one of: 2026-11-02, 1.1optionalThe API version, a date in YYYY-MM-DD form. 1.1 is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and 404 where the path exists only in this version. A date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.
X-Ken-Workspace-Idheaderinteger (int64)optionalThe id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers 400 workspace_required. A workspace you are not a member of answers 404 not_found.

List a campaign's lists

GET/v1/campaigns/{campaignId}/listslists.list
Permission
Campaigns view
Rate limit
12,000 requests a minute per API key

Try it on developer.ken.so

Lists the import lists of one campaign, newest first. Page with limit and cursor.

sort=createdAt lists by each list's createdAt, oldest first, and sort=-createdAt newest first, with ties by id. Keep the same sort while you page: a cursor from another order is refused. createdAfter and createdBefore keep the lists created in that range.

Errors:

  • 400 validation_failed: limit is not from 1 to 200, sort is not createdAt or -createdAt, cursor is invalid or comes from another sort, or createdBefore is not later than createdAfter.
  • 404 not_found: the campaign does not exist in this workspace.

Requires Campaigns view.

Parameters

NameInTypeRequiredDescription
campaignIdpathinteger (int64)requiredId of the campaign whose lists to read.
createdAfterquerystring (date-time)optionalOnly lists created at or after this time, in UTC.
createdBeforequerystring (date-time)optionalOnly lists created before this time, in UTC. Must be later than createdAfter.
sortquerystringoptionalThe order, by each list's createdAt: createdAt lists oldest first and -createdAt newest first. Omitted keeps the default order, newest first. Keep the same sort while you page.
limitqueryinteger (int32)optionalPage size, from 1 to 200.
cursorquerystringoptionalThe nextCursor from the previous page. Omit it for the first page.
Request
curl -X GET "https://api.ken.so/v1/campaigns/812/lists?limit=50" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"

Response 200

data is a list of CampaignList. Each item has these fields. The response also carries pagination.

Show the 9 response fields and an example

The fields and an example are also on this endpoint's Markdown page.

Get a list

GET/v1/lists/{listId}lists.get
Permission
Campaigns view
Rate limit
12,000 requests a minute per API key

Try it on developer.ken.so

Returns one import list with its source, contact count and import state.

Errors:

  • 404 not_found: no list with this id exists in this workspace.

Requires Campaigns view.

Request
curl -X GET "https://api.ken.so/v1/lists/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"

Response 200

data is a CampaignList.

Show the 9 response fields and an example

The fields and an example are also on this endpoint's Markdown page.

Delete a list

DELETE/v1/lists/{listId}lists.delete
Permission
Campaigns edit
Rate limit
4,800 requests a minute per API key

Try it on developer.ken.so

Deletes an empty import list and returns it as it was before the delete. Remove the list's contacts first: Kenso refuses to delete a list that any contact still points to, deleted contacts included.

Errors:

  • 400 validation_failed: the list still has contacts, or its CSV or Kenso search import is still running.
  • 404 not_found: no list with this id exists in this workspace.

Requires Campaigns edit.

Request
curl -X DELETE "https://api.ken.so/v1/lists/812" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"

Response 200

data is a CampaignList.

Show the 9 response fields and an example

The fields and an example are also on this endpoint's Markdown page.


On this page