{"openapi":"3.0.4","info":{"title":"Kenso API: Contact exports","version":"1.1","description":"The Contact exports endpoints of the Kenso API, with every component they use. The full spec is https://api.ken.so/v1/docs/openapi.json. Every request sends `Authorization: Bearer <your API key>` and `Ken-Version: 2026-11-02`."},"servers":[{"url":"https://api.ken.so"}],"security":[{"Bearer":[]}],"tags":[{"name":"contact-exports","description":"Export contacts to a CSV file. Create an export, then download the file from the job's `downloadUrl` within\n24 hours. Kenso builds the file when you download it, so it holds your contacts as they are at that moment. One file\nholds at most 50,000 rows, and contacts from a Kenso library list are never exported.","x-displayName":"Contact exports"}],"paths":{"/v1/contact-exports":{"post":{"tags":["contact-exports"],"summary":"Create a contact export","description":"Saves what the export should hold and returns its job. The job is already `succeeded` and its\n`downloadUrl` points at `GET /v1/contact-exports/{exportId}/content`, so you can download the file right\naway. The export id is the job id. You can read the job again with `GET /v1/jobs/{jobId}?type=contact_export`.\n            \nThe `kind` field picks what the file holds:\n            \n- `contacts` (the default): contacts across the workspace that match the filters in the body.\n- `campaign`: the contacts of one campaign. Without `fields`, the file adds a column for each of the campaign's personalization prompts.\n- `clicked`: the contacts of one campaign who clicked a tracking link, with their click data.\n- `advanced`: the contacts of one campaign, with their click events and total click count.\n- `events`: the events of one campaign's contacts between `occurredAfter` and `occurredBefore`.\n            \nEvery kind except `contacts` needs `campaignId`. Kind `contacts` needs it only with `readyOnly`.\nOnly kind `contacts` takes `segmentId`, `readyOnly`, `campaignIds`, `listId`,\n`createdAfter`, `createdBefore`, `maxRows` and `skipRows`. Other kinds refuse them.\n            \nCreating an export does not use your export row limit. Each download does.\nKenso never exports contacts from a Kenso library list. For kinds `contacts`, `campaign` and\n`advanced`, the job's `excludedLibraryContacts` says how many it left out.\n            \nErrors:\n            \n- `400 validation_failed`: the body is not a JSON object, or a field breaks the rule in its description.\n- `400 validation_failed`: kind `contacts` matches more than 50,000 contacts. Narrow the filters or set `maxRows`.\n- `404 not_found`: `campaignId`, an id in `campaignIds`, `listId` or `segmentId` is not in the workspace, or the list or segment is not in the campaigns you sent.\n- `429 quota_exceeded`: another kind would hold more than 50,000 rows.\n            \nRequires Campaigns view and the `export` permission.\n\nRate limit: 10 calls a minute per API key, on top of the workspace limits.","operationId":"contact-exports.create","parameters":[{"name":"Ken-Version","in":"header","description":"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 value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactExportBody"}}},"required":true},"responses":{"202":{"description":"Accepted","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["quota_exceeded","rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","features":["export"],"summary":"Campaigns view and the `export` permission"},"x-ken-rate-limit":{"limit":10,"windowSeconds":60,"per":"api_key"}}},"/v1/contact-exports/{exportId}/content":{"get":{"tags":["contact-exports"],"summary":"Download a contact export","description":"Streams the export's file. This is the path in the job's `downloadUrl`. Kenso builds the file at each\ndownload from what you set when you created the export, so the rows reflect your contacts at that moment.\n            \nThe file is a CSV. A kind `campaign` export of a campaign with more than one active segment is a ZIP with one\nCSV per segment. A kind `events` file has the columns `eventId`, `eventType`, `timestamp` and\n`contactId`. A cell that starts like a spreadsheet formula gets a leading apostrophe.\n            \nEach download charges its rows to the workspace's daily export row limit. You can download an export for 24 hours\nafter you create it.\n            \nErrors:\n            \n- `400 validation_failed`: Kenso cannot build the file, for example a kind `clicked` export of a campaign with no clicks, a kind `campaign` export without `fields` of a campaign with no personalization prompts, or a kind `contacts` export that now matches more than 50,000 contacts.\n- `404 not_found`: no export with this id exists in the workspace, or it is older than 24 hours.\n- `429 quota_exceeded`: the file would hold more than 50,000 rows.\n- `429 rate_limited`: the workspace reached its daily export row limit.\n            \nRequires Campaigns view and the `export` permission.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"contact-exports.content","parameters":[{"name":"exportId","in":"path","description":"The export's id, the same as the id of its `contact_export` job.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"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 value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"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`.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"OK","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"text/csv":{"schema":{"type":"string","format":"binary"}},"application/zip":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["unsupported_version","validation_failed","workspace_required"]},"401":{"description":"Unauthorized","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}},"x-ken-error-codes":["unauthenticated"]},"404":{"description":"Not Found","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Failure"}}},"x-ken-error-codes":["not_found"]},"429":{"description":"Too Many Requests","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}},"text/plain":{"schema":{"$ref":"#/components/schemas/RateLimitedText"}}},"x-ken-error-codes":["quota_exceeded","rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","features":["export"],"summary":"Campaigns view and the `export` permission"},"x-ken-rate-limit":{"limit":240,"windowSeconds":60,"per":"api_key"}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Enter: Bearer {your Kenso API key}. Create one in the Kenso app under Settings > Integrations > API Keys.","scheme":"bearer","bearerFormat":"Opaque API key"}},"headers":{"RateLimit-Limit":{"description":"The request limit of the rate limit this request is closest to reaching: your plan's limit for this kind of call, your API key's own limit, or the operation's own limit, whichever has the fewest requests left.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The requests left under that limit. `0` on a `429`.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The seconds until that limit resets.","schema":{"type":"integer"}}},"schemas":{"ApiKeyError":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A sentence for people that says what went wrong. It can change, so do not parse it."}},"additionalProperties":false,"description":"The body the API key check in front of the operations answered until November 2026, instead of the error body (`Failure`): `{ \"error\": \"Invalid or revoked API key\" }` on a `401`, `{ \"error\": \"Rate limit exceeded\" }` on a `429` and `{ \"error\": \"Authentication is temporarily unavailable\" }` on a `503`. It has no `code`, so branch on the HTTP status."},"ContactImportSkips":{"type":"object","properties":{"duplicateInCampaign":{"type":"integer","description":"Rows that match a contact already in this campaign.","format":"int32"},"duplicateInOtherCampaign":{"type":"integer","description":"Rows that match a contact in another campaign of the workspace, skipped because this campaign removes duplicates\nacross campaigns.","format":"int32"},"duplicateInSource":{"type":"integer","description":"Rows that repeat an earlier row of the same import.","format":"int32"},"alreadyContacted":{"type":"integer","description":"Rows that match a contact emailed within the campaign's recently emailed window.","format":"int32"},"blocklist":{"type":"integer","description":"Rows that match the workspace's blocklist.","format":"int32"},"failedValidation":{"type":"integer","description":"Rows that failed row checks, such as a row with no first and last name or no company name or domain.","format":"int32"},"salesNavigatorProfileUnresolved":{"type":"integer","description":"Sales Navigator people Kenso could not turn into a LinkedIn profile URL, so no LinkedIn step could reach them.","format":"int32"},"other":{"type":"integer","description":"Rows skipped for any other reason, such as a row Kenso could not process.","format":"int32"},"missingKey":{"type":"integer","description":"Rows with no email and no LinkedIn URL, dropped by the `missingKey` List check fix.","format":"int32"},"invalidEmail":{"type":"integer","description":"Rows whose email Kenso knows is invalid, dropped by the `invalidEmail` List check fix.","format":"int32"},"noMx":{"type":"integer","description":"Rows whose email domain takes no mail (no MX record), dropped by the `noMx` List check fix.","format":"int32"},"catchAll":{"type":"integer","description":"Rows whose email domain accepts every address, dropped by the `catchAll` List check fix.","format":"int32"},"personalEmail":{"type":"integer","description":"Rows with a personal email address, such as Gmail or Outlook.com, dropped by the `personalEmail` List check fix.","format":"int32"},"roleAddress":{"type":"integer","description":"Rows with a role address such as info@ or sales@, dropped by the `roleAddress` List check fix.","format":"int32"},"companyContacted":{"type":"integer","description":"Rows at a company where someone else recently got a Kenso email, dropped by the `companyContacted` List check fix.","format":"int32"},"companyCap":{"type":"integer","description":"Rows past the first 5 people at one company, dropped by the `companyCap` List check fix.","format":"int32"}},"additionalProperties":false,"description":"Rows a campaign contact import skipped, with each row counted under one reason."},"CreateContactExportBody":{"type":"object","properties":{"kind":{"type":"string","description":"What the export holds: `contacts` (contacts across the workspace, the default), `campaign`,\n`clicked`, `advanced` or `events`.","nullable":true},"campaignId":{"type":"integer","description":"The campaign to export. Required for every kind except `contacts`, and for `contacts` with\n`readyOnly`. With kind `contacts`, it limits the export to this campaign.","format":"int64","nullable":true},"segmentId":{"type":"integer","description":"Kind `contacts` only: export only this segment's contacts. When you send `campaignId` or\n`campaignIds`, the segment must belong to one of those campaigns.","format":"int64","nullable":true},"isQualified":{"type":"boolean","description":"Kinds `contacts` and `campaign`: `true` exports only qualified contacts, `false` only\nunqualified ones. Omitted exports both.","nullable":true},"hasValidEmail":{"type":"boolean","description":"Kind `contacts` only: `true` exports only contacts with a valid email, `false` only contacts\nwithout one. Omitted exports both.","nullable":true},"doNotContact":{"type":"boolean","description":"Kind `contacts` only: `true` exports only do-not-contact contacts, `false` only contactable ones.\nOmitted exports both.","nullable":true},"q":{"type":"string","description":"Kind `contacts` only: search text the contacts must match, at most 200 characters.","nullable":true},"contactIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Kind `contacts` only: export only these contacts, at most 1,000 ids.","nullable":true},"excludedContactIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Kind `contacts` only: leave these contacts out, at most 1,000 ids.","nullable":true},"fields":{"type":"array","items":{"type":"string"},"description":"The columns to write, at most 80 snake_case names such as `first_name`, `email` or\n`company_domain`. Omitted writes the kind's default columns, and kind `events` ignores it.","nullable":true},"readyOnly":{"type":"boolean","description":"Kind `contacts` only: `true` exports only contacts that are ready to send. Needs `campaignId`.\nDefaults to `false`."},"includeEmails":{"type":"boolean","description":"Kinds `campaign`, `clicked` and `advanced`: include the email columns. Defaults to `true`.","nullable":true},"includeCompany":{"type":"boolean","description":"Kinds `campaign`, `clicked` and `advanced`: include the company columns. Defaults to `true`.","nullable":true},"includeClickEvents":{"type":"boolean","description":"Kind `advanced` only: include each contact's click events. Defaults to `true`.","nullable":true},"includeTotalClicks":{"type":"boolean","description":"Kind `advanced` only: include each contact's total click count. Defaults to `true`.","nullable":true},"occurredAfter":{"type":"string","description":"Kind `events`, required: the start of the time range, as an ISO 8601 timestamp. The range can span at most\n366 days.","format":"date-time","nullable":true},"occurredBefore":{"type":"string","description":"Kind `events`, required: the end of the time range, as an ISO 8601 timestamp. It must not be before\n`occurredAfter`.","format":"date-time","nullable":true},"campaignIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Kind `contacts` only: export the contacts of these campaigns, from 1 to 50 campaign ids of the workspace.\nSend either this or `campaignId`, not both.","nullable":true},"listId":{"type":"integer","description":"Kind `contacts` only: export only the contacts of this import list, the `listId` on a contact. When you\nsend `campaignId` or `campaignIds`, the list must belong to one of those campaigns.","format":"int64","nullable":true},"createdAfter":{"type":"string","description":"Kind `contacts` only: export only contacts created at or after this time.","format":"date-time","nullable":true},"createdBefore":{"type":"string","description":"Kind `contacts` only: export only contacts created before this time. It must be later than\n`createdAfter`.","format":"date-time","nullable":true},"maxRows":{"type":"integer","description":"Kind `contacts` only: write at most this many rows, from 1 to 50,000.","format":"int32","nullable":true},"skipRows":{"type":"integer","description":"Kind `contacts` only: skip this many matching contacts first, in contact id order. Use it with\n`maxRows` to export in parts. 0 or more.","format":"int32","nullable":true}},"additionalProperties":false,"description":"The contacts and columns a new contact export holds."},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"InboxImportJob":{"type":"object","properties":{"connectedCount":{"type":"integer","description":"Rows that connected an inbox.","format":"int32"},"failedCount":{"type":"integer","description":"Rows that failed to connect.","format":"int32"},"skippedCount":{"type":"integer","description":"Rows Kenso skipped, such as an inbox the workspace already has.","format":"int32"},"startedAt":{"type":"string","description":"When the import started on its first row, in UTC. Omitted while it waits in the queue.","format":"date-time","nullable":true},"updatedAt":{"type":"string","description":"When the import last made progress, in UTC. An import with no progress for 10 minutes reads `failed`\nwith `error.code` `interrupted`.","format":"date-time"},"completedAt":{"type":"string","description":"When the import finished, in UTC. Omitted until it finishes.","format":"date-time","nullable":true},"rows":{"type":"array","items":{"$ref":"#/components/schemas/InboxImportRow"},"description":"Processed rows in `index` order, empty until the first row has a result. Returned when you create or get\nthe import, and omitted in lists and for a member without Delivery view.","nullable":true}},"additionalProperties":false,"description":"Counts and row results of an inbox import, without any passwords."},"InboxImportRow":{"type":"object","properties":{"index":{"type":"integer","description":"Zero-based position of the row in the request's `rows` array.","format":"int32"},"email":{"type":"string","description":"The row's email address."},"status":{"type":"string","description":"The row's result: `connected`, `failed` or `skipped`."},"inboxId":{"type":"integer","description":"The connected inbox, the existing inbox a skipped row matched, or the disconnected inbox a failed\nconnect left in the workspace. Omitted when there is none.","format":"int64","nullable":true},"errorCode":{"type":"string","description":"Why the row did not connect, omitted for a connected row. A skipped row has `already_exists`,\n`duplicate_in_file`, or `feature_disabled` or `forbidden` when the import stopped before the row\nbecause inbox import was turned off for the workspace or the member who started it lost Delivery edit. A failed\nrow has `email_in_use` (another Kenso inbox has the email), `host_failure_limit` (not tried, because\nits host refused several logins or could not be reached earlier in the import) or an API error code such as\n`validation_failed` or `service_unavailable`.","nullable":true},"message":{"type":"string","description":"A readable message about the row's result, when Kenso has one.","nullable":true},"firstName":{"type":"string","description":"On a connected row that set one in the file, the sender first name now on the mailbox. Omitted otherwise.","nullable":true},"lastName":{"type":"string","description":"On a connected row that set one in the file, the sender last name now on the mailbox. Omitted otherwise.","nullable":true},"dailySendLimit":{"type":"integer","description":"On a connected row that set one in the file, the daily limit now stored on the mailbox, after the provider\nceiling. Omitted otherwise.","format":"int32","nullable":true},"warnings":{"type":"array","items":{"type":"string"},"description":"Warning codes of a row that connected, omitted when there are none: `daily_limit_clamped` (the row's\n`dailySendLimit` was above the mailbox's provider ceiling and was stored at the ceiling) or\n`settings_not_applied` (the mailbox connected, but its names or limit could not be saved).","nullable":true},"details":{"type":"array","items":{"$ref":"#/components/schemas/InboxImportRowDetail"},"description":"On a row that failed a column check, one entry per refused column, with `field` naming the column. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One processed row of an inbox import."},"InboxImportRowDetail":{"type":"object","properties":{"field":{"type":"string","description":"The row column, such as `firstName` or `dailySendLimit`."},"code":{"type":"string","description":"Stable code for the problem, such as `invalid`."},"message":{"type":"string","description":"A sentence for people that says what is wrong with the column."}},"additionalProperties":false,"description":"One refused column of an inbox import row."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"Job":{"type":"object","properties":{"id":{"type":"integer","description":"The job's id. Ids are unique only within one `type`, so send `type` with the id when you read or\ncancel the job.","format":"int64"},"type":{"type":"string","description":"The job type: `contact_import`, `contact_export`, `domain_health`, `lead_scoring`,\n`enrichment`, `crawl`, `extraction`, `batch_scrape`, `knowledge_export`,\n`inbox_import` or `migration`."},"status":{"type":"string","description":"One of `queued`, `running`, `succeeded`, `failed` or `canceled`. Only `crawl`,\n`extraction`, `batch_scrape` and `migration` jobs reach `canceled`, and a `contact_export`\nor `knowledge_export` is `succeeded` from the start."},"progress":{"allOf":[{"$ref":"#/components/schemas/JobProgress"}],"description":"How far the job has run."},"pollAfterSeconds":{"type":"integer","description":"While the job is `queued` or `running`, how many seconds to wait before reading it again: 10 for a\n`crawl`, `extraction` or `batch_scrape` (each read asks the scraping provider), 30 for a\n`migration`, and 5 for the other types. Omitted once the job has finished.","format":"int32","nullable":true},"resource":{"allOf":[{"$ref":"#/components/schemas/JobResource"}],"description":"The object the job belongs to, such as its campaign. Omitted when it has none."},"createdAt":{"type":"string","description":"When the job was created, in UTC.","format":"date-time"},"downloadUrl":{"type":"string","description":"The path that downloads the job's file, such as `/v1/contact-exports/{exportId}/content`. Only on a\n`contact_export` or `knowledge_export`, and omitted for other types.","nullable":true},"error":{"allOf":[{"$ref":"#/components/schemas/JobError"}],"description":"Why the job failed. Present only when `status` is `failed`."},"result":{"description":"The raw status and output of a `crawl`, `extraction` or `batch_scrape`, such as the scraped pages.\nReturned only by `GET /v1/jobs/{jobId}` for those types, and omitted for other types and in lists."},"domainsListed":{"type":"integer","description":"For a finished `domain_health` job: how many of the checked domains are on a blocklist. Omitted for other\ntypes and until the job finishes.","format":"int32","nullable":true},"excludedLibraryContacts":{"type":"integer","description":"For a `contact_export` of kind `contacts`, `campaign` or `advanced`: how many contacts from a\nKenso library list the export left out, since Kenso never exports them. Omitted for other kinds and types, or when\nKenso could not count them.","format":"int32","nullable":true},"inboxImport":{"allOf":[{"$ref":"#/components/schemas/InboxImportJob"}],"description":"Counts and row results of an `inbox_import`. Omitted for other types."},"personImport":{"allOf":[{"$ref":"#/components/schemas/PersonImportJob"}],"description":"Counts of a `contact_import` with target `people`. Omitted for an import into a campaign and for other\ntypes."},"skipped":{"allOf":[{"$ref":"#/components/schemas/ContactImportSkips"}],"description":"Rows a `contact_import` into a campaign skipped, by reason, with 0 for a reason that skipped none. Omitted\nfor an import with target `people` and for other types."}},"additionalProperties":false,"description":"A background job, such as a contact import, a contact export or a crawl."},"JobError":{"type":"object","properties":{"code":{"type":"string","description":"The reason code. It is `failed` for every job type except `inbox_import`, which uses\n`interrupted`, `feature_disabled` or `forbidden`."},"message":{"type":"string","description":"A readable description of what went wrong."}},"additionalProperties":false,"description":"Why a job failed."},"JobProgress":{"type":"object","properties":{"completed":{"type":"integer","description":"How many items the job has finished. The item depends on `type`: for example imported contacts for a\ncampaign `contact_import`, checked domains for `domain_health` and processed rows for `inbox_import`.","format":"int32"},"total":{"type":"integer","description":"How many items the job handles in all. Omitted when Kenso does not know the total, as for `domain_health`.","format":"int32","nullable":true}},"additionalProperties":false,"description":"How far a job has run."},"JobResource":{"type":"object","properties":{"type":{"type":"string","description":"The kind of object: `campaign` for a campaign `contact_import`, a `contact_export` of a campaign,\n`lead_scoring` and `enrichment`, or `migration_run` for a `migration`."},"id":{"type":"integer","description":"The object's id.","format":"int64"}},"additionalProperties":false,"description":"The object a job belongs to."},"JobResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Job"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"PersonImportJob":{"type":"object","properties":{"source":{"type":"string","description":"Where the rows came from, the import's `source`, such as `csv`, `search` or `google_sheets`."},"createdCount":{"type":"integer","description":"Rows that created a new person.","format":"int32"},"updatedCount":{"type":"integer","description":"Rows that matched a person already in the workspace and updated it. Kenso matches by email, LinkedIn URL, or\nname and company domain.","format":"int32"},"skippedCount":{"type":"integer","description":"Rows Kenso skipped: a row with no email, no LinkedIn URL and no name with a business company domain, or a row\nKenso could not take in.","format":"int32"},"startedAt":{"type":"string","description":"When the import started, in UTC. Omitted while it waits in the queue.","format":"date-time","nullable":true},"completedAt":{"type":"string","description":"When the import finished or failed, in UTC. Omitted until then.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Counts of a contact import with target `people`."},"RateLimitedText":{"type":"string","description":"The gateway's plain-text body of a `429` over the operation's own limit, until November 2026: `Number of requests exceeded. Please try again later.`","example":"Number of requests exceeded. Please try again later."},"Refusal":{"type":"object","properties":{"code":{"type":"string","description":"Stable refusal code in upper case, such as `CAMPAIGN_LIMIT_REACHED` or `INSUFFICIENT_CREDITS`."},"metric":{"type":"string","description":"What the limit counts: `Campaigns`, `Leads`, `Emails`, `LinkedInSeats` or `AiCredits`,\n`jobs_export_rows` or `funding_export_rows` for an export allowance, `credit_pack_credits`,\n`credit_spend_usd_7d`, `domains` or `mailboxes` for a limit on a new paying workspace, or for a\nKenso Lifetime cap its key: `workspaces`, `inboxes`, `contacts`, `email_verifications_day`,\n`email_verifications_month`, `people_results_day`, `company_results_day`,\n`funding_results_day`, `job_post_results_day`, `website_visits_month` or\n`visitor_lookups_day`. Omitted when a plan rule, not a count, refused the request.","nullable":true},"used":{"type":"integer","description":"How much of the limit is used, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"limit":{"type":"integer","description":"The limit, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"remaining":{"type":"integer","description":"How much of the limit is left, in the unit of `metric`. Omitted when the refusal has no count.","format":"int32","nullable":true},"planType":{"type":"string","description":"The workspace's plan as its snake plan id, for example `free`, `legacy_core` or `growth`."},"remedy":{"type":"string","description":"What lifts the refusal: `Upgrade`, `BuyAddOn`, `UpdatePaymentMethod` or `ContactSupport`.\n`None` means no action of yours lifts it."},"unlocksAt":{"type":"string","description":"When the limit lifts by itself, in UTC: for a limit on a new paying workspace once it has paid an invoice, and for\na Kenso Lifetime daily or monthly cap its reset (00:00 UTC, or the 1st of the month). Omitted on every other\nrefusal.","format":"date-time","nullable":true},"requiredMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits the action needed. 1,000 millicredits are one credit. Omitted on every\nother refusal.","format":"int64","nullable":true},"availableMillicredits":{"type":"integer","description":"On a credit refusal, the millicredits available. On `FREE_CREDITS_NOT_ELIGIBLE`, only the credits that may\npay for inboxes and domains. Omitted on every other refusal.","format":"int64","nullable":true},"restrictedMillicredits":{"type":"integer","description":"On `FREE_CREDITS_NOT_ELIGIBLE`, the free and bonus millicredits in the balance that cannot pay for inboxes\nand domains. Omitted on every other refusal.","format":"int64","nullable":true},"feature":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the plan feature the plan does not include, in snake case (for example\n`website_visitor_id`). Omitted on every other refusal.","nullable":true},"requiredPlan":{"type":"string","description":"On `PLAN_FEATURE_NOT_AVAILABLE`, the cheapest plan that includes `feature`, in snake case (for example\n`growth`). For a feature the self-serve trial locks (`browser_runs`), the trial's own plan,\nwhich paying for unlocks it. Omitted on every other refusal.","nullable":true},"requiredTier":{"type":"integer","description":"On a Kenso Lifetime refusal, the lowest tier that lifts it: the next tier with a higher cap, or the lowest tier\nthat includes `feature`. Omitted at the top tier, when no tier includes the feature, and on every other\nrefusal.","format":"int32","nullable":true},"upgradeUrl":{"type":"string","description":"On a Kenso Lifetime refusal that a higher tier lifts, the AppSumo page where the buyer upgrades their license.\nOmitted until Kenso has read that page from AppSumo, when no tier lifts the refusal, and on every other refusal.","nullable":true}},"additionalProperties":false,"description":"Why a plan rule or usage limit refused the request, and how to lift it."},"TooManyRequestsError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The JSON body of a `429`: the error body (`Failure`), with code `rate_limited` or `quota_exceeded`, over your workspace's rate limits, your API key's own limit, the operation's own limit or a usage quota. Until November 2026, over your API key's own limit the API key check answered `{ \"error\": \"Rate limit exceeded\" }` (`ApiKeyError`), and over the operation's own limit the gateway answered plain text (`RateLimitedText`): `Number of requests exceeded. Please try again later.` A client built against those answers keeps working: handle each shape. Wait the `Retry-After` seconds."},"UnauthorizedError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The body of a `401`: the error body (`Failure`), whose `code` says what is wrong with the credential. Until November 2026, when the API key was not valid (unknown, expired or revoked, or its member no longer active), the API key check in front of the operations answered `{ \"error\": \"Invalid or revoked API key\" }` (`ApiKeyError`), and a request with no API key got a `401` that has no body. A client built against those answers keeps working: handle both shapes and a `401` with no body."}}}}