{"openapi":"3.0.4","info":{"title":"Kenso API: Job post search","version":"1.1","description":"The Job post 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":"job-post-searches","description":"A job post search finds the people who work at companies that are hiring. It runs in two steps: `jobFilters`\npicks the hiring companies from job postings, and `peopleFilters` picks the people at those companies from\nSearch. `jobFilters` takes the same filters as `POST /v1/job-postings/search`, and `peopleFilters`\ntakes a `POST /v1/search/people` body. The hiring set holds at most 25,000 companies, and\n`hiringSet.truncated` is true when more companies matched. An import gives each contact five variables about\nthe role its company is hiring for: `hiring_for`, `hiring_for_url`, `hiring_for_location`,\n`open_roles` and `job_posted`.","x-displayName":"Job post search"}],"paths":{"/v1/job-post-searches/companies":{"post":{"tags":["job-post-searches"],"summary":"List hiring companies","description":"List the companies hiring for your job filters, one page at a time. Use it to check the job filters before you\nsearch for people.\n            \nSend `jobFilters`. Page through the companies with `jobFilters.limit` and `jobFilters.cursor`, set\nto the previous page's `pagination.next_cursor`. Each company comes with its matching postings and\n`match_count`. `hiringSet` describes the whole set: `total` companies and `truncated`.\n            \nBy default the page lists only companies Kenso Search knows. Send `includeUnmatched: true` to also list the\nhiring companies it has no record of, in the same order. Every row then has `match_status`,\n`matched` or `unmatched`. An unmatched row has a null `ken_search_id`, the best-known\n`domain` with its `domain_source`, and no people yet. The page's `total` counts both kinds and\n`unmatched_total` counts the unmatched rows. `hiringSet.unmatched` counts the unmatched companies, while\n`hiringSet.total` stays the matched companies that the people searches cover.\n            \nThe call is free.\n            \nErrors:\n            \n- `400 validation_failed`: the body is not a JSON object, `jobFilters` is missing or not an object, or\n`includeUnmatched` is not true or false.\n- `402 plan_required`: the workspace's plan does not include job post search. `error.refusal` carries\nthe code `PLAN_FEATURE_NOT_AVAILABLE` and the feature `job_post_search`.\n- `422 filter_required`: `jobFilters` sets no filter.\n- `422 invalid_cursor`: `jobFilters.cursor` did not come from a previous page.\n- `503 service_unavailable`: job postings are not available right now. Try again.\n            \nRequires Search view.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"job-post-searches.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"}}],"requestBody":{"content":{"application/json":{"schema":{}}}},"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/JobPostSearchCompaniesResponse"}}}},"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"]},"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":["filter_required","invalid_cursor"]},"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":240,"windowSeconds":60,"per":"api_key"}}},"/v1/job-post-searches/people":{"post":{"tags":["job-post-searches"],"summary":"Search people at hiring companies","description":"Search for people at the companies hiring for your job filters, and get one page of people. Use it to reach the\nbuyers at companies that are hiring for a role you sell into.\n            \nSend `jobFilters` and `peopleFilters`. Omit `peopleFilters` to match everyone at the hiring\ncompanies. Kenso limits the search to the hiring set, so a company filter in `peopleFilters` has no effect.\nPage with the `page` and `pageSize` fields of `peopleFilters`.\n            \nTo get the people at each company of a hiring-companies page, send `companyIds`, up to 25\n`ken_search_id` values from that page, and `perCompany`, from 1 to 50 people per company (3 when\nomitted). Kenso then searches each company on its own, so a big company does not crowd out a small one. The\nanswer holds up to `perCompany` people at each company, in the order of `companyIds`, and\n`companies`, with the `companyId` and `totalResults` of each company it searched. A company that is\nnot in the hiring set is not searched and not listed. `totalResults` adds up the companies' totals, and\npaging does not apply.\n            \nThe answer is a people search page, plus `hiringSet` (`count` companies and `truncated`). Each\nperson carries `jobPost`, the role their company is hiring for: `title`, `url`, `location`,\n`postedAt`, `openRoles` and `moreRoles`. When no company is hiring, the page is empty. Each person on\nthe page counts against the workspace's daily `searchBrowseRows` quota.\n            \nErrors:\n            \n- `400 validation_failed`: the body is not a JSON object, `jobFilters` is missing or not an object,\n`peopleFilters` is not an object, `companyIds` is not a list of 1 to 25 ids, `perCompany` is not a\nwhole number from 1 to 50 or comes without `companyIds`, or Search refused the people filters.\n- `401 unauthenticated`: the API key belongs to no member. The search runs as a member.\n- `402 plan_required`: the workspace's plan does not include job post search. `error.refusal` carries\nthe code `PLAN_FEATURE_NOT_AVAILABLE` and the feature `job_post_search`.\n- `402 plan_required`: `peopleFilters` needs funding signals, which the plan lacks (`error.refusal`).\n- `403 forbidden`: Search refused a people filter for this member.\n- `422 filter_required`: `jobFilters` sets no filter.\n- `429 quota_exceeded`: the workspace used its daily `searchBrowseRows` quota.\n- `503 service_unavailable`: job postings or Search are not available right now. Try again.\n            \nRequires Search view.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"job-post-searches.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"}}],"requestBody":{"content":{"application/json":{"schema":{}}}},"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/JobPostSearchPeopleResultsResponse"}}}},"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":["forbidden"]},"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":["filter_required"]},"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":240,"windowSeconds":60,"per":"api_key"}}},"/v1/job-post-searches/people/count":{"post":{"tags":["job-post-searches"],"summary":"Count people at hiring companies","description":"Count the people at the companies hiring for your job filters, without returning them. Use it to size an import.\n            \nSend the same `jobFilters` and `peopleFilters` as `POST /v1/job-post-searches/people`. The answer\nholds `totalResults` and `hiringSet`. Counting does not use the `searchBrowseRows` quota.\n            \nErrors:\n            \n- `400 validation_failed`: the body is not a JSON object, `jobFilters` is missing or not an object,\n`peopleFilters` is not an object, or Search refused the people filters.\n- `401 unauthenticated`: the API key belongs to no member.\n- `402 plan_required`: the workspace's plan does not include job post search. `error.refusal` carries\nthe code `PLAN_FEATURE_NOT_AVAILABLE` and the feature `job_post_search`.\n- `402 plan_required`: `peopleFilters` needs funding signals, which the plan lacks (`error.refusal`).\n- `403 forbidden`: Search refused a people filter for this member.\n- `422 filter_required`: `jobFilters` sets no filter.\n- `503 service_unavailable`: job postings or Search are not available right now. Try again.\n            \nRequires Search view.\n\nRate limit: 240 calls a minute per API key, on top of the workspace limits.","operationId":"job-post-searches.count","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":{}}}},"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/JobPostSearchPeopleCountResponse"}}}},"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":["forbidden"]},"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":["filter_required"]},"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":240,"windowSeconds":60,"per":"api_key"}}},"/v1/job-post-searches/import":{"post":{"tags":["job-post-searches"],"summary":"Import people at hiring companies","description":"Add the people at the companies hiring for your job filters to a campaign as contacts. Each contact gets the\nfive hiring variables, filled from its company's newest matching posting and its number of matching postings.\n            \nSend `jobFilters`, `peopleFilters`, `campaignId` (required) and `importLimit`, a positive\nwhole number that caps how many people Kenso imports. A lookalike search cannot be imported this way.\n            \nThe import runs in the background. The answer holds `jobId`: poll\n`GET /v1/search/imports/{importId}` with it.\n            \nErrors:\n            \n- `400 validation_failed`: the body is not valid, `campaignId` is missing, `importLimit` is not a\npositive whole number, or no company is hiring for the job filters (detail code `empty_hiring_set`).\n- `400 lookalike_not_storable`: `peopleFilters` 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.\n- `401 unauthenticated`: the API key belongs to no member. An import runs as a member.\n- `402 plan_required`: the workspace's plan does not include job post search. `error.refusal` carries\nthe code `PLAN_FEATURE_NOT_AVAILABLE` and the feature `job_post_search`.\n- `402 plan_required`: `peopleFilters` needs funding signals, which the plan lacks (`error.refusal`).\n- `403 forbidden`: Search refused the import for this member.\n- `404 not_found`: the campaign is not in this workspace.\n- `422 filter_required`: `jobFilters` sets no filter.\n- `503 service_unavailable`: job postings or Search are not available right now. 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":"job-post-searches.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":{}}}},"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/JobPostSearchImportResultResponse"}}}},"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":["forbidden"]},"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":["filter_required"]},"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"}}}},"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."},"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."},"JobPostSearchCompaniesResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchCompanies"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"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."},"JobPostSearchImportResult":{"type":"object","properties":{"jobId":{"type":"integer","description":"The import's id. Poll `GET /v1/search/imports/{importId}` with it.","format":"int64"}},"additionalProperties":false,"description":"A started job post search import."},"JobPostSearchImportResultResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchImportResult"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"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."},"JobPostSearchPeopleCount":{"type":"object","properties":{"totalResults":{"type":"integer","description":"How many people match the people filters at the hiring companies.","format":"int64"},"hiringSet":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchHiringSet"}],"description":"The hiring companies the count covered."}},"additionalProperties":false,"description":"How many people work at the companies hiring for the job filters."},"JobPostSearchPeopleCountResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchPeopleCount"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"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."},"JobPostSearchPeopleResultsResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchPeopleResults"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."},"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."}}}}