{"openapi":"3.0.4","info":{"title":"Kenso API: Workspaces","version":"1.1","description":"The Workspaces 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":"workspaces","description":"A workspace holds one company's campaigns, contacts, mailboxes and members. List the workspaces you belong to here,\nand send a workspace's id as `X-Ken-Workspace-Id` on the other calls.","x-displayName":"Workspaces"}],"paths":{"/v1/workspaces":{"get":{"tags":["workspaces"],"summary":"List workspaces","description":"Returns the workspaces the caller belongs to, ordered by id.\n            \n`q` keeps only the workspaces whose name contains it, ignoring case. `limit` is from 1 to 200, and the\ndefault is 50.\n            \nErrors:\n            \n- `400 validation_failed`: `limit` or `cursor` is invalid.\n            \nOpen to any signed-in caller.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"workspaces.list","parameters":[{"name":"q","in":"query","description":"Only the workspaces whose name contains this text, ignoring case. Omit it for every workspace.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of workspaces per page, from 1 to 200, default 50.","schema":{"maximum":200,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"cursor","in":"query","description":"The `nextCursor` from the previous page. Omit it for the first page.","schema":{"type":"string"}},{"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}}}],"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":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceSummaryListResponse"}}}},"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"]},"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"]},"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":["rate_limited"]}},"x-ken-permission":{"kind":"authenticated","summary":"Any signed-in caller"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/workspaces/{workspaceId}":{"get":{"tags":["workspaces"],"summary":"Get a workspace","description":"Returns the workspace's company details, goals, default Reply-To and brand.\n            \nErrors:\n            \n- `403 forbidden`: the caller does not belong to the workspace.\n            \nOpen to any workspace member.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"workspaces.get","parameters":[{"name":"workspaceId","in":"path","description":"The workspace id.","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}}}],"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":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"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"]},"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"]},"403":{"description":"Forbidden","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":["forbidden"]},"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":["rate_limited"]}},"x-ken-permission":{"kind":"workspace_member","summary":"Any workspace member except a Network member"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"patch":{"tags":["workspaces"],"summary":"Update a workspace","description":"Changes the fields you send and leaves the rest as they are. Returns the updated workspace.\n            \n`name` is trimmed and must keep 1 to 50 characters: it cannot be cleared, and a new name cannot contain a\nlink. Null or an empty string clears `website`, `linkedinCompanyUrl`, `companyContext` and\n`replyTo`. A `website` on a free-mail, disposable, relay or agent domain (gmail.com) is not a company's\nwebsite, so it clears `website` too.\n            \nThe reply rate and interested reply rate benchmarks and targets are percents from 0 to 100, counted per person\ncontacted, not as a share of replies. The meetings per month benchmark and target are from 0 to 10,000. Kenso\nkeeps two decimals, and null clears one.\n            \n`replyTo` must be a mailbox connected to this workspace that Kenso reads replies from. A request with an\ninvalid field changes nothing.\n            \nErrors:\n            \n- `400 validation_failed`: a field is invalid. For `replyTo`, the detail code `invalid` means\nthe address is malformed, `not_connected` means no mailbox of the workspace has it, and\n`not_ingested` means Kenso does not read replies from that mailbox.\nFor `instagramUrl`, `xUrl`, `youtubeUrl` and `githubUrl`, the detail code\n`wrong_platform` means the link is on another site, `not_a_profile` means it is a post, video or other\npage rather than a profile, and `invalid_url` means it is not a link. Kenso stores each link in one\ncanonical form (twitter.com becomes x.com), and null or an empty string clears it. `linkedinCompanyUrl` is\nstored canonical when it is a LinkedIn company, school or showcase page, and as sent otherwise.\n- `403 forbidden`: the caller does not belong to the workspace.\n            \nRequires the `workspace_settings` permission.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"workspaces.update","parameters":[{"name":"workspaceId","in":"path","description":"The workspace id.","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}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchWorkspaceRequest"}}}},"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":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkspaceResponse"}}}},"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"]},"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"]},"403":{"description":"Forbidden","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":["forbidden"]},"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":["rate_limited"]}},"x-ken-permission":{"kind":"feature","features":["workspace_settings"],"summary":"The `workspace_settings` permission"},"x-ken-rate-limit":{"limit":4800,"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."},"DemoPersona":{"type":"object","properties":{"memberId":{"type":"integer","description":"The member's id.","format":"int64"},"email":{"type":"string","description":"The member's email address."}},"additionalProperties":false,"description":"The sample member a demo workspace shows."},"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`."},"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."},"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."},"Pagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send this value as `cursor` to get the next page. Omitted on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when more items follow this page. Stop paging when it is false."},"total":{"type":"integer","description":"Deprecated: the same number as `totalCount`. Read `totalCount`.","format":"int32","nullable":true,"deprecated":true},"totalCount":{"type":"integer","description":"The number of items that match the list's filters, across all pages. Omitted when the list does not count them.","format":"int32","nullable":true},"isTotalCapped":{"type":"boolean","description":"True when `totalCount` stopped counting at its cap, so more items match than it says. Keep paging with\n`hasMore`. Omitted when `totalCount` is exact. Only `GET /v1/threads` with `q` caps its total.","nullable":true}},"additionalProperties":false,"description":"Where a list page ends and how to get the next page."},"PatchWorkspaceRequest":{"type":"object","properties":{"name":{"type":"string","description":"The workspace's name, from 1 to 50 characters after trimming. It cannot be cleared, and a new name\n            cannot contain a link.","nullable":true},"website":{"type":"string","description":"The company's website.","nullable":true},"linkedinCompanyUrl":{"type":"string","description":"The URL of the company's LinkedIn page.","nullable":true},"instagramUrl":{"type":"string","description":"The company's Instagram profile. Any other link is refused.","nullable":true},"xUrl":{"type":"string","description":"The company's X profile. Kenso stores a twitter.com link as https://x.com/{handle}.","nullable":true},"youtubeUrl":{"type":"string","description":"The company's YouTube channel, not a video.","nullable":true},"githubUrl":{"type":"string","description":"The company's GitHub user or organization.","nullable":true},"companyContext":{"type":"string","description":"Background about the company that Ken uses as context.","nullable":true},"pauseSendingOnUsHolidays":{"type":"boolean","description":"True to pause the workspace's sending campaigns at 11:00 UTC on each US federal holiday (its\nEastern date) and resume them the next non-holiday day, false to keep sending. A campaign that\nstarts sending after the pause still sends that day.","nullable":true},"replyTo":{"type":"string","description":"The default Reply-To address: a mailbox connected to this workspace that Kenso reads replies from, not a\nmember's own mailbox.","nullable":true},"replyRateBenchmark":{"type":"number","description":"The reply rate benchmark, in percent from 0 to 100.","format":"double","nullable":true},"replyRateTarget":{"type":"number","description":"The reply rate target, in percent from 0 to 100.","format":"double","nullable":true},"positiveReplyRateBenchmark":{"type":"number","description":"The interested reply rate benchmark, in percent from 0 to 100.","format":"double","nullable":true},"positiveReplyRateTarget":{"type":"number","description":"The interested reply rate target, in percent from 0 to 100.","format":"double","nullable":true},"meetingsPerMonthBenchmark":{"type":"number","description":"The benchmark for meetings booked per month, from 0 to 10,000.","format":"double","nullable":true},"meetingsPerMonthTarget":{"type":"number","description":"The target for meetings booked per month, from 0 to 10,000.","format":"double","nullable":true}},"additionalProperties":false,"description":"The workspace fields to change. Absent fields stay as they are. Null clears a goal or a text field other\n            than `name`."},"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."},"WhiteLabelClientSeats":{"type":"object","properties":{"readReplies":{"type":"boolean","description":"\"Clients can read replies\", the Client template's default: true gives Inbox edit and the `reply`\npermission, false turns Inbox off. Default false. An edited Client template keeps its edit."}},"additionalProperties":false,"description":"The Client seat settings a white-label workspace chose for its client workspaces."},"Workspace":{"type":"object","properties":{"id":{"type":"integer","description":"The workspace id.","format":"int64"},"name":{"type":"string","description":"The workspace's name."},"isActive":{"type":"boolean","description":"Whether the workspace is active."},"website":{"type":"string","description":"The company's website.","nullable":true},"linkedinCompanyUrl":{"type":"string","description":"The URL of the company's LinkedIn page.","nullable":true},"instagramUrl":{"type":"string","description":"The company's Instagram profile, such as https://www.instagram.com/acme.","nullable":true},"xUrl":{"type":"string","description":"The company's X profile, such as https://x.com/acme.","nullable":true},"youtubeUrl":{"type":"string","description":"The company's YouTube channel, such as https://www.youtube.com/@acme.","nullable":true},"githubUrl":{"type":"string","description":"The company's GitHub user or organization, such as https://github.com/acme.","nullable":true},"companyContext":{"type":"string","description":"Background about the company that Ken uses as context when it works for this workspace.","nullable":true},"ownerLink":{"type":"string","description":"Whether Kenso linked the owner named when the workspace was created: `linked`, `already_member`,\n`user_not_found`, `email_unverified` (a Kenso user holds the email but never verified it, so it was\nnot linked) or `failed`. Omitted otherwise.","nullable":true},"logoUrl":{"type":"string","description":"The URL of the workspace's square icon. Omitted when none is set.","nullable":true},"wordmarkUrl":{"type":"string","description":"The URL of the workspace's wide logo. Omitted when none is set.","nullable":true},"wordmarkDarkUrl":{"type":"string","description":"The URL of the workspace's wide logo for dark backgrounds, usually a white version of the wide logo. Booking pages\nin dark mode show it in place of the wide logo. Null when none is set.","nullable":true},"pauseSendingOnUsHolidays":{"type":"boolean","description":"Whether Kenso pauses the workspace's campaigns on US federal holidays. At 11:00 UTC on the\nholiday (its date in Eastern time) Kenso pauses every campaign sending at that moment, except\ntrigger campaigns, and resumes the ones it paused at 11:00 UTC on the next non-holiday day. A\ncampaign that starts sending later that day still sends, and one a member paused stays paused.\nWhatever this says, a campaign that sends in each lead's time zone also skips a lead's local\npublic holidays when Kenso knows the lead's country."},"replyRateBenchmark":{"type":"number","description":"The reply rate benchmark, in percent, so 2.5 is 2.5%. Null when not set.","format":"double","nullable":true},"replyRateTarget":{"type":"number","description":"The reply rate target, in percent. Null when not set.","format":"double","nullable":true},"positiveReplyRateBenchmark":{"type":"number","description":"The interested reply rate benchmark, in percent. Null when not set.","format":"double","nullable":true},"positiveReplyRateTarget":{"type":"number","description":"The interested reply rate target, in percent. Null when not set.","format":"double","nullable":true},"meetingsPerMonthBenchmark":{"type":"number","description":"The benchmark for meetings booked per month. Null when not set.","format":"double","nullable":true},"meetingsPerMonthTarget":{"type":"number","description":"The target for meetings booked per month. Null when not set.","format":"double","nullable":true},"replyTo":{"type":"string","description":"The Reply-To address on the workspace's cold emails, unless a campaign sets its own. Omitted when none is\nset.","nullable":true},"parentWorkspaceId":{"type":"integer","description":"For a white-label client workspace, the workspace that manages it. Omitted otherwise.","format":"int64","nullable":true},"isChild":{"type":"boolean","description":"True for a white-label client workspace."},"hasClients":{"type":"boolean","description":"True when the workspace has at least one active Client seat or manages at least one white-label client\nworkspace."},"brand":{"allOf":[{"$ref":"#/components/schemas/WorkspaceBrand"}],"description":"The brand the workspace shows, which is the managing workspace's for a white-label client workspace. Omitted\nwhen Kenso cannot read it."},"isDemo":{"type":"boolean","description":"True only on Kenso's demo workspace."},"isSandbox":{"type":"boolean","description":"True on a developer sandbox: a workspace of your own where sends are simulated and nothing leaves Kenso."},"demoPersona":{"allOf":[{"$ref":"#/components/schemas/DemoPersona"}],"description":"Only on Kenso's own demo workspace: the sample member whose calendar, meetings, notes and call queue the demo\nshows. Omitted on every other workspace."},"demoBuildsPlayBack":{"type":"boolean","description":"Only on Kenso's own demo workspace: true when a new campaign build runs there, with every paid step answered from\na recorded real build. Omitted on every other workspace.","nullable":true}},"additionalProperties":false,"description":"A workspace: its company details, goals, default Reply-To and brand.","example":{"id":812,"name":"Northwind Outbound","isActive":true,"website":"https://northwind-outbound.example.com","companyContext":"Northwind Outbound runs cold email for B2B SaaS companies selling to engineering leaders in North America.","logoUrl":"https://cdn.example.com/workspaces/812/icon.png","pauseSendingOnUsHolidays":true,"replyRateBenchmark":3.5,"replyRateTarget":5,"positiveReplyRateBenchmark":1.2,"positiveReplyRateTarget":2,"meetingsPerMonthBenchmark":8,"meetingsPerMonthTarget":12,"replyTo":"replies@mail.example.com","isChild":false,"hasClients":false,"isDemo":false,"isSandbox":false}},"WorkspaceBrand":{"type":"object","properties":{"productName":{"type":"string","description":"The product name the workspace shows."},"logoUrl":{"type":"string","description":"The URL of the brand's logo."},"faviconUrl":{"type":"string","description":"The URL of the brand's favicon."},"appUrl":{"type":"string","description":"The base URL of the app for this workspace, such as `https://app.ken.so`."},"accentColor":{"type":"string","description":"The accent color as uppercase `#RRGGBB`. Omitted when Kenso's default color applies.","nullable":true},"clientSeats":{"allOf":[{"$ref":"#/components/schemas/WhiteLabelClientSeats"}],"description":"The Client seat settings of the white-label workspace behind the brand. Omitted when Kenso cannot read them."},"clientApprovalLinks":{"type":"boolean","description":"The \"Client approval links\" setting of the white-label workspace behind the brand. Omitted when Kenso cannot\nread it.","nullable":true}},"additionalProperties":false,"description":"The brand a workspace shows: its product name, logos, app address and accent color."},"WorkspaceResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/Workspace"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"WorkspaceSummary":{"type":"object","properties":{"id":{"type":"integer","description":"The workspace id.","format":"int64"},"name":{"type":"string","description":"The workspace's name."},"isActive":{"type":"boolean","description":"Whether the workspace is active."},"logoUrl":{"type":"string","description":"The URL of the workspace's square icon. Omitted when none is set.","nullable":true},"wordmarkUrl":{"type":"string","description":"The URL of the workspace's wide logo. Omitted when none is set.","nullable":true},"wordmarkDarkUrl":{"type":"string","description":"The URL of the workspace's wide logo for dark backgrounds, usually a white version of the wide logo. Booking pages\nin dark mode show it in place of the wide logo. Null when none is set.","nullable":true},"parentWorkspaceId":{"type":"integer","description":"For a white-label client workspace, the workspace that manages it. Omitted otherwise.","format":"int64","nullable":true},"brandHostname":{"type":"string","description":"The verified custom hostname of the workspace's white-label brand. Omitted when there is\n            none.","nullable":true},"isDemo":{"type":"boolean","description":"True only on Kenso's demo workspace."},"isSandbox":{"type":"boolean","description":"True on a developer sandbox: a workspace of your own where sends are simulated and nothing leaves Kenso."},"demoBuildsPlayBack":{"type":"boolean","description":"Only on Kenso's own demo workspace: true when a new campaign build runs there, with every paid step answered from\na recorded real build. Omitted on every other workspace.","nullable":true}},"additionalProperties":false,"description":"A workspace the caller belongs to, as listed.","example":{"id":812,"name":"Northwind Outbound","isActive":true,"logoUrl":"https://cdn.example.com/workspaces/812/icon.png","isDemo":false,"isSandbox":false}},"WorkspaceSummaryListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkspaceSummary"},"description":"The items on this page."},"pagination":{"allOf":[{"$ref":"#/components/schemas/Pagination"}],"description":"Where this page ends and how to get the next one."}},"additionalProperties":false,"description":"The body of a successful list operation: one page of results in `data`, and `pagination` to get the next\npage."}}}}