Campaign images
The current images of a campaign's leads, and one image with a fresh preview link.
Headers
The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Ken-Version | header | string, one of: 2026-11-02, 1.1 | optional | The 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-Id | header | integer (int64) | optional | The 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 contacts' images in a campaign
/v1/campaigns/{campaignId}/imagescampaign-images.list- Permission
- Campaigns view
- Rate limit
- 12,000 requests a minute per API key
campaign_images feature on your workspace. Until it is on, calls answer 404.Returns the current images of the contacts you name: one for each image variable that makes an image per contact, and the contact's own custom_image. Use it to show images next to a page of contacts.
contactIds is required: from 1 to 200 contact ids, separated by commas. variableKey keeps the images of one image variable, or custom_image for the contacts' own images. A key that matches no image variable of the campaign returns an empty list. The list has one item per contact and key that has an image, in any status, ordered by contactId and then variableKey. A contact with no image, or not in the campaign, gets no item. Images of a deleted image variable are left out. A ready image has a previewUrl that works until previewExpiresAt, 1 hour after the call. The whole result comes in one page, so hasMore is always false.
Errors:
400 validation_failed:contactIdsis missing, names more than 200 ids, or holds a value that is not a positive whole number.404 not_found: the campaign does not exist in this workspace.
Requires Campaigns view.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
campaignId | path | integer (int64) | required | Id of the campaign. |
contactIds | query | string | optional | Ids of the contacts, separated by commas, from 1 to 200, such as 101,102,103. |
variableKey | query | string | optional | Optional. The key of one image variable, or custom_image for the contacts' own images. Omitted returns every key. |
limit | query | integer (int32) | optional | Items per page, from 1 to 200. Omit limit and cursor to get every item in one response, as before; with only cursor, 50 per page. |
cursor | query | string | optional | The nextCursor of the previous page. Omit it for the first page. |
curl -X GET "https://api.ken.so/v1/campaigns/812/images?limit=1" \
-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 CampaignImage. Each item has these fields. The response also carries pagination.
Show the 11 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
Get a campaign image
/v1/campaign-images/{imageKey}campaign-images.get- Permission
- Campaigns view
- Rate limit
- 12,000 requests a minute per API key
campaign_images feature on your workspace. Until it is on, calls answer 404.Returns one image by its key, with a new preview link. Call it again when a previewUrl has expired.
imageKey is the 26-character key from the image list or from an image variable. A ready image has a previewUrl that works until previewExpiresAt, 1 hour after the call. A pending or failed image has no preview link.
Errors:
404 not_found: no image in this workspace has this key, or the image was deleted.
Requires Campaigns view.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
imageKey | path | string | required | The image's 26-character key. |
curl -X GET "https://api.ken.so/v1/campaign-images/01JC8Z3K6Q2W4M7N9P5R1T3V5X" \
-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 CampaignImage.
Show the 11 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
More in Campaigns:CampaignsEmail sequencesLinkedIn sequencesSegment email sequencesSegment LinkedIn sequencesSequence variablesSequences with conditionsSequence importSegmentsLead listsShare linksClient approvalsSending capacityAuto-pausesCampaign languagesLocalized stepsText translationMarket packsCountry complianceAll resources