{"openapi":"3.0.4","info":{"title":"Kenso API: People and company search","version":"1.1","description":"The People and company search 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":"search","description":"Search is Kenso's index of people and companies, the data behind the Search page. Search people or companies with filters and facet counts, read one profile by Search id or LinkedIn URL, expand job titles and industries, find lookalikes of the companies or people you pick, and read a sample search Ken builds from the workspace's ideal customer profile. Each profile that a search, get or lookup returns counts against the workspace's daily `searchBrowseRows` quota, and past it calls answer `429 quota_exceeded` with `Retry-After`. Import the people you choose into a campaign in the background: preview it, start it with `POST /v1/search/imports` and poll `GET /v1/search/imports/{importId}`.","x-displayName":"People and company search"}],"paths":{"/v1/search/people":{"post":{"tags":["search"],"summary":"Search people","description":"Search Kenso's people index with filters and get one page of people, for example to pick prospects to import.\n            \nThe body holds the filters (`GET /v1/search/filters` lists their values), `page` (from 1) and\n`pageSize` (0 to 100, default 25). Each person carries `hasKenEmail`, true when Kenso holds a verified\nemail, and `kenEmailStatus`: `none`, `risky`, `catch_all` or `verified`.\n`view=summary` returns only list row fields, about 2 KB a person instead of 20 KB. For people like examples\nyou know, send `companyLookalike` or `lookalike` (see `GET /v1/search/lookalike-seeds`). With the\n`behavior_signals` feature, people carry `behaviorTags` from past outreach, and a `behaviorTags`\nlist in the body keeps people with one of them, so a page can hold fewer people.\n            \n`inLinkedInConnections: true` keeps only people who are a 1st-degree connection of one of the workspace's\nLinkedIn seats, together with every other filter. It needs the `linkedin_network` or\n`linkedin_connections_import` feature. With no connections synced, the search matches nobody.\n            \nErrors:\n            \n- `400 validation_failed`: a filter, `view`, `behaviorTags` or `inLinkedInConnections` is not\nvalid.\n- `400 lookalike_conflict`: the body sends both lookalike filters.\n- `400 too_many_seeds`: a lookalike filter has too many seeds.\n- `400 invalid_lookalike`: a lookalike filter is not valid.\n- `400 lookalikes_unavailable`: lookalike search is not available right now.\n- `402 plan_required`: the body holds a funding filter (`companyFundingAmount`,\n`companyFundedWithinDays`, `fundingRoundTypes`, `excludeFundingRoundTypes`, `fundingAmount`\nor `raisedFundingRecently`) and the workspace's plan does not include funding signals. `error.refusal`\ncarries the code `PLAN_FEATURE_NOT_AVAILABLE` and the feature `funding_signals`.\n- `403 feature_disabled`: a lookalike filter needs the `lookalikes` feature, or\n`inLinkedInConnections` needs `linkedin_network` or `linkedin_connections_import`.\n- `422 no_usable_seeds`: Kenso could not use any seed.\n- `429 quota_exceeded`: the daily quota is used up.\n- `503 service_unavailable`: a lookup the search needs failed. Try again.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.search-people","parameters":[{"name":"view","in":"query","description":"How much of each person to return: `full` (default) or `summary`.","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}}},{"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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPeopleResultsResponse"}}}},"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":["invalid_lookalike","lookalike_conflict","lookalikes_unavailable","too_many_seeds","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"]},"402":{"description":"Payment Required","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":["plan_required"]},"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":["feature_disabled"]},"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"]},"422":{"description":"Unprocessable Content","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":["no_usable_seeds"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/people/{personId}":{"get":{"tags":["search"],"summary":"Get a person","description":"Get one person's full profile by Search id, with `hasKenEmail` and `kenEmailStatus`.\n            \nErrors:\n            \n- `404 not_found`: no person has this id.\n- `429 quota_exceeded`: the daily quota is used up.\n            \nRequires Search view.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-person","parameters":[{"name":"personId","in":"path","description":"The `kenId` of a people search result.","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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPersonResponse"}}}},"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","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":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":240,"windowSeconds":60,"per":"api_key"}}},"/v1/search/people/lookup":{"get":{"tags":["search"],"summary":"Look up a person by LinkedIn URL","description":"Get one person's full profile from their LinkedIn profile URL, when you do not have their Search id.\n            \nErrors:\n            \n- `400 validation_failed`: `linkedInUrl` is missing.\n- `404 not_found`: Search holds no person with this URL.\n- `429 quota_exceeded`: the daily quota is used up.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.lookup-person","parameters":[{"name":"linkedInUrl","in":"query","description":"The profile URL, such as `https://www.linkedin.com/in/jane-doe`.","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}}},{"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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPersonResponse"}}}},"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":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/people/facets":{"post":{"tags":["search"],"summary":"Get people search facets","description":"Count the people that match each value of the main filters, for a `POST /v1/search/people` body. Facets do\nnot count against `searchBrowseRows`. With `inLinkedInConnections: true`, the counts hold only the\nworkspace's LinkedIn connections.\n            \nErrors:\n            \n- `400 validation_failed`: a filter is not valid.\n- `402 plan_required`: the body holds a funding filter (as on `POST /v1/search/people`) and the\nworkspace's plan does not include funding signals (`error.refusal` feature `funding_signals`).\n- `403 feature_disabled`: a lookalike filter needs the `lookalikes` feature, or\n`inLinkedInConnections` needs `linkedin_network` or `linkedin_connections_import`.\n- `503 service_unavailable`: a lookup the search needs failed. Try again.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-people-facets","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"}}],"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/SearchPeopleFacetsResponse"}}}},"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"]},"402":{"description":"Payment Required","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":["plan_required"]},"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":["feature_disabled"]},"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":["rate_limited"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/companies":{"post":{"tags":["search"],"summary":"Search companies","description":"Search Kenso's company index with filters and get one page of companies, for example to build an account list.\n            \nThe body holds the filters, `page` (from 1) and `pageSize` (0 to 100, default 25). For companies like\nexamples you know, send `lookalike` (see `GET /v1/search/lookalike-seeds`). A lookalike search returns\nat most 2,000 companies and ignores `sortBy`.\n            \n`inLinkedInConnections: true` keeps only companies where at least one of the workspace's LinkedIn connections\nworks now or worked before, together with every other filter. It needs the `linkedin_network` or\n`linkedin_connections_import` feature. With no connections synced, the search matches no company.\n            \nErrors:\n            \n- `400 validation_failed`: a filter or `inLinkedInConnections` is not valid.\n- `400 too_many_seeds`: `lookalike` has too many seeds or negatives.\n- `400 invalid_lookalike`: `lookalike` is not valid.\n- `400 lookalikes_unavailable`: lookalike search is not available right now.\n- `402 plan_required`: the body holds a funding filter (as on `POST /v1/search/people`) and the\nworkspace's plan does not include funding signals (`error.refusal` feature `funding_signals`).\n- `403 feature_disabled`: a lookalike filter needs the `lookalikes` feature, or\n`inLinkedInConnections` needs `linkedin_network` or `linkedin_connections_import`.\n- `422 no_usable_seeds`: Kenso could not use any seed.\n- `429 quota_exceeded`: the daily quota is used up.\n- `503 service_unavailable`: a lookup the search needs failed. Try again.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.search-companies","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"}}],"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/SearchCompaniesResultsResponse"}}}},"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":["invalid_lookalike","lookalikes_unavailable","too_many_seeds","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"]},"402":{"description":"Payment Required","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":["plan_required"]},"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":["feature_disabled"]},"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"]},"422":{"description":"Unprocessable Content","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":["no_usable_seeds"]},"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"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/companies/{companyId}":{"get":{"tags":["search"],"summary":"Get a company from Search","description":"Get one company's full profile by Search id.\n            \nErrors:\n            \n- `404 not_found`: no company has this id.\n- `429 quota_exceeded`: the daily quota is used up.\n            \nRequires Search view.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-company","parameters":[{"name":"companyId","in":"path","description":"The `kenId` of a company search result.","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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCompanyResponse"}}}},"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","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":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":240,"windowSeconds":60,"per":"api_key"}}},"/v1/search/companies/lookup":{"get":{"tags":["search"],"summary":"Look up a company by LinkedIn URL","description":"Get one company's full profile from its LinkedIn page URL, when you do not have its Search id.\n            \nErrors:\n            \n- `400 validation_failed`: `linkedInUrl` is missing.\n- `404 not_found`: Search holds no company with this URL.\n- `429 quota_exceeded`: the daily quota is used up.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.lookup-company","parameters":[{"name":"linkedInUrl","in":"query","description":"The page URL, such as `https://www.linkedin.com/company/acme`.","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}}},{"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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchCompanyResponse"}}}},"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":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/companies/facets":{"post":{"tags":["search"],"summary":"Get company search facets","description":"Count the companies that match each value of the main filters, for a `POST /v1/search/companies` body.\nFacets do not count against `searchBrowseRows`. With `inLinkedInConnections: true`, the counts hold only\ncompanies where one of the workspace's LinkedIn connections works or worked.\n            \nErrors:\n            \n- `400 validation_failed`: a filter is not valid.\n- `402 plan_required`: the body holds a funding filter (as on `POST /v1/search/people`) and the\nworkspace's plan does not include funding signals (`error.refusal` feature `funding_signals`).\n- `403 feature_disabled`: a lookalike filter needs the `lookalikes` feature, or\n`inLinkedInConnections` needs `linkedin_network` or `linkedin_connections_import`.\n- `503 service_unavailable`: a lookup the search needs failed. Try again.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-company-facets","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"}}],"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/SearchCompanyFacetsResponse"}}}},"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"]},"402":{"description":"Payment Required","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":["plan_required"]},"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":["feature_disabled"]},"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":["rate_limited"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/filters":{"get":{"tags":["search"],"summary":"Get the filter options","description":"Get the fixed values the people and company filters accept, such as seniority levels, industries and locations.\n            \nPage through long lists, such as job titles or cities, with `GET /v1/search/metadata`.\n            \nRequires Search view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-filters","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"}}],"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/SearchFilterCatalogResponse"}}}},"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","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":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/search/metadata":{"get":{"tags":["search"],"summary":"List filter values","description":"List the values of one filter category, such as `industry`, `job_title`, `skill` or `city`,\nfor type-ahead pickers.\n            \n`q` keeps values that contain its text, `limit` and `cursor` page the list, and\n`includeTotal=true` adds `pagination.totalCount`. Without `category`, the answer is the whole\nfilter catalog as one object.\n            \nErrors:\n            \n- `400 validation_failed`: the category is unknown, or `cursor` is not valid.\n            \nRequires Search view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-metadata","parameters":[{"name":"category","in":"query","description":"A filter category, for example `industries`. Without it the whole catalog is returned.","schema":{"type":"string"}},{"name":"q","in":"query","description":"Text the category's values must contain. Used only with `category`.","schema":{"type":"string"}},{"name":"limit","in":"query","description":"Page size, from 1 to 100. Default 50. Used only with `category`.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"cursor","in":"query","description":"The `pagination.nextCursor` of the previous page.","schema":{"type":"string"}},{"name":"includeTotal","in":"query","description":"Adds `pagination.totalCount`, the number of values in the category that match `q`.","schema":{"type":"boolean"}},{"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":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/SearchMetadataValuesResponse"},{"$ref":"#/components/schemas/SearchFilterCatalogResponse"}]}}}},"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":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/search/companies/people":{"post":{"tags":["search"],"summary":"Search people at given companies","description":"Search people at the companies you name, for example after a company search.\n            \nSend a `POST /v1/search/people` body plus `companyIds`, the `kenId` values of the companies. The\nanswer is a people search page.\n            \nErrors:\n            \n- `400 validation_failed`: a filter is not valid.\n- `402 plan_required`: the body holds a funding filter (as on `POST /v1/search/people`) and the\nworkspace's plan does not include funding signals (`error.refusal` feature `funding_signals`).\n- `403 feature_disabled`: a lookalike filter needs the `lookalikes` feature.\n- `422 no_usable_seeds`: Kenso could not use any lookalike seed.\n- `429 quota_exceeded`: the daily quota is used up.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.search-company-people","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"}}],"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/SearchPeopleResultsResponse"}}}},"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"]},"402":{"description":"Payment Required","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":["plan_required"]},"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":["feature_disabled"]},"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"]},"422":{"description":"Unprocessable Content","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":["no_usable_seeds"]},"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":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/headcount-changes":{"get":{"tags":["search"],"summary":"List companies with headcount growth","description":"List companies whose headcount grew from one month to the next.\n            \n`month` picks the month (all months, newest first, when omitted), `minGrowthPct` sets the least growth,\nand `limit` and `cursor` page the list.\n            \nErrors:\n            \n- `400 validation_failed`: `cursor` is not valid.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.list-headcount-changes","parameters":[{"name":"month","in":"query","description":"Detection month as `yyyy-MM`. Without it every month is returned, most recent first.","schema":{"type":"string"}},{"name":"minGrowthPct","in":"query","description":"Only companies that grew by at least this percentage, for example `20` for 20%.","schema":{"type":"number","format":"double"}},{"name":"limit","in":"query","description":"Page size, from 1 to 100. Default 50.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":50}},{"name":"cursor","in":"query","description":"The `pagination.nextCursor` of the previous 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}}},{"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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchListResponse"}}}},"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":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/people/expand-titles":{"post":{"tags":["search"],"summary":"Expand job titles","description":"Get related job titles for the titles you send, so a people search also finds the same role under other names.\n            \nSend `titles`, a list of up to 50 job titles. The answer's `expandedTitles` maps each title you sent to\nits related titles. `error` says why when the expansion failed.\n            \nKenso runs an AI model for each expansion. The same body in the same workspace within an hour gets the earlier\nanswer at no cost. Any other call takes one unit of the workspace's `aiSearchExpand` quota: 20 a minute and\n500 a day, shared with industry expansion.\n            \nErrors:\n            \n- `400 validation_failed`: `titles` is not valid, for example more than 50 titles.\n- `429 quota_exceeded`: the workspace used its `aiSearchExpand` quota. Retry after the\n`Retry-After` header.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.expand-titles","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"}}],"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/SearchPeopleTitleExpansionResponse"}}}},"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":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key","summary":"20 requests a minute and 500 a day per workspace (Free plan: 2 a minute and 50 a day)","quotas":[{"policy":"aiSearchExpand","per":"workspace","limits":[{"limit":20,"windowSeconds":60},{"limit":500,"windowSeconds":86400}],"plans":[{"plan":"Free","limits":[{"limit":2,"windowSeconds":60},{"limit":50,"windowSeconds":86400}]}]}]}}},"/v1/search/metadata/expand-industries":{"post":{"tags":["search"],"summary":"Expand industries","description":"Get related industries for the industries you send, so a search covers neighboring industries too.\n            \nSend `industries`, a list of up to 50 industries. The answer's `expandedIndustries` maps each industry\nyou sent to its related industries. `error` says why when the expansion failed.\n            \nKenso runs an AI model for each expansion. The same body in the same workspace within an hour gets the earlier\nanswer at no cost. Any other call takes one unit of the workspace's `aiSearchExpand` quota: 20 a minute and\n500 a day, shared with title expansion.\n            \nErrors:\n            \n- `400 validation_failed`: `industries` is not valid, for example more than 50 industries.\n- `429 quota_exceeded`: the workspace used its `aiSearchExpand` quota. Retry after the\n`Retry-After` header.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.expand-industries","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"}}],"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/SearchIndustryExpansionResponse"}}}},"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":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key","summary":"20 requests a minute and 500 a day per workspace (Free plan: 2 a minute and 50 a day)","quotas":[{"policy":"aiSearchExpand","per":"workspace","limits":[{"limit":20,"windowSeconds":60},{"limit":500,"windowSeconds":86400}],"plans":[{"plan":"Free","limits":[{"limit":2,"windowSeconds":60},{"limit":50,"windowSeconds":86400}]}]}]}}},"/v1/search/lookalike-seeds":{"get":{"tags":["search"],"summary":"List lookalike seed suggestions","description":"List companies from your own data that make good seeds for a lookalike search: your customers, your deals, the\ncompanies that replied, a campaign's companies or your website visitors. Send a row's `domain` as a\n`{\"domain\": ...}` seed in `POST /v1/search/companies` or `POST /v1/search/people`.\n            \n`source` is required and picks where the companies come from:\n            \n- `customers`: the workspace's customer accounts. `count` is the number of accounts with the domain,\nnormally 1.\n- `crm`: companies on your opportunities and synced CRM deals. `count` is the number of deals. `stage` picks\n`won` (the default), `open` (neither won nor lost) or `any`. `crm_won` still works and means\n`crm` with `stage=won`.\n- `interested`: companies whose people replied with interest. `count` is the number of contacts.\n- `replies`: companies whose people sent a real reply, which leaves out automated replies, bounces and\nout-of-office replies. `count` is the number of contacts.\n- `campaign`: the companies of one campaign's live contacts. `count` is the number of contacts.\n- `website_visitors`: companies behind human visits to the workspace's tracked website. `count` is the\nnumber of visits.\n            \n`campaignId` is required with `campaign` and filters `interested` and `replies` to one\ncampaign. Sending it also needs Campaigns view. `since`, a `YYYY-MM-DD` day in UTC, keeps only replies\nor visits on or after that day, for `interested`, `replies` and `website_visitors`.\n            \nKenso reads at most the newest 20,000 replies, contacts or visits and groups them by company domain: the\ncontact's company domain, else the domain of their email address. A free email domain never becomes a seed. The\nlist holds up to 200 rows in one page, sorted by `count` from high to low, then by `domain`. An empty\nlist is normal. The call is free.\n            \nThe lookalike filters need the `lookalikes` feature. Each takes `seeds`, `negatives` (up to 100\nto steer away from), `mode` (`precise` or `broad`) and `minGrade` (1 to 5, default 2:\n`precise` drops rows graded below it). `POST /v1/search/companies` takes `lookalike` with 1 to 100\ncompany seeds, each a `companyId`, `domain`, `linkedInUrl` or `text` (up to 4,000\ncharacters), plus `excludeDomains` and `includeNonB2b`. `POST /v1/search/people` takes either\n`companyLookalike`, the same filter, or `lookalike` with 1 to 50 people seeds, each a `personId`\nor `linkedInUrl`, plus `includeSeedCompanies`. Kenso excludes the workspace's do-not-contact and\ncustomer domains. Rows come sorted by similarity, each with `lookalike`: a `score` from 0 to 100 and a\n`grade` from 1 to 5, 5 the closest. The page lists each seed's outcome in `lookalikeSeeds`. A lookalike\nsearch is a snapshot, so save or import its results by id, not by its filters.\n            \nErrors:\n            \n- `400 validation_failed`: `source` is missing or unknown, or you sent a parameter the source does not\ntake.\n- `403 permission_denied`: you sent `campaignId` without Campaigns view.\n- `404 not_found`: the campaign is not in this workspace or was deleted.\n            \nRequires Accounts view and Search view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.\n\nNeeds the `lookalikes` feature on your workspace. Until it is on, calls answer 404.","operationId":"search.list-lookalike-seeds","parameters":[{"name":"source","in":"query","description":"Required: `customers`, `crm`, `interested`, `replies`, `campaign` or\n`website_visitors`. `crm_won` is still accepted, as `crm` with `stage=won`.","schema":{"type":"string"}},{"name":"stage","in":"query","description":"The deal stage, with `crm` only: `won` (default), `open` (neither won nor lost) or `any`.","schema":{"type":"string"}},{"name":"campaignId","in":"query","description":"The campaign to read. Required with `campaign`, and an optional filter with `interested` and `replies`.","schema":{"type":"integer","format":"int64"}},{"name":"since","in":"query","description":"With `interested`, `replies` and `website_visitors`: a day as `YYYY-MM-DD` (UTC). Only replies\nor visits on or after it count.","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}}},{"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":{"application/json":{"schema":{"$ref":"#/components/schemas/LookalikeSeedListResponse"}}}},"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"]},"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":["permission_denied"]},"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":["rate_limited"]}},"x-ken-features":["lookalikes"],"x-ken-permission":{"kind":"page","page":"accounts","access":"view","additionalPages":[{"page":"search","access":"view"}],"summary":"Accounts view and Search view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/search/imports":{"get":{"tags":["search"],"summary":"List a campaign's latest import","description":"Get the most recent Search import into one campaign, for example to show its progress when you open the campaign.\n            \nThe answer is a list of zero or one import, in the shape `GET /v1/search/imports/{importId}` returns. It\nnever has a next page.\n            \nErrors:\n            \n- `400 validation_failed`: `campaignId` is missing.\n- `401 unauthenticated`: the API key belongs to no member.\n- `404 not_found`: the campaign is not in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"search.list-imports","parameters":[{"name":"campaignId","in":"query","description":"The campaign whose latest import you want. Required.","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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchListResponse"}}}},"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":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}},"post":{"tags":["search"],"summary":"Import people into a campaign","description":"Add Search people to a campaign as contacts. Pick the people by id, or import every match of a people search.\n            \nSend `campaignId` and exactly one of `personIds` or `searchFilters`. `personIds` must not be\nempty. `searchFilters` is a people search body, and Kenso imports its matches up to `limit`. A lookalike\nsearch cannot be imported by its filters: send the people it found as `personIds`. With\n`inLinkedInConnections: true` in `searchFilters`, the import takes only the workspace's LinkedIn\nconnections, and needs the `linkedin_network` or `linkedin_connections_import` feature. To see first\nhow many of the people Kenso already holds an email for, call `POST /v1/search/imports/preview`.\n            \nThe import runs in the background and fills the campaign in batches. The call answers `202` with the import\njob's `jobId` and `status`. Poll `GET /v1/search/imports/{importId}` with that `jobId`.\n            \nOn Kenso Lifetime, the people an import adds count against the license's contacts and its people results for the\nday. When either is already used up, or the license is no longer active, the call refuses at once and starts no\nimport (a license that is not active answers `402 workspace_read_only`, with the refusal code\n`WORKSPACE_READ_ONLY`). Otherwise each\nbatch counts as it is added: when the day's people results run out partway, the import waits and goes on after\n00:00 UTC. When the license's contacts run out, the import stops.\n            \nErrors:\n            \n- `400 validation_failed`: `campaignId` is missing, both or neither of `personIds` and\n`searchFilters` are sent, `personIds` is empty, `searchFilters` is not an object or its\n`inLinkedInConnections` is not a boolean, or `limit` is below 1.\n- `400 lookalike_not_storable`: `searchFilters` carries a lookalike filter.\n- `400 validation_failed`: the workspace is a developer sandbox. A sandbox holds seeded and test data only,\nso search imports are not available in it. Contacts you upload from a CSV file are still imported.\n- `401 unauthenticated`: the API key belongs to no member. An import runs as a member.\n- `402 plan_required`: `searchFilters` holds a funding filter (as on `POST /v1/search/people`) and\nthe workspace's plan does not include funding signals. `error.refusal` carries the code\n`PLAN_FEATURE_NOT_AVAILABLE` and the feature `funding_signals`.\n- `402 plan_limit_reached`: on Kenso Lifetime, the license's contacts or the day's people results are\nalready used up. `error.refusal` carries the code `LIFETIME_CONTACT_LIMIT_REACHED` or\n`LIFETIME_PEOPLE_RESULT_LIMIT_REACHED`; the people results come back at 00:00 UTC.\n- `403 feature_disabled`: `inLinkedInConnections` needs `linkedin_network` or\n`linkedin_connections_import`.\n- `404 not_found`: the campaign is not in this workspace.\n- `503 service_unavailable`: the workspace's LinkedIn connections could not be read. Try again.\n            \nRequires Campaigns edit and the `import` permission, plus Search view.\n\nRate limit: 480 calls a minute per API key, on top of the workspace limits.","operationId":"search.create-import","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/CreateSearchImportRequest"}}}},"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/SearchImportJobResponse"}}}},"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":["lookalike_not_storable","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"]},"402":{"description":"Payment Required","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":["plan_limit_reached","plan_required","workspace_read_only"]},"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":["feature_disabled"]},"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":["rate_limited"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"edit","features":["import"],"additionalPages":[{"page":"search","access":"view"}],"summary":"Campaigns edit and Search view and the `import` permission"},"x-ken-rate-limit":{"limit":480,"windowSeconds":60,"per":"api_key"}}},"/v1/search/imports/preview":{"post":{"tags":["search"],"summary":"Preview an import","description":"See how many people an import would take and how many of them Kenso already holds a verified email for. On a paid\nplan, a person whose email Kenso already holds costs no email find, so use this to estimate an import's cost.\n            \nSend the selection you would send to `POST /v1/search/imports`, without `campaignId`: exactly one of\n`personIds` or `searchFilters`, with `limit` (5,000 when omitted). The answer holds\n`personCount`, `checkedCount` and `kenEmailCount`. Kenso checks at most the first 500 people.\n`inLinkedInConnections: true` in `searchFilters` needs the `linkedin_network` or\n`linkedin_connections_import` feature, as on the import.\n            \nThe preview imports nothing and does not count against `searchBrowseRows`.\n            \nErrors:\n            \n- `400 validation_failed`: both or neither of `personIds` and `searchFilters` are sent,\n`personIds` is empty, `searchFilters` is not an object or its `inLinkedInConnections` is not a\nboolean, or `limit` is below 1.\n- `400 lookalike_not_storable`: `searchFilters` carries a lookalike filter.\n- `402 plan_required`: `searchFilters` holds a funding filter (as on `POST /v1/search/people`) and\nthe workspace's plan does not include funding signals. `error.refusal` carries the code\n`PLAN_FEATURE_NOT_AVAILABLE` and the feature `funding_signals`.\n- `403 feature_disabled`: `inLinkedInConnections` needs `linkedin_network` or\n`linkedin_connections_import`.\n- `503 service_unavailable`: Search could not return every person to check (Kenso fails the preview rather\nthan return a lower count), or the workspace's LinkedIn connections could not be read. Try again.\n            \nRequires Campaigns view, plus Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"search.preview-import","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/PreviewSearchImportRequest"}}}},"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/SearchImportPreviewResponse"}}}},"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":["lookalike_not_storable","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"]},"402":{"description":"Payment Required","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":["plan_required"]},"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":["feature_disabled"]},"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":["rate_limited"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","additionalPages":[{"page":"search","access":"view"}],"summary":"Campaigns view and Search view"},"x-ken-rate-limit":{"limit":200,"windowSeconds":60,"per":"api_key"}}},"/v1/search/imports/{importId}":{"get":{"tags":["search"],"summary":"Get an import","description":"Get the progress of one import into a campaign. Poll it after `POST /v1/search/imports` until the import\nends.\n            \n`status` is `Queued` or `Processing` while the import runs, then a final value such as\n`Ready` or `Failed`. The answer also holds the counts (`totalRecords`, `processedRecords`\nand `importedCount`), the people skipped by reason under `skips`, and `errorMessage` when the\nimport failed.\n            \nErrors:\n            \n- `401 unauthenticated`: the API key belongs to no member.\n- `404 not_found`: no import has this id in this workspace.\n            \nRequires Campaigns view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-import","parameters":[{"name":"importId","in":"path","description":"The import's id, the `jobId` that `POST /v1/search/imports` returned.","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":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchImportResponse"}}}},"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","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":["rate_limited"]}},"x-ken-permission":{"kind":"page","page":"campaigns","access":"view","summary":"Campaigns view"},"x-ken-rate-limit":{"limit":12000,"windowSeconds":60,"per":"api_key"}}},"/v1/search/sample":{"get":{"tags":["search"],"summary":"Get the sample search","description":"Get a ready-made sample search for this workspace. Ken picks one search from the workspace's ideal customer\nprofile (ICP) and runs it for people, companies, job posts and funding, so a new workspace sees real results\nbefore it builds its own search.\n            \nThe call answers at once and never waits for a build. `status` is one of:\n            \n- `ready`: the sample is in the answer. `refreshing` is true while Kenso rebuilds it because the ICP\nchanged or the sample expired.\n- `pending`: there is no sample yet and a build is queued or running. Poll again in about 5 seconds.\n- `unavailable`: the workspace has no ICP context yet, the workspace used its 6 builds of the day with no\nsample to serve, or the last build for this ICP failed. Kenso retries a failed build after 10 minutes when a\nservice was down, and after 6 hours when the search found nothing.\n- `off`: the `search_sample` feature is off for the workspace, and nothing runs.\n            \nA ready sample holds `query`, the filters Ken picked, and four tabs. `profiles` and `companies`\nhold the `request` sent and the `page` that `POST /v1/search/people` or\n`POST /v1/search/companies` returned for it. `jobs` holds the `request` (`jobFilters` and\n`peopleFilters`) and the `companies` and `people` pages the job post searches returned.\n`funding` holds the `request` (`signalType` and `parameters`) and the `page` that\n`POST /v1/triggers/preview` returned. A tab is absent when its search failed or found nothing.\n            \nKenso keeps a sample for 7 days, or 10 minutes when a tab failed during an outage. It rebuilds the sample, at most\n6 times a day, when the workspace's website, company context or ICP knowledge file changes. The sample is free:\nit costs no credits, does not count against `searchBrowseRows`, and never becomes a saved search or list.\n            \nErrors:\n            \n- `503 service_unavailable`: Kenso could not read the sample. Try again.\n            \nRequires Search view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"search.get-sample","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"}}],"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/SearchSampleResourceResponse"}}}},"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","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":["rate_limited"]},"503":{"description":"Service Unavailable","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/ServiceUnavailableError"}}},"x-ken-error-codes":["service_unavailable"]}},"x-ken-permission":{"kind":"page","page":"search","access":"view","summary":"Search view"},"x-ken-rate-limit":{"limit":12000,"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."},"CreateSearchImportRequest":{"type":"object","properties":{"campaignId":{"type":"integer","description":"The campaign in this workspace that receives the people.","format":"int64","nullable":true},"personIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The people to import, by the `kenId` of each people search result.","nullable":true},"searchFilters":{"description":"A people search body, as sent to `POST /v1/search/people`. Imports every match, up to `limit`."},"limit":{"type":"integer","description":"The most people a `searchFilters` import adds.","format":"int32","nullable":true}},"additionalProperties":false,"description":"Body for `POST /v1/search/imports`. Send exactly one of `personIds` and `searchFilters`."},"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."},"JobPostSearchCompanies":{"type":"object","properties":{"companies":{"type":"array","items":{"$ref":"#/components/schemas/JobPostSearchHiringCompany"},"description":"The companies on this page.","nullable":true},"total":{"type":"integer","description":"How many companies are hiring for the job filters in all. With `includeUnmatched` it counts the unmatched ones too.","format":"int64"},"unmatched_total":{"type":"integer","description":"How many of them Ken Search has no company for. Present only with `includeUnmatched`.","format":"int64","nullable":true},"pagination":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchPagination"}],"description":"Where the next page starts."},"hiringSet":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchCompaniesHiringSet"}],"description":"The whole set of hiring companies the people searches run on."}},"additionalProperties":false,"description":"One page of the companies hiring for the job filters, newest posting first."},"JobPostSearchCompaniesHiringSet":{"type":"object","properties":{"total":{"type":"integer","description":"How many Ken Search companies are hiring for the job filters: the companies the people searches cover.","format":"int64"},"truncated":{"type":"boolean","description":"True when more companies matched than the 25,000 the set holds."},"unmatched":{"type":"integer","description":"How many hiring companies Ken Search has no company for. Present only with `includeUnmatched`.","format":"int64","nullable":true}},"additionalProperties":false,"description":"The whole set of companies hiring for the job filters."},"JobPostSearchCompanyTotal":{"type":"object","properties":{"companyId":{"type":"integer","description":"The company's Search id, from `companyIds`.","format":"int64"},"totalResults":{"type":"integer","description":"How many people match at the company.","format":"int64"}},"additionalProperties":false,"description":"One company searched on its own, and how many people match there."},"JobPostSearchHiringCompany":{"type":"object","properties":{"company_id":{"type":"string","description":"The job index's own id of the company, as a string.","nullable":true},"ken_search_id":{"type":"string","description":"The company's Search id, as a string: send it in `companyIds` to search the people there. Null for a company Ken Search has no company for.","nullable":true},"match_status":{"type":"string","description":"`matched` for a Ken Search company, `unmatched` otherwise. Present only with `includeUnmatched`.","nullable":true},"name":{"type":"string","description":"The company's name.","nullable":true},"domain":{"type":"string","description":"The company's domain, such as `acme.com`.","nullable":true},"domain_source":{"type":"string","description":"Where `domain` came from: `ken_search`, `website`, `agent`, `job_post` or `clearbit`. Present only with `includeUnmatched`; null when there is no domain.","nullable":true},"match_count":{"type":"integer","description":"How many of the company's open jobs match the job filters.","format":"int64"},"newest_posted_at":{"type":"string","description":"When the company's newest matching job was posted, or first seen when the posting has no date.","format":"date-time"},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/JobPostSearchHiringJob"},"description":"Up to 5 of the company's newest matching jobs.","nullable":true}},"additionalProperties":false,"description":"A company hiring for the job filters."},"JobPostSearchHiringJob":{"type":"object","properties":{"id":{"type":"string","description":"The job's id, as a string.","nullable":true},"title":{"type":"string","description":"The job title.","nullable":true},"location":{"type":"string","description":"Where the job is, as the posting writes it.","nullable":true},"application_url":{"type":"string","description":"The URL to apply for the job.","nullable":true},"posted_at":{"type":"string","description":"When the job was posted, or first seen when the posting has no date.","format":"date-time"}},"additionalProperties":false,"description":"An open job that matches the job filters."},"JobPostSearchHiringSet":{"type":"object","properties":{"count":{"type":"integer","description":"How many hiring companies the search covered. With `companyIds`, the ones of them in the hiring set.","format":"int32"},"truncated":{"type":"boolean","description":"True when more companies matched the job filters than the 25,000 a hiring set holds."}},"additionalProperties":false,"description":"The companies hiring for the job filters."},"JobPostSearchOpenRole":{"type":"object","properties":{"title":{"type":"string","description":"The posting's job title.","nullable":true},"url":{"type":"string","description":"The posting's URL.","nullable":true},"location":{"type":"string","description":"Where the job is.","nullable":true},"postedAt":{"type":"string","description":"When the job was posted. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"openRoles":{"type":"integer","description":"How many of the company's postings match the job filters.","format":"int32"},"moreRoles":{"type":"integer","description":"How many matching postings the company has besides this one.","format":"int32"}},"additionalProperties":false,"description":"The newest posting that matched the job filters at a company, and how many matched."},"JobPostSearchPagination":{"type":"object","properties":{"next_cursor":{"type":"string","description":"The cursor of the next page: send it back unchanged as `jobFilters.cursor` with the same filters. Null on the last page.","nullable":true}},"additionalProperties":false,"description":"Where the next page of hiring companies starts."},"JobPostSearchPeopleResults":{"type":"object","properties":{"totalResults":{"type":"integer","description":"How many people match in all. With `companyIds`, the companies' totals added up.","format":"int64"},"page":{"type":"integer","description":"The page number, from 1. Absent when no company is hiring.","format":"int32","nullable":true},"pageSize":{"type":"integer","description":"The most people a page holds; with `companyIds`, the most people per company. Absent when no company is hiring.","format":"int32","nullable":true},"searchAfter":{"type":"string","description":"The cursor of the next page: send it back unchanged as `searchAfter` in `peopleFilters`. Null when there is none.","nullable":true},"hasMore":{"type":"boolean","description":"True when more people match after this page."},"results":{"type":"array","items":{"$ref":"#/components/schemas/JobPostSearchPerson"},"description":"The people on this page. With `companyIds`, each company's people in the order of `companyIds`.","nullable":true},"facets":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPeopleFacets"}],"description":"Always null here: the people search does not count filter values.","nullable":true},"dataAsOf":{"type":"string","description":"The date of the newest profile check in the index, as `yyyy-MM-dd`.","nullable":true},"lookalikeSeeds":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPeopleLookalikeSeeds"}],"description":"How each lookalike seed resolved. Present only when `peopleFilters` holds a lookalike filter.","nullable":true},"hiringSet":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchHiringSet"}],"description":"The hiring companies the search covered."},"companies":{"type":"array","items":{"$ref":"#/components/schemas/JobPostSearchCompanyTotal"},"description":"Each company searched, with its own total. Present only when the body sends `companyIds`.","nullable":true}},"additionalProperties":false,"description":"One page of people at the companies hiring for the job filters."},"JobPostSearchPerson":{"type":"object","properties":{"kenId":{"type":"integer","description":"The person's Search id. Send it as `personId` to get the person again.","format":"int64"},"fullName":{"type":"string","description":"The person's full name.","nullable":true},"firstName":{"type":"string","description":"The person's first name.","nullable":true},"lastName":{"type":"string","description":"The person's last name.","nullable":true},"headline":{"type":"string","description":"The headline of the person's LinkedIn profile.","nullable":true},"summary":{"type":"string","description":"The about text of the person's profile.","nullable":true},"location":{"type":"string","description":"Where the person is, as their profile writes it.","nullable":true},"city":{"type":"string","description":"The person's city.","nullable":true},"state":{"type":"string","description":"The person's state or region.","nullable":true},"country":{"type":"string","description":"The person's country.","nullable":true},"countryIso2":{"type":"string","description":"The person's country as an ISO 3166-1 alpha-2 code, such as `US`.","nullable":true},"countryIso3":{"type":"string","description":"The person's country as an ISO 3166-1 alpha-3 code, such as `USA`.","nullable":true},"industry":{"type":"string","description":"The industry the person works in.","nullable":true},"linkedInUrl":{"type":"string","description":"The person's LinkedIn profile URL.","nullable":true},"profilePhotoUrl":{"type":"string","description":"The URL of the person's profile photo.","nullable":true},"publicProfileId":{"type":"string","description":"The id of the person's public LinkedIn profile.","nullable":true},"shorthandName":{"type":"string","description":"The person's LinkedIn handle, the part of the profile URL after `/in/`.","nullable":true},"canonicalShorthandName":{"type":"string","description":"The canonical form of `shorthandName`.","nullable":true},"services":{"type":"string","description":"The services the person offers on their profile, as one text.","nullable":true},"connectionsCount":{"type":"integer","description":"How many LinkedIn connections the person has.","format":"int32","nullable":true},"followerCount":{"type":"integer","description":"How many LinkedIn followers the person has.","format":"int32","nullable":true},"recommendationsCount":{"type":"integer","description":"How many recommendations the person's profile holds.","format":"int32","nullable":true},"experienceCount":{"type":"integer","description":"How many positions the person's work history lists.","format":"int32","nullable":true},"currentTitle":{"type":"string","description":"The person's current job title.","nullable":true},"currentCompanyName":{"type":"string","description":"The name of the person's current company.","nullable":true},"currentCompanyId":{"type":"integer","description":"The Search id of the person's current company: the `kenId` of a company search result.","format":"int64","nullable":true},"headquartersCountry":{"type":"string","description":"The country of the current company's headquarters.","nullable":true},"headquartersCity":{"type":"string","description":"The city of the current company's headquarters.","nullable":true},"headquartersState":{"type":"string","description":"The state or region of the current company's headquarters.","nullable":true},"headquartersCountryIso2":{"type":"string","description":"The country of the current company's headquarters as an ISO 3166-1 alpha-2 code.","nullable":true},"employeesCount":{"type":"integer","description":"How many employees the current company has.","format":"int32","nullable":true},"companyType":{"type":"string","description":"The current company's type, such as `Privately Held`.","nullable":true},"companySize":{"type":"string","description":"The current company's employee range, such as `51-200`.","nullable":true},"companyDomain":{"type":"string","description":"The current company's website domain.","nullable":true},"companyLinkedInUrl":{"type":"string","description":"The current company's LinkedIn page URL.","nullable":true},"companyDescription":{"type":"string","description":"The current company's description.","nullable":true},"companyLogoUrl":{"type":"string","description":"The URL of the current company's logo.","nullable":true},"companyFounded":{"type":"integer","description":"The year the current company was founded.","format":"int32","nullable":true},"companyFollowers":{"type":"integer","description":"How many LinkedIn followers the current company has.","format":"int32","nullable":true},"companyTotalFunding":{"type":"integer","description":"The current company's total funding as listed on its profile, in whole US dollars.","format":"int64","nullable":true},"companyLastFundingRoundType":{"type":"string","description":"The type of the current company's last funding round, such as `Series A`.","nullable":true},"companyLastFundingAmount":{"type":"integer","description":"The amount of the current company's last funding round, in whole US dollars.","format":"int64","nullable":true},"companyFundingTotalUsd":{"type":"integer","description":"The current company's total funding raised, in whole US dollars.","format":"int64","nullable":true},"companyLastFundedAt":{"type":"string","description":"The date of the current company's latest funding round, as `yyyy-MM-dd`.","nullable":true},"companySpecialties":{"type":"array","items":{"type":"string"},"description":"The current company's specialties.","nullable":true},"companyWebTechnologies":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonWebTechnology"},"description":"The web technologies the current company uses. Null when the web technology filters are off or it has none.","nullable":true},"seniorityLevel":{"type":"string","description":"The seniority of the person's current role, such as `Director` or `CLevel`.","nullable":true},"seniorityConfidence":{"type":"number","description":"How sure Kenso is of `seniorityLevel`, from 0 to 1. Absent with `view=summary`.","format":"double","nullable":true},"function":{"type":"string","description":"The function of the person's current role, such as `Sales` or `Engineering`.","nullable":true},"isDecisionMaker":{"type":"boolean","description":"True when the person's seniority is Director, VP, CLevel, Partner or Owner."},"yearsOfExperience":{"type":"number","description":"The person's years of work experience.","format":"double","nullable":true},"yearsInCurrentRole":{"type":"number","description":"The years the person has held their current role.","format":"double","nullable":true},"yearsInCurrentCompany":{"type":"number","description":"The years the person has worked at their current company.","format":"double","nullable":true},"skills":{"type":"array","items":{"type":"string"},"description":"The skills on the person's profile.","nullable":true},"languages":{"type":"array","items":{"type":"string"},"description":"The languages the person speaks.","nullable":true},"regions":{"type":"array","items":{"type":"string"},"description":"The regions the person's location belongs to.","nullable":true},"certifications":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonCertification"},"description":"The person's certifications.","nullable":true},"changedJobRecently":{"type":"boolean","description":"True when the person started at a new company within the last 90 days, after leaving another."},"newInSeat":{"type":"boolean","description":"True when the person joined their current company within the last 90 days, or the search's window."},"newInRole":{"type":"boolean","description":"True when the person started their current role within the last 90 days, or the search's window."},"tenureRipe":{"type":"boolean","description":"True when the person has held their current role for 3.5 years or more, or the search's threshold."},"jobChangeDate":{"type":"string","description":"When the person started at their new company, set with `changedJobRecently`. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"titleChangedRecently":{"type":"boolean","description":"True when the person's job title changed recently."},"promoted":{"type":"boolean","description":"True when the person's recent title change was a promotion."},"seniorityIncreased":{"type":"boolean","description":"True when the person's seniority went up with their recent title change."},"previousTitle":{"type":"string","description":"The person's job title before their recent title change.","nullable":true},"previousSeniorityLevel":{"type":"string","description":"The person's seniority before their recent title change.","nullable":true},"titleChangeDetectedMonth":{"type":"string","description":"The month Kenso saw the person's title change, as the first day of that month. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"previousCompanyName":{"type":"string","description":"The company the person worked at before their recent company change.","nullable":true},"jobChangeDetectedMonth":{"type":"string","description":"The month Kenso saw the person's company change, as the first day of that month. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"createdAt":{"type":"string","description":"When the profile was first added to the index. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"checkedAt":{"type":"string","description":"When the profile was last checked. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"experience":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonExperience"},"description":"The person's work history, current positions first, then newest first.","nullable":true},"education":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonEducation"},"description":"The person's education.","nullable":true},"awards":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonAward"},"description":"The person's awards.","nullable":true},"organizations":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonOrganization"},"description":"The organizations the person belongs to.","nullable":true},"recommendations":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonRecommendation"},"description":"The recommendations others wrote for the person.","nullable":true},"publications":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonPublication"},"description":"The person's publications.","nullable":true},"patents":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonPatent"},"description":"The person's patents.","nullable":true},"volunteering":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonVolunteering"},"description":"The person's volunteering roles.","nullable":true},"websites":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonWebsite"},"description":"The websites on the person's profile.","nullable":true},"activity":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonActivity"},"description":"The person's recent LinkedIn activity.","nullable":true},"courseSuggestions":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonCourseSuggestion"},"description":"The courses LinkedIn suggests on the person's profile.","nullable":true},"similarProfiles":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonSimilarProfile"},"description":"Profiles LinkedIn shows as similar to this one.","nullable":true},"alsoViewed":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonSimilarProfile"},"description":"Profiles that people who viewed this one also viewed.","nullable":true},"othersNamed":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonSimilarProfile"},"description":"Other profiles with the same name.","nullable":true},"courses":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonCourse"},"description":"The courses the person took.","nullable":true},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonGroup"},"description":"The LinkedIn groups the person belongs to.","nullable":true},"interests":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonInterest"},"description":"The person's interests.","nullable":true},"projects":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonProject"},"description":"The person's projects.","nullable":true},"testScores":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonTestScore"},"description":"The person's test scores.","nullable":true},"hiddenDetails":{"type":"array","items":{"type":"string"},"description":"The names of the profile details the person hides.","nullable":true},"volunteeringCares":{"type":"array","items":{"type":"string"},"description":"The causes the person cares about, from the volunteering section of their profile.","nullable":true},"volunteeringOpportunities":{"type":"array","items":{"type":"string"},"description":"The volunteering opportunities the person is open to.","nullable":true},"volunteeringSupports":{"type":"array","items":{"type":"string"},"description":"The organizations the person supports, from the volunteering section of their profile.","nullable":true},"postsSeeMoreUrls":{"type":"array","items":{"type":"string"},"description":"Links to more of the person's posts.","nullable":true},"relevanceScore":{"type":"number","description":"How well the person matches the search, higher first. 0 when the answer is not a search.","format":"double"},"lookalike":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPersonLookalikeMatch"}],"description":"How much the person's current company looks like the lookalike seeds. Present only on a lookalike search.","nullable":true},"matchedCurrentRole":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPersonMatchedRole"}],"description":"The current role that matched a title search when `currentTitle` does not. Present only on a title search.","nullable":true},"jobPost":{"type":"object","allOf":[{"$ref":"#/components/schemas/JobPostSearchOpenRole"}],"description":"The role the person's company is hiring for. Null when the company is not in the hiring set.","nullable":true}},"additionalProperties":false,"description":"A person at a company that is hiring."},"LookalikeSeed":{"type":"object","properties":{"domain":{"type":"string","description":"The company's domain, such as `acme.com`. Send it as a `{\"domain\": ...}` seed."},"name":{"type":"string","description":"The company's name as the workspace knows it. Omitted when unknown.","nullable":true},"count":{"type":"integer","description":"How strongly the source ties the company to you: deals at the stage asked for (`crm`, `crm_won`),\ncontacts marked Interested (`interested`), contacts who replied (`replies`), the campaign's contacts at\nthe company (`campaign`), visits (`website_visitors`), or customer accounts with the domain, normally 1\n(`customers`).","format":"int32"}},"additionalProperties":false,"description":"One company to suggest as a lookalike seed."},"LookalikeSeedListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"True when the call succeeded."},"data":{"type":"array","items":{"$ref":"#/components/schemas/LookalikeSeed"},"description":"The suggested companies."},"pagination":{"allOf":[{"$ref":"#/components/schemas/SearchListPagination"}],"description":"Paging state. The list never has a next page."}},"additionalProperties":false,"description":"Every lookalike seed suggestion, up to 200, in one page. `pagination.hasMore` is always false and\n`pagination.nextCursor` is always null."},"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."},"PreviewSearchImportRequest":{"type":"object","properties":{"personIds":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The people the import would take, by the `kenId` of each people search result.","nullable":true},"searchFilters":{"description":"A people search body, as sent to `POST /v1/search/people`. Previews its matches up to `limit`."},"limit":{"type":"integer","description":"The most people a `searchFilters` import would add. Default 5,000.","format":"int32","nullable":true}},"additionalProperties":false,"description":"Body for `POST /v1/search/imports/preview`: the selection an import would send, without the campaign. Send\nexactly one of `personIds` and `searchFilters`."},"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."},"SearchCompaniesResults":{"type":"object","properties":{"totalResults":{"type":"integer","description":"How many companies match the search in all.","format":"int64"},"page":{"type":"integer","description":"The page number, from 1.","format":"int32"},"pageSize":{"type":"integer","description":"The most companies a page holds.","format":"int32"},"searchAfter":{"type":"string","description":"The cursor of the next page: send it back unchanged as `searchAfter`. Null when there is none.","nullable":true},"hasMore":{"type":"boolean","description":"True when more companies match after this page."},"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchCompany"},"description":"The companies on this page.","nullable":true},"facets":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchCompanyFacets"}],"description":"Always null here: `POST /v1/search/companies/facets` counts the filter values.","nullable":true},"lookalikeSeeds":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPeopleLookalikeSeeds"}],"description":"How each lookalike seed resolved. Present only on a lookalike search.","nullable":true}},"additionalProperties":false,"description":"One page of a company search."},"SearchCompaniesResultsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchCompaniesResults"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchCompany":{"type":"object","properties":{"kenId":{"type":"integer","description":"The company's Search id. Send it as `companyId` to get the company again.","format":"int64"},"name":{"type":"string","description":"The company's name.","nullable":true},"website":{"type":"string","description":"The company's website URL.","nullable":true},"domain":{"type":"string","description":"The company's website domain, such as `acme.com`.","nullable":true},"industry":{"type":"string","description":"The company's industry.","nullable":true},"size":{"type":"string","description":"The company's size band by employee count, such as `51-200`, as the `companySizes` filter takes it.","nullable":true},"employeesCount":{"type":"integer","description":"How many employees the company has.","format":"int32","nullable":true},"crossedSizeBandUp":{"type":"boolean","description":"True when the company moved up into a bigger size band in the latest data delivery."},"enteredSizeBand":{"type":"string","description":"The size band the company moved up into. Null when `crossedSizeBandUp` is false.","nullable":true},"headcountDeclined":{"type":"boolean","description":"True when the company's headcount dropped in the latest data delivery."},"headcountDeclineAbs":{"type":"integer","description":"How many employees the company lost.","format":"int32","nullable":true},"headcountDeclinePct":{"type":"number","description":"The headcount drop as a percentage of the earlier count, from 0 to 100.","format":"double","nullable":true},"headcountDeclineMonth":{"type":"string","description":"The month Kenso saw the drop, as `yyyy-MM`.","nullable":true},"description":{"type":"string","description":"The company's description.","nullable":true},"type":{"type":"string","description":"The company type, as the `companyTypes` filter takes it.","nullable":true},"founded":{"type":"integer","description":"The year the company was founded.","format":"int32","nullable":true},"linkedInUrl":{"type":"string","description":"The company's LinkedIn page URL.","nullable":true},"logoUrl":{"type":"string","description":"The URL of the company's logo.","nullable":true},"followers":{"type":"integer","description":"How many people follow the company on LinkedIn.","format":"int32","nullable":true},"headquartersLocation":{"type":"string","description":"The headquarters as `city, state, country`, leaving out the parts Kenso does not know.","nullable":true},"headquartersCountry":{"type":"string","description":"The country of the headquarters.","nullable":true},"headquartersCity":{"type":"string","description":"The city of the headquarters.","nullable":true},"headquartersState":{"type":"string","description":"The state or region of the headquarters.","nullable":true},"headquartersCountryIso2":{"type":"string","description":"The country of the headquarters as an ISO 3166-1 alpha-2 code, such as `US`.","nullable":true},"locations":{"type":"array","items":{"$ref":"#/components/schemas/SearchCompanyLocation"},"description":"The company's offices.","nullable":true},"specialties":{"type":"array","items":{"type":"string"},"description":"The company's specialties.","nullable":true},"lastFundingRoundType":{"type":"string","description":"The type of the company's last funding round, such as `Series A`.","nullable":true},"lastFundingAmount":{"type":"integer","description":"The amount raised in the last funding round, in USD.","format":"int64","nullable":true},"lastFundingRoundAnnouncedDate":{"type":"string","description":"When the last funding round was announced. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"raisedFundingRecently":{"type":"boolean","description":"True when the company's latest raise is within the search's `raisedFundingWithinDays`, 180 by default."},"totalFunding":{"type":"integer","description":"The total funding raised, in USD, as the data vendor reports it.","format":"int64","nullable":true},"fundingTotalUsd":{"type":"integer","description":"The total funding raised, in whole USD: the larger of the known totals. The funding filters match on it.","format":"int64","nullable":true},"lastFundedAt":{"type":"string","description":"The date of the latest funding raise, as `yyyy-MM-dd`.","nullable":true},"totalRoundsCount":{"type":"integer","description":"How many funding rounds the company has had.","format":"int32","nullable":true},"lastRoundInvestorsCount":{"type":"integer","description":"How many investors took part in the last funding round.","format":"int32","nullable":true},"fundingRounds":{"type":"array","items":{"$ref":"#/components/schemas/SearchCompanyFundingRound"},"description":"The company's funding rounds.","nullable":true},"similarCompanies":{"type":"array","items":{"type":"integer","format":"int64"},"description":"The Search ids of similar companies.","nullable":true},"leadershipChanges":{"type":"array","items":{"$ref":"#/components/schemas/SearchCompanyLeadershipChange"},"description":"The leadership changes that match the search's `leadershipChange` filter, newest first. Null without that filter.","nullable":true},"hiringSurges":{"type":"array","items":{"$ref":"#/components/schemas/SearchCompanyHiringSurge"},"description":"The job functions whose headcount grew, by month.","nullable":true},"headcountGrew":{"type":"boolean","description":"True when the company's headcount grew in the latest data delivery."},"employeesCountPrevious":{"type":"integer","description":"The headcount before the growth.","format":"int32","nullable":true},"headcountGrowthAbs":{"type":"integer","description":"How many employees the company added.","format":"int32","nullable":true},"headcountGrowthPct":{"type":"number","description":"The headcount growth as a percentage of the earlier count, such as `12.5`.","format":"double","nullable":true},"headcountGrowthDetectedAt":{"type":"string","description":"When Kenso saw the growth. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"headcountGrowthMonth":{"type":"string","description":"The month Kenso saw the growth, as `yyyy-MM`.","nullable":true},"webTechnologies":{"type":"array","items":{"$ref":"#/components/schemas/SearchCompanyWebTechnology"},"description":"The web technologies Kenso found for the company's domain. Null when it has none, or while the technology filters are off.","nullable":true},"relevanceScore":{"type":"number","description":"How well the company matches the search; higher is better. 0 outside a ranked search.","format":"double"},"lookalike":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPersonLookalikeMatch"}],"description":"How much the company looks like the lookalike seeds. Present only on a lookalike search.","nullable":true}},"additionalProperties":false,"description":"A company in Kenso's company index, with its firmographics, funding and change signals."},"SearchCompanyFacets":{"type":"object","properties":{"industries":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by industry.","nullable":true},"seniorityLevels":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"Always null for companies: only people facets count seniority levels.","nullable":true},"functions":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"Always null for companies: only people facets count job functions.","nullable":true},"countries":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by headquarters country, with each country as an ISO 3166-1 alpha-2 code such as `US`.","nullable":true},"states":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"Always null for companies: only people facets count states.","nullable":true},"cities":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"Always null for companies: only people facets count cities.","nullable":true},"companyTypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by company type.","nullable":true},"companySizes":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by company size.","nullable":true},"fundingRoundTypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by the type of the company's last funding round.","nullable":true},"webTech":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by web technology, with each technology's display name as `label`. Null while the technology filters are off.","nullable":true},"webTechCategories":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by web technology category, with each category's display name as `label`. Null while the technology filters are off.","nullable":true}},"additionalProperties":false,"description":"How many companies match each value of the main filters, most first."},"SearchCompanyFacetsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchCompanyFacets"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchCompanyFundingRound":{"type":"object","properties":{"roundType":{"type":"string","description":"The round type, such as `Series A`.","nullable":true},"moneyRaised":{"type":"integer","description":"The amount raised, in USD.","format":"int64","nullable":true},"announcedDate":{"type":"string","description":"When the round was announced. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"One funding round of a company."},"SearchCompanyHiringSurge":{"type":"object","properties":{"function":{"type":"string","description":"The job function, as the `hiringSurge.functions` filter takes it.","nullable":true},"snapshotMonth":{"type":"string","description":"The month of the headcount snapshot, as its first day. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"currentHeadcount":{"type":"integer","description":"The function's headcount at the snapshot.","format":"int32"},"previousHeadcount":{"type":"integer","description":"The function's headcount before it.","format":"int32"},"netAdds":{"type":"integer","description":"How many people the function gained.","format":"int32"},"growthPercent":{"type":"number","description":"The growth as a percentage of the earlier headcount. Null when the earlier headcount was 0.","format":"double","nullable":true}},"additionalProperties":false,"description":"A job function whose headcount grew at a company over one month."},"SearchCompanyLeadershipChange":{"type":"object","properties":{"type":{"type":"string","description":"`GainedLeader` when leaders joined the company, `LostLeader` when they left it.","nullable":true},"seniorityLevel":{"type":"string","description":"The leaders' seniority level, as the `leadershipChange.seniorityLevels` filter takes it.","nullable":true},"detectedMonth":{"type":"string","description":"The month of the change, as its first day. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"count":{"type":"integer","description":"How many leaders joined or left.","format":"int32"}},"additionalProperties":false,"description":"The leaders a company gained or lost in one month, at one seniority level."},"SearchCompanyLocation":{"type":"object","properties":{"country":{"type":"string","description":"The office's country.","nullable":true},"city":{"type":"string","description":"The office's city.","nullable":true},"state":{"type":"string","description":"The office's state or region.","nullable":true},"isHeadquarters":{"type":"boolean","description":"True for the headquarters."}},"additionalProperties":false,"description":"One of a company's offices."},"SearchCompanyResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchCompany"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchCompanyWebTechnology":{"type":"object","properties":{"key":{"type":"string","description":"The technology's key, as the `webTechAny`, `webTechAll` and `webTechExclude` filters take it.","nullable":true},"name":{"type":"string","description":"The technology's display name.","nullable":true},"categories":{"type":"array","items":{"type":"string"},"description":"The display names of the technology's categories.","nullable":true}},"additionalProperties":false,"description":"A web technology Kenso found for a company's domain."},"SearchFilterBucket":{"type":"object","properties":{"value":{"type":"string","description":"The value to send in the filter.","nullable":true},"count":{"type":"integer","description":"How many profiles hold this value.","format":"int64"},"label":{"type":"string","description":"The value's display name when the value is a key. Null when the value is its own name.","nullable":true}},"additionalProperties":false,"description":"One filter value with how many profiles hold it."},"SearchFilterCatalog":{"type":"object","properties":{"seniorityLevels":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The seniority levels a person can have, in display order.","nullable":true},"functions":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The job functions a person can work in, in display order.","nullable":true},"companyHeadcountRanges":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The company headcount ranges, in display order.","nullable":true},"companyTypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The company types, in display order.","nullable":true},"yearsOfExperienceRanges":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The ranges of a person's total years of experience.","nullable":true},"yearsInCurrentRoleRanges":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The ranges of years a person has held their current role.","nullable":true},"yearsInCurrentCompanyRanges":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The ranges of years a person has worked at their current company.","nullable":true},"sortByOptions":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The sort orders a people search accepts.","nullable":true},"industries":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The industries, with `parentValue` naming the top-level industry a sub-industry belongs to.","nullable":true},"languages":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The most common languages people speak, at most 100, most common first. Page through every language with\n`GET /v1/search/metadata?category=language`.","nullable":true},"locationHierarchy":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterLocation"},"description":"The locations to filter by: every country as a top-level node, then the continents, each with its regions and\ntheir countries.","nullable":true},"countries":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterBucket"},"description":"The countries people live in, with how many people live in each. Empty from `GET /v1/search/filters`, which\ndoes not count.","nullable":true},"states":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterBucket"},"description":"The states and provinces people live in, with how many people live in each. Empty from\n`GET /v1/search/filters`, which does not count.","nullable":true},"annualRevenueRanges":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The annual revenue ranges a company search filters by.","nullable":true},"fundingRoundTypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The funding round types a company search filters by.","nullable":true},"accountSortByOptions":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The sort orders a company search accepts.","nullable":true},"companySizes":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterBucket"},"description":"The company size values, with how many companies have each. Empty from `GET /v1/search/filters`, which does\nnot count.","nullable":true}},"additionalProperties":false,"description":"The values the people and company search filters accept, one list per filter."},"SearchFilterCatalogResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchFilterCatalog"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchFilterLocation":{"type":"object","properties":{"type":{"type":"string","description":"The kind of place: `continent`, `region` or `country`.","nullable":true},"value":{"type":"string","description":"The value to send in a location filter.","nullable":true},"label":{"type":"string","description":"The place's display name.","nullable":true},"children":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterLocation"},"description":"The places inside this one: a continent's regions, a region's countries. Empty for a country.","nullable":true}},"additionalProperties":false,"description":"One node of the location tree."},"SearchFilterOption":{"type":"object","properties":{"value":{"type":"string","description":"The value to send in the filter.","nullable":true},"label":{"type":"string","description":"The value's display name.","nullable":true},"count":{"type":"integer","description":"How many profiles in the index hold this value. Null when Kenso has no count for it.","format":"int64","nullable":true},"employeesCount":{"type":"integer","description":"For a company name value, the company's employee count. Null for every other value.","format":"int64","nullable":true},"type":{"type":"string","description":"For a technology value, the name of its first technology category. Null for every other value.","nullable":true},"parentValue":{"type":"string","description":"The value of the group this value belongs to, such as a sub-industry's top-level industry. Null otherwise.","nullable":true}},"additionalProperties":false,"description":"One value a search filter accepts."},"SearchImport":{"type":"object","properties":{"jobId":{"type":"integer","description":"The import's id.","format":"int64"},"status":{"type":"string","description":"`Queued` or `Processing` while the import runs, then `Ready`, `CompletedWithErrors`,\n`Failed` or `Expired`.","nullable":true},"totalRecords":{"type":"integer","description":"The number of people the import aims to add.","format":"int32"},"processedRecords":{"type":"integer","description":"The number of people the campaign has accepted so far, before the final duplicate check.","format":"int32"},"downloadUrl":{"type":"string","description":"A campaign import has no file to download, so this is always null.","nullable":true},"errorMessage":{"type":"string","description":"Why the import failed, when it did. Null otherwise.","nullable":true},"campaignImport":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchImportProgress"}],"description":"How the import is filling the campaign, batch by batch. Null before its first progress update.","nullable":true},"createdAt":{"type":"string","description":"When the import was created, in UTC. ISO 8601, such as `2026-11-15T10:00:00`, with or without a trailing\n`Z`.","nullable":true},"completedAt":{"type":"string","description":"When the import ended, in UTC. ISO 8601, such as `2026-11-15T10:00:00`, with or without a trailing `Z`.\nNull while it runs.","nullable":true},"phase":{"type":"string","description":"The step the import is on: `Queued`, `Importing`, `Enriching` or `Deduping`. Null once it\nends.","nullable":true},"importRunId":{"type":"integer","description":"The id of the Kenso import run that records this import's contacts, once known. Null before.","format":"int64","nullable":true},"importedCount":{"type":"integer","description":"The contacts this import added to the campaign after removing duplicates. Null until known.","format":"int32","nullable":true},"targetCount":{"type":"integer","description":"The number of people you asked the import to take (the import's `limit`). Null until known.","format":"int32","nullable":true},"attemptedCount":{"type":"integer","description":"The number of people the import tried to add. Null until known.","format":"int32","nullable":true},"unfilledCount":{"type":"integer","description":"How many people short of `targetCount` the import ended, because the search had no more matches. Null until\nknown.","format":"int32","nullable":true},"skips":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchImportSkips"}],"description":"The people the import skipped, counted by reason. Null until known.","nullable":true},"recentlyContactedWindowDays":{"type":"integer","description":"The window, in days, in which a person counts as already contacted. Null when the import does not skip people\nfor recent contact.","format":"int32","nullable":true}},"additionalProperties":false,"description":"The progress of one Search import into a campaign."},"SearchImportBatch":{"type":"object","properties":{"round":{"type":"integer","description":"The search round the batch belongs to.","format":"int32"},"batchNumber":{"type":"integer","description":"The batch's number, from 1.","format":"int32"},"candidateCount":{"type":"integer","description":"The number of people in the batch.","format":"int32"},"imported":{"type":"integer","description":"The number of the batch's people the campaign accepted.","format":"int32"},"skippedDuplicate":{"type":"integer","description":"The number of the batch's people the campaign rejected as duplicates.","format":"int32"},"success":{"type":"boolean","description":"True when the campaign took the batch."},"attempts":{"type":"integer","description":"How many times the import sent the batch.","format":"int32"},"errorMessage":{"type":"string","description":"Why the batch failed, when it did. Null otherwise.","nullable":true}},"additionalProperties":false,"description":"One batch of people a Search import sent to its campaign."},"SearchImportJob":{"type":"object","properties":{"jobId":{"type":"integer","description":"The import's id. Send it as `importId` to `GET /v1/search/imports/{importId}`.","format":"int64"},"status":{"type":"string","description":"The import's status when it starts: `Queued`.","nullable":true}},"additionalProperties":false,"description":"The import job a create started. Poll `GET /v1/search/imports/{importId}` with its `jobId`."},"SearchImportJobResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchImportJob"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchImportPreview":{"type":"object","properties":{"personCount":{"type":"integer","description":"People the import would take: the distinct `personIds` (at most 5,000, the import's cap for picks), or the\nfilter's matches up to `limit` (5,000 when absent).","format":"int64"},"checkedCount":{"type":"integer","description":"People checked against Kenso's emails: at most the first 500, in import order.","format":"int32"},"kenEmailCount":{"type":"integer","description":"Of the checked people, how many Kenso already holds a verified email for.","format":"int32"}},"additionalProperties":false,"description":"How many people a Search import would take, and how many of them Kenso already holds an email for. On a paid plan,\nan email Kenso already holds costs no email find. Kenso checks at most the first 500 people, so\n`checkedCount` is below `personCount` for a larger selection, or when picked people are no longer in\nSearch."},"SearchImportPreviewResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchImportPreview"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchImportProgress":{"type":"object","properties":{"requestedTarget":{"type":"integer","description":"The number of people the import aims to add.","format":"int32"},"totalImported":{"type":"integer","description":"The number of people the campaign accepted so far.","format":"int32"},"totalSkippedDuplicate":{"type":"integer","description":"The number of people the campaign rejected as duplicates after a batch was sent.","format":"int32"},"totalSkippedAlreadyInCampaign":{"type":"integer","description":"The number of people passed over because they were already in the campaign.","format":"int32"},"totalCandidatesAttempted":{"type":"integer","description":"The number of people the import has tried so far.","format":"int32"},"exhausted":{"type":"boolean","description":"True when the search ran out of matches before the import reached its target."},"stopReason":{"type":"string","description":"Why the import stopped filling: `target-reached`, `search-exhausted`, `safety-cap` or\n`backend-failed`. Null while it fills.","nullable":true},"roundsCompleted":{"type":"integer","description":"The number of search rounds the import has finished.","format":"int32"},"batches":{"type":"array","items":{"$ref":"#/components/schemas/SearchImportBatch"},"description":"Each batch of people the import sent to the campaign, in order.","nullable":true},"storeBusyRetries":{"type":"integer","description":"How many times the import waited and retried because the search index was busy. Null when it never did.","format":"int32","nullable":true},"phase":{"type":"string","description":"The step the import is on: `Queued`, `Importing`, `Enriching` or `Deduping`. Null once it\nends.","nullable":true},"importRunId":{"type":"integer","description":"The id of the Kenso import run that records this import's contacts, once known. Null before.","format":"int64","nullable":true},"importedCount":{"type":"integer","description":"The contacts this import added to the campaign after removing duplicates. Null until known.","format":"int32","nullable":true},"targetCount":{"type":"integer","description":"The number of people you asked the import to take. Null until known.","format":"int32","nullable":true},"attemptedCount":{"type":"integer","description":"The number of people the import tried to add. Null until known.","format":"int32","nullable":true},"unfilledCount":{"type":"integer","description":"How many people short of `targetCount` the import ended. Null until known.","format":"int32","nullable":true},"skips":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchImportSkips"}],"description":"The people the import skipped, counted by reason. Null until known.","nullable":true},"recentlyContactedWindowDays":{"type":"integer","description":"The window, in days, in which a person counts as already contacted. Null when the import does not use one.","format":"int32","nullable":true}},"additionalProperties":false,"description":"How a Search import is filling its campaign."},"SearchImportResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchImport"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchImportSkips":{"type":"object","properties":{"failedValidation":{"type":"integer","description":"People skipped because their data did not pass validation.","format":"int32"},"alreadyContacted":{"type":"integer","description":"People skipped because the workspace contacted them recently.","format":"int32"},"duplicateInCampaign":{"type":"integer","description":"People skipped because they are already in the campaign.","format":"int32"},"duplicateInSource":{"type":"integer","description":"People skipped because they appear more than once in the import.","format":"int32"},"duplicateInOtherCampaign":{"type":"integer","description":"People skipped because they are already in another campaign.","format":"int32"},"blocklist":{"type":"integer","description":"People skipped because the workspace's blocklist holds them.","format":"int32"},"other":{"type":"integer","description":"People skipped for any other reason.","format":"int32"}},"additionalProperties":false,"description":"The people a Search import skipped, counted by reason."},"SearchIndustryExpansion":{"type":"object","properties":{"expandedIndustries":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Each industry you sent, mapped to the related industries a search can add.","nullable":true},"error":{"type":"string","description":"Why the expansion failed, when it failed entirely. Null or absent when it worked, even in part.","nullable":true}},"additionalProperties":false,"description":"The industries related to each industry you sent."},"SearchIndustryExpansionResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchIndustryExpansion"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchListPagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send it as `cursor` to get the next page. Null on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when there is a next page."},"totalCount":{"type":"integer","description":"The total number of matches. Present only when you send `includeTotal=true` and Search knows it.","format":"int64","nullable":true}},"additionalProperties":false,"description":"Paging state for a Search list."},"SearchListResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"True when the call succeeded."},"data":{"type":"array","items":{},"description":"The items on this page."},"pagination":{"allOf":[{"$ref":"#/components/schemas/SearchListPagination"}],"description":"Paging state for the next page."}},"additionalProperties":false,"description":"One page of a Search list."},"SearchMetadataValuesResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchFilterOption"},"description":"The category's values on this page.","nullable":true},"pagination":{"allOf":[{"$ref":"#/components/schemas/SearchListPagination"}],"description":"Where this page ends and how to get the next one."}},"additionalProperties":false,"description":"One page of the values of one search filter category."},"SearchPeopleFacetBucket":{"type":"object","properties":{"value":{"type":"string","description":"The filter value, as the filter takes it.","nullable":true},"count":{"type":"integer","description":"How many results carry the value.","format":"int64"},"label":{"type":"string","description":"The display name when the value is a key, as on the web technology facets. Null otherwise.","nullable":true}},"additionalProperties":false,"description":"One filter value and how many results carry it."},"SearchPeopleFacets":{"type":"object","properties":{"industries":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by industry.","nullable":true},"seniorityLevels":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by seniority level.","nullable":true},"functions":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by job function.","nullable":true},"countries":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by country.","nullable":true},"states":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by state or region.","nullable":true},"cities":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by city.","nullable":true},"companyTypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by company type.","nullable":true},"companySizes":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by company size.","nullable":true},"fundingRoundTypes":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"The counts by the type of the company's last funding round.","nullable":true},"webTech":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"Always null for people: only company facets count web technologies.","nullable":true},"webTechCategories":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleFacetBucket"},"description":"Always null for people: only company facets count web technology categories.","nullable":true}},"additionalProperties":false,"description":"How many people match each value of the main filters, most first."},"SearchPeopleFacetsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchPeopleFacets"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchPeopleLookalikeSeeds":{"type":"object","properties":{"resolved":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleResolvedSeed"},"description":"The seeds Kenso found.","nullable":true},"unresolved":{"type":"array","items":{"$ref":"#/components/schemas/SearchPeopleUnresolvedSeed"},"description":"The seeds Kenso could not use, with the reason.","nullable":true}},"additionalProperties":false,"description":"How the seeds of a lookalike filter resolved."},"SearchPeopleResolvedSeed":{"type":"object","properties":{"input":{"type":"string","description":"The seed as you sent it. A text seed is cut to 80 characters.","nullable":true},"companyId":{"type":"integer","description":"The Search id of the company the seed resolved to.","format":"int64","nullable":true},"personId":{"type":"integer","description":"The Search id of the person the seed resolved to, for a person seed.","format":"int64","nullable":true},"name":{"type":"string","description":"The name of the company or person the seed resolved to.","nullable":true},"domain":{"type":"string","description":"The domain of the company the seed resolved to.","nullable":true}},"additionalProperties":false,"description":"A lookalike seed Kenso found."},"SearchPeopleResults":{"type":"object","properties":{"totalResults":{"type":"integer","description":"How many people match the search in all. A `behaviorTags` filter does not change it.","format":"int64"},"page":{"type":"integer","description":"The page number, from 1.","format":"int32"},"pageSize":{"type":"integer","description":"The most people a page holds.","format":"int32"},"searchAfter":{"type":"string","description":"The cursor of the next page: send it back unchanged as `searchAfter`. Null when there is none.","nullable":true},"hasMore":{"type":"boolean","description":"True when more people match after this page."},"results":{"type":"array","items":{"$ref":"#/components/schemas/SearchPerson"},"description":"The people on this page.","nullable":true},"facets":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPeopleFacets"}],"description":"Always null here: `POST /v1/search/people/facets` counts the filter values.","nullable":true},"dataAsOf":{"type":"string","description":"The date of the newest profile check in the index, as `yyyy-MM-dd`. `newInSeat` and `newInRole` count back from it.","nullable":true},"lookalikeSeeds":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPeopleLookalikeSeeds"}],"description":"How each lookalike seed resolved. Present only on a lookalike search.","nullable":true}},"additionalProperties":false,"description":"One page of a people search."},"SearchPeopleResultsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchPeopleResults"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchPeopleTitleExpansion":{"type":"object","properties":{"expandedTitles":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"Each title you sent, mapped to its related job titles.","nullable":true},"error":{"type":"string","description":"Why the expansion failed, when the AI model gave no usable answer. Null otherwise.","nullable":true}},"additionalProperties":false,"description":"The related job titles of each title you sent."},"SearchPeopleTitleExpansionResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchPeopleTitleExpansion"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchPeopleUnresolvedSeed":{"type":"object","properties":{"input":{"type":"string","description":"The seed as you sent it.","nullable":true},"reason":{"type":"string","description":"Why the seed was not used: `not_found`, `no_text`, `embedding_unavailable` or `not_b2b_excluded`.","nullable":true}},"additionalProperties":false,"description":"A lookalike seed Kenso could not use."},"SearchPerson":{"type":"object","properties":{"kenId":{"type":"integer","description":"The person's Search id. Send it as `personId` to get the person again.","format":"int64"},"fullName":{"type":"string","description":"The person's full name.","nullable":true},"firstName":{"type":"string","description":"The person's first name.","nullable":true},"lastName":{"type":"string","description":"The person's last name.","nullable":true},"headline":{"type":"string","description":"The headline of the person's LinkedIn profile.","nullable":true},"summary":{"type":"string","description":"The about text of the person's profile.","nullable":true},"location":{"type":"string","description":"Where the person is, as their profile writes it.","nullable":true},"city":{"type":"string","description":"The person's city.","nullable":true},"state":{"type":"string","description":"The person's state or region.","nullable":true},"country":{"type":"string","description":"The person's country.","nullable":true},"countryIso2":{"type":"string","description":"The person's country as an ISO 3166-1 alpha-2 code, such as `US`.","nullable":true},"countryIso3":{"type":"string","description":"The person's country as an ISO 3166-1 alpha-3 code, such as `USA`.","nullable":true},"industry":{"type":"string","description":"The industry the person works in.","nullable":true},"linkedInUrl":{"type":"string","description":"The person's LinkedIn profile URL.","nullable":true},"profilePhotoUrl":{"type":"string","description":"The URL of the person's profile photo.","nullable":true},"publicProfileId":{"type":"string","description":"The id of the person's public LinkedIn profile.","nullable":true},"shorthandName":{"type":"string","description":"The person's LinkedIn handle, the part of the profile URL after `/in/`.","nullable":true},"canonicalShorthandName":{"type":"string","description":"The canonical form of `shorthandName`.","nullable":true},"services":{"type":"string","description":"The services the person offers on their profile, as one text.","nullable":true},"connectionsCount":{"type":"integer","description":"How many LinkedIn connections the person has.","format":"int32","nullable":true},"followerCount":{"type":"integer","description":"How many LinkedIn followers the person has.","format":"int32","nullable":true},"recommendationsCount":{"type":"integer","description":"How many recommendations the person's profile holds.","format":"int32","nullable":true},"experienceCount":{"type":"integer","description":"How many positions the person's work history lists.","format":"int32","nullable":true},"currentTitle":{"type":"string","description":"The person's current job title.","nullable":true},"currentCompanyName":{"type":"string","description":"The name of the person's current company.","nullable":true},"currentCompanyId":{"type":"integer","description":"The Search id of the person's current company: the `kenId` of a company search result.","format":"int64","nullable":true},"headquartersCountry":{"type":"string","description":"The country of the current company's headquarters.","nullable":true},"headquartersCity":{"type":"string","description":"The city of the current company's headquarters.","nullable":true},"headquartersState":{"type":"string","description":"The state or region of the current company's headquarters.","nullable":true},"headquartersCountryIso2":{"type":"string","description":"The country of the current company's headquarters as an ISO 3166-1 alpha-2 code.","nullable":true},"employeesCount":{"type":"integer","description":"How many employees the current company has.","format":"int32","nullable":true},"companyType":{"type":"string","description":"The current company's type, such as `Privately Held`.","nullable":true},"companySize":{"type":"string","description":"The current company's employee range, such as `51-200`.","nullable":true},"companyDomain":{"type":"string","description":"The current company's website domain.","nullable":true},"companyLinkedInUrl":{"type":"string","description":"The current company's LinkedIn page URL.","nullable":true},"companyDescription":{"type":"string","description":"The current company's description.","nullable":true},"companyLogoUrl":{"type":"string","description":"The URL of the current company's logo.","nullable":true},"companyFounded":{"type":"integer","description":"The year the current company was founded.","format":"int32","nullable":true},"companyFollowers":{"type":"integer","description":"How many LinkedIn followers the current company has.","format":"int32","nullable":true},"companyTotalFunding":{"type":"integer","description":"The current company's total funding as listed on its profile, in whole US dollars.","format":"int64","nullable":true},"companyLastFundingRoundType":{"type":"string","description":"The type of the current company's last funding round, such as `Series A`.","nullable":true},"companyLastFundingAmount":{"type":"integer","description":"The amount of the current company's last funding round, in whole US dollars.","format":"int64","nullable":true},"companyFundingTotalUsd":{"type":"integer","description":"The current company's total funding raised, in whole US dollars.","format":"int64","nullable":true},"companyLastFundedAt":{"type":"string","description":"The date of the current company's latest funding round, as `yyyy-MM-dd`.","nullable":true},"companySpecialties":{"type":"array","items":{"type":"string"},"description":"The current company's specialties.","nullable":true},"companyWebTechnologies":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonWebTechnology"},"description":"The web technologies the current company uses. Null when the web technology filters are off or it has none.","nullable":true},"seniorityLevel":{"type":"string","description":"The seniority of the person's current role, such as `Director` or `CLevel`.","nullable":true},"seniorityConfidence":{"type":"number","description":"How sure Kenso is of `seniorityLevel`, from 0 to 1. Absent with `view=summary`.","format":"double","nullable":true},"function":{"type":"string","description":"The function of the person's current role, such as `Sales` or `Engineering`.","nullable":true},"isDecisionMaker":{"type":"boolean","description":"True when the person's seniority is Director, VP, CLevel, Partner or Owner."},"yearsOfExperience":{"type":"number","description":"The person's years of work experience.","format":"double","nullable":true},"yearsInCurrentRole":{"type":"number","description":"The years the person has held their current role.","format":"double","nullable":true},"yearsInCurrentCompany":{"type":"number","description":"The years the person has worked at their current company.","format":"double","nullable":true},"skills":{"type":"array","items":{"type":"string"},"description":"The skills on the person's profile.","nullable":true},"languages":{"type":"array","items":{"type":"string"},"description":"The languages the person speaks.","nullable":true},"regions":{"type":"array","items":{"type":"string"},"description":"The regions the person's location belongs to.","nullable":true},"certifications":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonCertification"},"description":"The person's certifications.","nullable":true},"changedJobRecently":{"type":"boolean","description":"True when the person started at a new company within the last 90 days, after leaving another."},"newInSeat":{"type":"boolean","description":"True when the person joined their current company within the last 90 days, or the search's window."},"newInRole":{"type":"boolean","description":"True when the person started their current role within the last 90 days, or the search's window."},"tenureRipe":{"type":"boolean","description":"True when the person has held their current role for 3.5 years or more, or the search's threshold."},"jobChangeDate":{"type":"string","description":"When the person started at their new company, set with `changedJobRecently`. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"titleChangedRecently":{"type":"boolean","description":"True when the person's job title changed recently."},"promoted":{"type":"boolean","description":"True when the person's recent title change was a promotion."},"seniorityIncreased":{"type":"boolean","description":"True when the person's seniority went up with their recent title change."},"previousTitle":{"type":"string","description":"The person's job title before their recent title change.","nullable":true},"previousSeniorityLevel":{"type":"string","description":"The person's seniority before their recent title change.","nullable":true},"titleChangeDetectedMonth":{"type":"string","description":"The month Kenso saw the person's title change, as the first day of that month. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"previousCompanyName":{"type":"string","description":"The company the person worked at before their recent company change.","nullable":true},"jobChangeDetectedMonth":{"type":"string","description":"The month Kenso saw the person's company change, as the first day of that month. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"createdAt":{"type":"string","description":"When the profile was first added to the index. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"checkedAt":{"type":"string","description":"When the profile was last checked. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"experience":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonExperience"},"description":"The person's work history, current positions first, then newest first.","nullable":true},"education":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonEducation"},"description":"The person's education.","nullable":true},"awards":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonAward"},"description":"The person's awards.","nullable":true},"organizations":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonOrganization"},"description":"The organizations the person belongs to.","nullable":true},"recommendations":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonRecommendation"},"description":"The recommendations others wrote for the person.","nullable":true},"publications":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonPublication"},"description":"The person's publications.","nullable":true},"patents":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonPatent"},"description":"The person's patents.","nullable":true},"volunteering":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonVolunteering"},"description":"The person's volunteering roles.","nullable":true},"websites":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonWebsite"},"description":"The websites on the person's profile.","nullable":true},"activity":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonActivity"},"description":"The person's recent LinkedIn activity.","nullable":true},"courseSuggestions":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonCourseSuggestion"},"description":"The courses LinkedIn suggests on the person's profile.","nullable":true},"similarProfiles":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonSimilarProfile"},"description":"Profiles LinkedIn shows as similar to this one.","nullable":true},"alsoViewed":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonSimilarProfile"},"description":"Profiles that people who viewed this one also viewed.","nullable":true},"othersNamed":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonSimilarProfile"},"description":"Other profiles with the same name.","nullable":true},"courses":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonCourse"},"description":"The courses the person took.","nullable":true},"groups":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonGroup"},"description":"The LinkedIn groups the person belongs to.","nullable":true},"interests":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonInterest"},"description":"The person's interests.","nullable":true},"projects":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonProject"},"description":"The person's projects.","nullable":true},"testScores":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonTestScore"},"description":"The person's test scores.","nullable":true},"hiddenDetails":{"type":"array","items":{"type":"string"},"description":"The names of the profile details the person hides.","nullable":true},"volunteeringCares":{"type":"array","items":{"type":"string"},"description":"The causes the person cares about, from the volunteering section of their profile.","nullable":true},"volunteeringOpportunities":{"type":"array","items":{"type":"string"},"description":"The volunteering opportunities the person is open to.","nullable":true},"volunteeringSupports":{"type":"array","items":{"type":"string"},"description":"The organizations the person supports, from the volunteering section of their profile.","nullable":true},"postsSeeMoreUrls":{"type":"array","items":{"type":"string"},"description":"Links to more of the person's posts.","nullable":true},"relevanceScore":{"type":"number","description":"How well the person matches the search, higher first. 0 when the answer is not a search.","format":"double"},"lookalike":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPersonLookalikeMatch"}],"description":"How much the person's current company looks like the lookalike seeds. Present only on a lookalike search.","nullable":true},"matchedCurrentRole":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPersonMatchedRole"}],"description":"The current role that matched a title search when `currentTitle` does not. Present only on a title search.","nullable":true},"hasKenEmail":{"type":"boolean","description":"True when Kenso holds a verified email for the person, so importing them needs no email find."},"kenEmailStatus":{"type":"string","description":"The best email Kenso holds for the person: `none`, `risky`, `catch_all` or `verified`.","nullable":true},"searchToken":{"type":"string","description":"The token a `source: search` import counts the person by. Absent when the person has no LinkedIn URL.","nullable":true},"behaviorTags":{"type":"array","items":{"type":"string"},"description":"The workspace's behavior tags for the person. Present only on a people search with the `behavior_signals` feature.","nullable":true}},"additionalProperties":false,"description":"A person in Kenso's people index. With `view=summary`, a people search returns only the fields a list row shows,\nand the others are absent."},"SearchPersonActivity":{"type":"object","properties":{"activityUrl":{"type":"string","description":"The URL of the post.","nullable":true},"title":{"type":"string","description":"The post's title or first words.","nullable":true},"action":{"type":"string","description":"What the person did, such as posting or liking.","nullable":true}},"additionalProperties":false,"description":"One recent LinkedIn activity of a person."},"SearchPersonAward":{"type":"object","properties":{"title":{"type":"string","description":"The award's name.","nullable":true},"issuer":{"type":"string","description":"Who gave the award.","nullable":true},"description":{"type":"string","description":"The award's description.","nullable":true},"date":{"type":"string","description":"When the person received the award, as the profile writes it.","nullable":true}},"additionalProperties":false,"description":"One award a person received."},"SearchPersonCertification":{"type":"object","properties":{"title":{"type":"string","description":"The certification's name.","nullable":true},"issuer":{"type":"string","description":"Who issued the certification.","nullable":true},"credentialId":{"type":"string","description":"The credential id.","nullable":true},"certificateUrl":{"type":"string","description":"The URL of the certificate.","nullable":true},"certificateLogoUrl":{"type":"string","description":"The URL of the certificate's logo.","nullable":true},"issuerUrl":{"type":"string","description":"The URL of the issuer's page.","nullable":true},"startDate":{"type":"string","description":"When the certification was issued. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"endDate":{"type":"string","description":"When the certification expires. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"One certification a person holds."},"SearchPersonContributor":{"type":"object","properties":{"fullName":{"type":"string","description":"The person's full name.","nullable":true},"profileUrl":{"type":"string","description":"The person's LinkedIn profile URL.","nullable":true}},"additionalProperties":false,"description":"A person named on a publication, patent or project."},"SearchPersonCourse":{"type":"object","properties":{"title":{"type":"string","description":"The course's title.","nullable":true},"number":{"type":"string","description":"The course's number.","nullable":true}},"additionalProperties":false,"description":"A course a person took."},"SearchPersonCourseSuggestion":{"type":"object","properties":{"title":{"type":"string","description":"The course's title.","nullable":true},"courseUrl":{"type":"string","description":"The course's URL.","nullable":true}},"additionalProperties":false,"description":"A course LinkedIn suggests on a person's profile."},"SearchPersonEducation":{"type":"object","properties":{"schoolName":{"type":"string","description":"The school's name.","nullable":true},"degree":{"type":"string","description":"The degree.","nullable":true},"fieldOfStudy":{"type":"string","description":"The field of study.","nullable":true},"schoolUrl":{"type":"string","description":"The URL of the school's LinkedIn page.","nullable":true},"schoolLogoUrl":{"type":"string","description":"The URL of the school's logo.","nullable":true},"description":{"type":"string","description":"The description of the studies.","nullable":true},"activitiesAndSocieties":{"type":"string","description":"The activities and societies the person took part in.","nullable":true},"startDate":{"type":"string","description":"When the studies started. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"endDate":{"type":"string","description":"When the studies ended. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"One school a person attended."},"SearchPersonExperience":{"type":"object","properties":{"companyId":{"type":"integer","description":"The Search id of the position's company.","format":"int64","nullable":true},"companyName":{"type":"string","description":"The name of the position's company.","nullable":true},"companyUrl":{"type":"string","description":"The URL of the company's LinkedIn page.","nullable":true},"companyLogoUrl":{"type":"string","description":"The URL of the company's logo.","nullable":true},"title":{"type":"string","description":"The position's job title.","nullable":true},"location":{"type":"string","description":"Where the position is.","nullable":true},"isCurrent":{"type":"boolean","description":"True when the person holds the position now."},"startDate":{"type":"string","description":"When the position started. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"endDate":{"type":"string","description":"When the position ended. Null for a current position. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"durationMonths":{"type":"integer","description":"How long the position lasted, in months.","format":"int32","nullable":true},"seniorityLevel":{"type":"string","description":"The position's seniority.","nullable":true},"description":{"type":"string","description":"The position's description.","nullable":true}},"additionalProperties":false,"description":"One position in a person's work history."},"SearchPersonGroup":{"type":"object","properties":{"name":{"type":"string","description":"The group's name.","nullable":true},"url":{"type":"string","description":"The group's URL.","nullable":true}},"additionalProperties":false,"description":"A LinkedIn group a person belongs to."},"SearchPersonInterest":{"type":"object","properties":{"name":{"type":"string","description":"The interest's name.","nullable":true}},"additionalProperties":false,"description":"An interest of a person."},"SearchPersonLookalikeMatch":{"type":"object","properties":{"score":{"type":"integer","description":"The similarity score, from 0 to 100.","format":"int32"},"grade":{"type":"integer","description":"The similarity grade, from 1 to 5, where 5 is the closest.","format":"int32"}},"additionalProperties":false,"description":"A row's similarity to the lookalike seeds."},"SearchPersonMatchedRole":{"type":"object","properties":{"title":{"type":"string","description":"The role's job title.","nullable":true},"companyName":{"type":"string","description":"The name of the role's company.","nullable":true},"companyId":{"type":"integer","description":"The Search id of the role's company.","format":"int64","nullable":true}},"additionalProperties":false,"description":"One current role of a person."},"SearchPersonOrganization":{"type":"object","properties":{"name":{"type":"string","description":"The organization's name.","nullable":true},"position":{"type":"string","description":"The person's position in the organization.","nullable":true},"description":{"type":"string","description":"The description of the membership.","nullable":true},"startDate":{"type":"string","description":"When the membership started. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"endDate":{"type":"string","description":"When the membership ended. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"One organization a person belongs to."},"SearchPersonPatent":{"type":"object","properties":{"title":{"type":"string","description":"The patent's title.","nullable":true},"description":{"type":"string","description":"The patent's description.","nullable":true},"patentNumber":{"type":"string","description":"The patent or application number.","nullable":true},"url":{"type":"string","description":"The patent's URL.","nullable":true},"status":{"type":"string","description":"The patent's status, such as issued or pending.","nullable":true},"inventors":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonContributor"},"description":"The patent's inventors.","nullable":true},"date":{"type":"string","description":"When the patent was issued or filed. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"One patent of a person."},"SearchPersonProject":{"type":"object","properties":{"title":{"type":"string","description":"The project's title.","nullable":true},"description":{"type":"string","description":"The project's description.","nullable":true},"url":{"type":"string","description":"The project's URL.","nullable":true},"startDate":{"type":"string","description":"When the project started. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"endDate":{"type":"string","description":"When the project ended. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"teamMembers":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonContributor"},"description":"The project's team members.","nullable":true}},"additionalProperties":false,"description":"A project of a person."},"SearchPersonPublication":{"type":"object","properties":{"title":{"type":"string","description":"The publication's title.","nullable":true},"publisher":{"type":"string","description":"The publisher.","nullable":true},"description":{"type":"string","description":"The publication's description.","nullable":true},"url":{"type":"string","description":"The publication's URL.","nullable":true},"authors":{"type":"array","items":{"$ref":"#/components/schemas/SearchPersonContributor"},"description":"The publication's authors.","nullable":true},"date":{"type":"string","description":"When the publication came out. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"One publication of a person."},"SearchPersonRecommendation":{"type":"object","properties":{"text":{"type":"string","description":"The recommendation's text.","nullable":true},"recommenderName":{"type":"string","description":"The name of the person who wrote it.","nullable":true},"recommenderUrl":{"type":"string","description":"The LinkedIn profile URL of the person who wrote it.","nullable":true}},"additionalProperties":false,"description":"A recommendation someone wrote for a person."},"SearchPersonResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchPerson"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SearchPersonSimilarProfile":{"type":"object","properties":{"profileUrl":{"type":"string","description":"The profile's URL.","nullable":true},"fullName":{"type":"string","description":"The profile's full name.","nullable":true},"headline":{"type":"string","description":"The profile's headline.","nullable":true},"location":{"type":"string","description":"Where the profile's person is.","nullable":true},"company":{"type":"string","description":"The profile's company.","nullable":true},"followers":{"type":"integer","description":"How many followers the profile has.","format":"int32","nullable":true}},"additionalProperties":false,"description":"A profile LinkedIn shows next to a person's profile."},"SearchPersonTestScore":{"type":"object","properties":{"title":{"type":"string","description":"The test's name.","nullable":true},"score":{"type":"string","description":"The score, as the profile writes it.","nullable":true},"description":{"type":"string","description":"The description of the test.","nullable":true},"date":{"type":"string","description":"When the person took the test. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"A test score of a person."},"SearchPersonVolunteering":{"type":"object","properties":{"organization":{"type":"string","description":"The organization's name.","nullable":true},"role":{"type":"string","description":"The person's role.","nullable":true},"cause":{"type":"string","description":"The cause the role serves.","nullable":true},"description":{"type":"string","description":"The role's description.","nullable":true},"startDate":{"type":"string","description":"When the role started. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true},"endDate":{"type":"string","description":"When the role ended. ISO 8601, such as `2021-03-01T00:00:00`, with or without an offset.","nullable":true}},"additionalProperties":false,"description":"One volunteering role of a person."},"SearchPersonWebTechnology":{"type":"object","properties":{"key":{"type":"string","description":"The technology's key, as the web technology filters take it.","nullable":true},"name":{"type":"string","description":"The technology's display name.","nullable":true}},"additionalProperties":false,"description":"A web technology a company uses."},"SearchPersonWebsite":{"type":"object","properties":{"url":{"type":"string","description":"The website's URL.","nullable":true}},"additionalProperties":false,"description":"A website on a person's profile."},"SearchSampleCompaniesRequest":{"type":"object","properties":{"industries":{"type":"array","items":{"type":"string"},"description":"The industries to match, from `query.industries`.","nullable":true},"countries":{"type":"array","items":{"type":"string"},"description":"The countries to match, by English name, from `query.countries`.","nullable":true},"employeesCount":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchSampleRange"}],"description":"The headcount range, from `query.headcountMin` and `query.headcountMax`.","nullable":true},"excludeCompanyTypes":{"type":"array","items":{"type":"string"},"description":"The company types left out: schools, nonprofits, government agencies and one-person pages.","nullable":true},"page":{"type":"integer","description":"The page number: always 1.","format":"int32"},"pageSize":{"type":"integer","description":"How many companies the search asked for, before the sample cut the page.","format":"int32"},"sortBy":{"type":"string","description":"The sort: always `relevance`.","nullable":true},"sortOrder":{"type":"string","description":"The sort order: always `desc`.","nullable":true}},"additionalProperties":false,"description":"The company search the sample's companies tab sent. A filter is absent when the sample's query has no value for it."},"SearchSampleCompaniesTab":{"type":"object","properties":{"request":{"allOf":[{"$ref":"#/components/schemas/SearchSampleCompaniesRequest"}],"description":"The `POST /v1/search/companies` body the tab sent, built from the sample's `query`."},"page":{"allOf":[{"$ref":"#/components/schemas/SearchCompaniesResults"}],"description":"The page the company search returned, cut to the companies the sample shows: those with a website or domain, most\nLinkedIn followers first. `page` is 1, `pageSize` is how many it kept, `hasMore` is false and\n`searchAfter` is absent."}},"additionalProperties":false,"description":"The companies tab of the sample: the company search it ran and the page that search returned."},"SearchSampleFundingParameters":{"type":"object","properties":{"raisedWithinDays":{"type":"integer","description":"How recent the funding must be, in days, from `query.fundingRaisedWithinDays`.","format":"int32"},"minRaisedUsd":{"type":"integer","description":"The smallest amount raised, in whole US dollars, from `query.fundingMinRaisedUsd`.","format":"int64","nullable":true},"industryGroups":{"type":"array","items":{"type":"string"},"description":"The industry groups to match, from `query.fundingIndustryGroups`.","nullable":true},"states":{"type":"array","items":{"type":"string"},"description":"Every US state and DC, as two-letter codes, when the sample's query names the United States: the funding index\nfilters by an issuer's US state only.","nullable":true}},"additionalProperties":false,"description":"The fundraising parameters of the sample's funding tab. A filter is absent when the sample's query has no value for it."},"SearchSampleFundingRequest":{"type":"object","properties":{"signalType":{"type":"string","description":"The signal type: always `fundraising`.","nullable":true},"parameters":{"allOf":[{"$ref":"#/components/schemas/SearchSampleFundingParameters"}],"description":"The fundraising trigger's parameters."}},"additionalProperties":false,"description":"The trigger preview the sample's funding tab sent."},"SearchSampleFundingTab":{"type":"object","properties":{"request":{"allOf":[{"$ref":"#/components/schemas/SearchSampleFundingRequest"}],"description":"The `POST /v1/triggers/preview` body the tab sent, built from the sample's `query`."},"page":{"allOf":[{"$ref":"#/components/schemas/TriggerPreviewPage"}],"description":"The first page the trigger preview returned."}},"additionalProperties":false,"description":"The funding tab of the sample: the trigger preview it ran and the page that preview returned."},"SearchSampleJobFilters":{"type":"object","properties":{"titles":{"allOf":[{"$ref":"#/components/schemas/SearchSampleJobTitles"}],"description":"The job titles to match, from `query.hiringTitles`."},"status":{"type":"string","description":"The posting status: always `open`.","nullable":true},"limit":{"type":"integer","description":"How many hiring companies the search read.","format":"int32"},"location":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchSampleJobLocation"}],"description":"Where the jobs are. Absent when the sample's query names no country Kenso knows.","nullable":true}},"additionalProperties":false,"description":"The job filters of the sample: open postings for the roles a buyer would hire for."},"SearchSampleJobLocation":{"type":"object","properties":{"countries":{"type":"array","items":{"type":"string"},"description":"The countries, as two-letter ISO codes, from `query.countries`.","nullable":true}},"additionalProperties":false,"description":"The job location filter."},"SearchSampleJobPeopleFilters":{"type":"object","properties":{"page":{"type":"integer","description":"The page number: always 1.","format":"int32"},"pageSize":{"type":"integer","description":"How many people the search asked for, before the sample cut the page.","format":"int32"},"currentTitles":{"type":"array","items":{"type":"string"},"description":"The job titles to match, from `query.titles`.","nullable":true},"seniorityLevels":{"type":"array","items":{"type":"string"},"description":"The seniority levels to match, from `query.seniorityLevels`.","nullable":true}},"additionalProperties":false,"description":"The people filters of the sample's job posts tab. A filter is absent when the sample's query has no value for it."},"SearchSampleJobTitles":{"type":"object","properties":{"include":{"type":"array","items":{"type":"string"},"description":"The job titles a posting may match.","nullable":true}},"additionalProperties":false,"description":"The job titles filter."},"SearchSampleJobsRequest":{"type":"object","properties":{"jobFilters":{"allOf":[{"$ref":"#/components/schemas/SearchSampleJobFilters"}],"description":"The `jobFilters` sent to `POST /v1/job-post-searches/companies` and `POST /v1/job-post-searches/people`."},"peopleFilters":{"allOf":[{"$ref":"#/components/schemas/SearchSampleJobPeopleFilters"}],"description":"The `peopleFilters` sent to `POST /v1/job-post-searches/people`."}},"additionalProperties":false,"description":"The job post searches the sample's job posts tab ran."},"SearchSampleJobsTab":{"type":"object","properties":{"request":{"allOf":[{"$ref":"#/components/schemas/SearchSampleJobsRequest"}],"description":"The request: `jobFilters` and `peopleFilters`."},"companies":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchCompanies"}],"description":"The page of companies hiring for the job filters."},"people":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchPeopleResults"}],"description":"The page of people at those companies. Absent when that search failed or found nobody."}},"additionalProperties":false,"description":"The job posts tab of the sample."},"SearchSampleProfilesRequest":{"type":"object","properties":{"currentTitles":{"type":"array","items":{"type":"string"},"description":"The job titles to match, from `query.titles`.","nullable":true},"seniorityLevels":{"type":"array","items":{"type":"string"},"description":"The seniority levels to match, from `query.seniorityLevels`.","nullable":true},"industries":{"type":"array","items":{"type":"string"},"description":"The industries to match, from `query.industries`.","nullable":true},"companyHeadcount":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchSampleRange"}],"description":"The company headcount range, from `query.headcountMin` and `query.headcountMax`.","nullable":true},"countries":{"type":"array","items":{"type":"string"},"description":"The countries to match, by English name, from `query.countries`.","nullable":true},"page":{"type":"integer","description":"The page number: always 1.","format":"int32"},"pageSize":{"type":"integer","description":"How many people the search asked for, before the sample cut the page.","format":"int32"},"sortBy":{"type":"string","description":"The sort: always `relevance`.","nullable":true}},"additionalProperties":false,"description":"The people search the sample's people tab sent. A filter is absent when the sample's query has no value for it."},"SearchSampleProfilesTab":{"type":"object","properties":{"request":{"allOf":[{"$ref":"#/components/schemas/SearchSampleProfilesRequest"}],"description":"The `POST /v1/search/people` body the tab sent, built from the sample's `query`."},"page":{"allOf":[{"$ref":"#/components/schemas/SearchPeopleResults"}],"description":"The page the people search returned, cut to the people the sample shows, a few per company: `page` is\n1, `pageSize` is how many it kept, `hasMore` is false and `searchAfter` is absent. Its people carry no\n`hasKenEmail`, `kenEmailStatus`, `searchToken` or `behaviorTags`: Kenso adds those only to\nthe answer of `POST /v1/search/people`."}},"additionalProperties":false,"description":"The people tab of the sample: the people search it ran and the page that search returned."},"SearchSampleQuery":{"type":"object","properties":{"titles":{"type":"array","items":{"type":"string"},"description":"Job titles of the people to reach, up to 6."},"seniorityLevels":{"type":"array","items":{"type":"string"},"description":"Seniority levels, from the ones the Search page offers: `Entry`, `Individual`, `Senior`,\n`Manager`, `Director`, `VP`, `CLevel` and `Owner`."},"industries":{"type":"array","items":{"type":"string"},"description":"Industries, as Search names them in lowercase, up to 5."},"headcountMin":{"type":"integer","description":"The smallest company headcount. Null for no minimum.","format":"int32","nullable":true},"headcountMax":{"type":"integer","description":"The largest company headcount. Null for no maximum.","format":"int32","nullable":true},"countries":{"type":"array","items":{"type":"string"},"description":"Country names in English, from United States, Canada, United Kingdom, Ireland, Australia and New Zealand."},"hiringTitles":{"type":"array","items":{"type":"string"},"description":"Job titles a company would hire for when it needs what the workspace sells, up to 5."},"fundingMinRaisedUsd":{"type":"integer","description":"The smallest amount raised, in whole US dollars. Null for any amount.","format":"int64","nullable":true},"fundingRaisedWithinDays":{"type":"integer","description":"How recent the funding must be, in days: 30, 90, 180 or 365.","format":"int32"},"fundingIndustryGroups":{"type":"array","items":{"type":"string"},"description":"Industry groups for the funding search, from the ones the Search page's funding filter offers, up to 5."}},"additionalProperties":false,"description":"The search Ken picked from the workspace's ideal customer profile. Each sample tab ran its own search from these\nfilters, so you can copy them into your own search."},"SearchSampleRange":{"type":"object","properties":{"min":{"type":"integer","description":"The smallest headcount.","format":"int32","nullable":true},"max":{"type":"integer","description":"The largest headcount.","format":"int32","nullable":true}},"additionalProperties":false,"description":"A headcount range. A bound is absent when the sample's query has none."},"SearchSampleResource":{"type":"object","properties":{"status":{"type":"string","description":"The sample's state: `ready`, `pending`, `unavailable` or `off`."},"refreshing":{"type":"boolean","description":"True while Kenso rebuilds the sample, because the ICP changed or the sample expired."},"generatedAt":{"type":"string","description":"When Kenso built this sample, UTC.","format":"date-time","nullable":true},"expiresAt":{"type":"string","description":"When this sample expires and Kenso rebuilds it, UTC.","format":"date-time","nullable":true},"query":{"allOf":[{"$ref":"#/components/schemas/SearchSampleQuery"}],"description":"The filters Ken picked. Every tab ran its search from them."},"profiles":{"allOf":[{"$ref":"#/components/schemas/SearchSampleProfilesTab"}],"description":"People: `page` is what `POST /v1/search/people` returned for `request`."},"companies":{"allOf":[{"$ref":"#/components/schemas/SearchSampleCompaniesTab"}],"description":"Companies: `page` is what `POST /v1/search/companies` returned for `request`."},"jobs":{"allOf":[{"$ref":"#/components/schemas/SearchSampleJobsTab"}],"description":"Job posts: what `POST /v1/job-post-searches/companies` and `POST /v1/job-post-searches/people`\nreturned."},"funding":{"allOf":[{"$ref":"#/components/schemas/SearchSampleFundingTab"}],"description":"Funding: `page` is what `POST /v1/triggers/preview` returned for `request`."}},"additionalProperties":false,"description":"A ready-made sample search for the workspace, with up to four tabs of results. A tab is absent when its search failed\nor found nothing."},"SearchSampleResourceResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SearchSampleResource"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"ServiceUnavailableError":{"oneOf":[{"$ref":"#/components/schemas/Failure"},{"$ref":"#/components/schemas/ApiKeyError"}],"description":"The body of a `503`: the error body (`Failure`). When Kenso cannot check the API key, its code is `auth_unavailable`, with `Retry-After: 5`. Until November 2026 the API key check in front of the operations answered `{ \"error\": \"Authentication is temporarily unavailable\" }` (`ApiKeyError`) there instead, so handle both shapes. Retry after the `Retry-After` seconds."},"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."},"TriggerPreviewCompany":{"type":"object","properties":{"kenCompanyId":{"type":"integer","description":"The company's Kenso company id. Present for `open_roles` and `company_headcount_growth`.","format":"int64","nullable":true},"companyId":{"type":"integer","description":"The company's id in the funding data, the value the funding round `companyIds` filter takes. Present only for `fundraising`.","format":"int64","nullable":true},"name":{"type":"string","description":"The company's name. Null when unknown.","nullable":true},"domain":{"type":"string","description":"The company's web domain, for example `acme.com`. Null when unknown.","nullable":true},"linkedinUrl":{"type":"string","description":"The company's LinkedIn page URL. Null when unknown. Present for `open_roles` and `company_headcount_growth`.","nullable":true},"openJobCount":{"type":"integer","description":"How many open jobs the company has. Present only for `open_roles`.","format":"int32","nullable":true},"jobs":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewJob"},"description":"Up to 3 of the company's matching open jobs. Present only for `open_roles`.","nullable":true},"previousHeadcount":{"type":"integer","description":"The company's employee count the month before. Null when unknown. Present only for `company_headcount_growth`.","format":"int32","nullable":true},"currentHeadcount":{"type":"integer","description":"The company's employee count this month. Null when unknown. Present only for `company_headcount_growth`.","format":"int32","nullable":true},"growthAbs":{"type":"integer","description":"How many employees the company added over the month. Null when unknown. Present only for `company_headcount_growth`.","format":"int32","nullable":true},"growthPct":{"type":"number","description":"The company's headcount growth over the month, in percent. Null when unknown. Present only for `company_headcount_growth`.","format":"float","nullable":true},"websiteUrl":{"type":"string","description":"The company's website URL. Null when unknown. Present only for `fundraising`.","nullable":true},"city":{"type":"string","description":"The city the company reported with its newest matching round. Null when unknown. Present only for `fundraising`.","nullable":true},"state":{"type":"string","description":"The two-letter US state the company reported. Null outside the US or when unknown. Present only for `fundraising`.","nullable":true},"industry":{"type":"string","description":"The company's industry as reported with its newest matching round. Null when unknown. Present only for `fundraising`.","nullable":true},"revenueRange":{"type":"string","description":"The company's revenue range as reported with its newest matching round. Null when unknown. Present only for `fundraising`.","nullable":true},"foundedYear":{"type":"integer","description":"The year the company was founded. Null when unknown. Present only for `fundraising`.","format":"int32","nullable":true},"totalRaisedUsd":{"type":"integer","description":"The company's total raised to date across all its rounds, in whole US dollars. Null when unknown. Present only for `fundraising`.","format":"int64","nullable":true},"raises":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewRaise"},"description":"Up to 10 of the company's matching round reports, newest first. Present only for `fundraising`.","nullable":true},"executives":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewExecutive"},"description":"The executive officers named on the newest matching round. Present only for `fundraising`.","nullable":true}},"additionalProperties":{},"description":"A sample company on a trigger preview page. The fields present depend on the signal type. Kenso may add fields to it."},"TriggerPreviewCreditEstimate":{"type":"object","properties":{"isEstimate":{"type":"boolean","description":"Always true: this is an estimate, not a quote."},"leads":{"type":"integer","description":"The people the page can import, the count of the `max_contacts_per_company` step.","format":"int32"},"totalMillicredits":{"type":"integer","description":"The estimated cost in millicredits (1,000 to a credit).","format":"int64"},"credits":{"type":"number","description":"The estimated cost in credits.","format":"double"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewCreditLine"},"description":"The estimate per charged action. Empty when `leads` is 0.","nullable":true},"basis":{"type":"string","description":"How Kenso computed the estimate, in words.","nullable":true}},"additionalProperties":false,"description":"An estimate of the lead credits for the people a preview page can import. Never charged."},"TriggerPreviewCreditLine":{"type":"object","properties":{"action":{"type":"string","description":"The action: `ai_qualification`, `email_found` or `ai_personalization`.","nullable":true},"units":{"type":"integer","description":"How many times the action runs.","format":"int64"},"millicredits":{"type":"integer","description":"The estimated cost of the action in millicredits.","format":"int64"},"description":{"type":"string","description":"What the action covers, in words.","nullable":true}},"additionalProperties":false,"description":"One charged action in a trigger preview's credit estimate."},"TriggerPreviewExecutive":{"type":"object","properties":{"name":{"type":"string","description":"The person's full name. Null when unknown.","nullable":true},"title":{"type":"string","description":"The person's title as reported, or `Executive officer` when none is given.","nullable":true}},"additionalProperties":{},"description":"An executive officer named on a round. Kenso may add fields to it."},"TriggerPreviewJob":{"type":"object","properties":{"title":{"type":"string","description":"The job title. Null when unknown.","nullable":true},"location":{"type":"string","description":"The job's location. Null when unknown.","nullable":true},"source":{"type":"string","description":"The job board the posting came from. Null when unknown.","nullable":true},"url":{"type":"string","description":"The URL to apply for the job. Null when unknown.","nullable":true}},"additionalProperties":false,"description":"A sample open job of a company on an `open_roles` preview."},"TriggerPreviewPage":{"type":"object","properties":{"signalType":{"type":"string","description":"The previewed signal type: `open_roles` or `company_headcount_growth`. Left out for `fundraising`.","nullable":true},"month":{"type":"string","description":"The month of the headcount data, as `yyyy-MM`. Present only for `company_headcount_growth`.","nullable":true},"companies":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewCompany"},"description":"Sample matching companies on this page.","nullable":true},"total":{"type":"integer","description":"The matching companies across all pages. Null for `open_roles`. For `fundraising` it stops at 1,000\n(see `totalIsCapped`).","format":"int64","nullable":true},"totalIsCapped":{"type":"boolean","description":"True when `total` stopped at 1,000, so more companies match. Present only for `fundraising`.","nullable":true},"steps":{"type":"array","items":{"$ref":"#/components/schemas/TriggerPreviewStep"},"description":"Each filter step on this page, in order, with how many companies or people pass it. The last step,\n`max_contacts_per_company`, is the most people the page can import.","nullable":true},"estimatedCredits":{"allOf":[{"$ref":"#/components/schemas/TriggerPreviewCreditEstimate"}],"description":"The estimated lead credits for the people this page can import. Kenso charges nothing for a preview."},"pagination":{"allOf":[{"$ref":"#/components/schemas/TriggerPreviewPagination"}],"description":"How to get the next page."}},"additionalProperties":{},"description":"One page of a trigger preview: sample companies that would match, how many pass each filter step, and an estimated\ncredit cost. The fields present depend on `signalType`. Kenso may add fields to it."},"TriggerPreviewPagination":{"type":"object","properties":{"nextCursor":{"type":"string","description":"Send it as `cursor` with the same parameters to get the next page. Null on the last page.","nullable":true},"hasMore":{"type":"boolean","description":"True when there is a next page. Left out for `fundraising`; read `nextCursor` there.","nullable":true}},"additionalProperties":{},"description":"How to get the next page of a trigger preview. Kenso may add fields to it."},"TriggerPreviewRaise":{"type":"object","properties":{"reportedAt":{"type":"string","description":"The day the round was reported, as `yyyy-MM-dd`.","nullable":true},"amountRaisedUsd":{"type":"integer","description":"The money this report adds, in whole US dollars. Null when unknown.","format":"int64","nullable":true},"roundRaisedUsd":{"type":"integer","description":"The total sold in the round so far, in whole US dollars. Null when unknown.","format":"int64","nullable":true},"roundSizeUsd":{"type":"integer","description":"The round's target size in whole US dollars. Null when the round is open-ended or the size is unknown.","format":"int64","nullable":true},"isOpenEnded":{"type":"boolean","description":"True when the round has no set size."},"investorCount":{"type":"integer","description":"How many investors have put money into the round. Null when unknown.","format":"int32","nullable":true},"isNewRound":{"type":"boolean","description":"True when this is the first report of a new round, false for a later update of a round."}},"additionalProperties":{},"description":"A report of a round on a `fundraising` preview. Kenso may add fields to it."},"TriggerPreviewStep":{"type":"object","properties":{"name":{"type":"string","description":"The step: `funding_filters` for `fundraising`; `job_filter`, `resolved_company` for\n`open_roles`; `min_growth_pct`, `min_growth_abs` for `company_headcount_growth`;\n`min_company_size` and `people_filter` for both of those; and `max_contacts_per_company`, always last.","nullable":true},"count":{"type":"integer","description":"How many companies on this page pass the step, or people for `people_filter` and `max_contacts_per_company`. Null when the step could not be counted.","format":"int64","nullable":true},"description":{"type":"string","description":"What the step counts, in words.","nullable":true}},"additionalProperties":false,"description":"One filter step of a trigger preview."},"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."}}}}