{"openapi":"3.0.4","info":{"title":"Kenso API: Saved searches","version":"1.1","description":"The Saved searches 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":"saved-searches","description":"A saved search stores a set of Search filters under a name, so you can run it again later or share it with your\nteam. Each saved search belongs to the member who created it, who can share it with one member or the whole\nworkspace for read, edit or admin access. Every call acts for the member behind your credential, so an API key that\nbelongs to no member gets `401 unauthenticated`.","x-displayName":"Saved searches"}],"paths":{"/v1/saved-searches":{"get":{"tags":["saved-searches"],"summary":"List saved searches","description":"List the saved searches you can see in this workspace: your own, and those shared with you or with the whole\nworkspace.\n            \n`limit` and `cursor` page the list.\n            \nErrors:\n            \n- `400 validation_failed`: `cursor` did not come from `pagination.nextCursor` (detail code\n`invalid_cursor`).\n            \nRequires Search view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"saved-searches.list","parameters":[{"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. Omit it for the first page.","schema":{"type":"string"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"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":12000,"windowSeconds":60,"per":"api_key"}},"post":{"tags":["saved-searches"],"summary":"Create a saved search","description":"Save a set of Search filters under a name. The saved search belongs to you, in this workspace.\n            \nThe body takes:\n            \n- `name`: the name shown in the list.\n- `searchType`: `People` for a people search, `Account` for a company search, or `JobPosts`\nfor a job post search. Any casing works.\n- `filtersJson`: the search body, as a JSON string. For `JobPosts` it must be an object with both\n`jobFilters` and `peopleFilters`, as `POST /v1/job-post-searches/people` takes them.\n- `isShared`: true shares the search with the whole workspace. Omitted means true.\n            \nThe call answers `201` with the saved search and a `Location` header.\n            \nErrors:\n            \n- `400 validation_failed`: `searchType` is unknown or `filtersJson` is not valid for it.\n- `400 lookalike_not_storable`: the filters carry a lookalike filter. A lookalike search is a snapshot, so\nsave its results instead.\n- `402 plan_required`: `filtersJson` 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            \nRequires Search edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"saved-searches.create","parameters":[{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"name":"X-Ken-Workspace-Id","in":"header","description":"The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`.","schema":{"type":"integer","format":"int64"}}],"responses":{"201":{"description":"Created","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/SavedSearchResponse"}}}},"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"]},"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":"edit","summary":"Search edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/saved-searches/{savedSearchId}":{"get":{"tags":["saved-searches"],"summary":"Get a saved search","description":"Get one saved search with its filters and your access to it.\n            \n`filtersJson` holds the saved filters. `permissions` is your access: `read`, `edit` or\n`admin`. `isValid` is false when the saved filters can no longer run, and `invalidReason` then says\nwhy.\n            \nErrors:\n            \n- `403 forbidden`: the saved search is not shared with you.\n- `404 not_found`: no saved search has this id.\n            \nRequires Search view.\n\nRate limit: 12,000 calls a minute per API key, on top of the workspace limits.","operationId":"saved-searches.get","parameters":[{"name":"savedSearchId","in":"path","description":"The saved search's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"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/SavedSearchResponse"}}}},"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"]},"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"]},"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"}},"patch":{"tags":["saved-searches"],"summary":"Update a saved search","description":"Rename a saved search, change its filters, or share it with the whole workspace or stop sharing it.\n            \nSend any of `name`, `filtersJson` and `isShared`. Fields you omit keep their value. You need edit\naccess to the saved search, and admin access to change `isShared`.\n            \nErrors:\n            \n- `400 validation_failed`: `name` is blank or `filtersJson` is not valid.\n- `400 lookalike_not_storable`: the new filters carry a lookalike filter.\n- `402 plan_required`: the new `filtersJson` holds a funding filter (as on `POST /v1/search/people`)\nand the workspace's plan does not include funding signals (`error.refusal` feature `funding_signals`).\n- `403 forbidden`: you lack the access this change needs.\n- `404 not_found`: no saved search has this id.\n            \nRequires Search edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"saved-searches.update","parameters":[{"name":"savedSearchId","in":"path","description":"The saved search's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"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/SavedSearchResponse"}}}},"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"]},"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":"edit","summary":"Search edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}},"delete":{"tags":["saved-searches"],"summary":"Delete a saved search","description":"Delete a saved search you created. Only its owner can delete it. The call answers `204` with no body.\n            \nErrors:\n            \n- `403 forbidden`: you are not the owner.\n- `404 not_found`: no saved search has this id.\n            \nRequires Search edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"saved-searches.delete","parameters":[{"name":"savedSearchId","in":"path","description":"The saved search's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"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":{"204":{"description":"No Content","headers":{"RateLimit-Limit":{"$ref":"#/components/headers/RateLimit-Limit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimit-Remaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimit-Reset"}}},"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"]},"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"]},"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":"edit","summary":"Search edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}},"/v1/saved-searches/{savedSearchId}/run":{"post":{"tags":["saved-searches"],"summary":"Run a saved search","description":"Run a people or company saved search with its saved filters and get the first page of results.\n            \nThe answer holds `savedSearchId`, `searchType`, `totalResults` and `results`, the first 25\nmatches as a people or company search page. Each profile on the page counts against the workspace's daily\n`searchBrowseRows` quota. A `JobPosts` saved search does not run here: send its `jobFilters` and\n`peopleFilters` to `POST /v1/job-post-searches/people`.\n            \nErrors:\n            \n- `400 validation_failed`: the saved filters can no longer run, or the saved search is a `JobPosts`\nsearch.\n- `403 forbidden`: the saved search is not shared with you.\n- `404 not_found`: no saved search has this id.\n- `429 quota_exceeded`: the workspace used its daily `searchBrowseRows` quota.\n            \nRequires Search view.\n\nRate limit: 200 calls a minute per API key, on top of the workspace limits.","operationId":"saved-searches.run","parameters":[{"name":"savedSearchId","in":"path","description":"The saved search's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"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/SavedSearchRunPeopleResponse"},{"$ref":"#/components/schemas/SavedSearchRunCompaniesResponse"}]}}}},"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":["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"]},"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/saved-searches/{savedSearchId}/share":{"post":{"tags":["saved-searches"],"summary":"Share a saved search","description":"Give a member or the whole workspace access to a saved search, or take that access away. You need admin access to\nthe saved search.\n            \nThe body takes:\n            \n- `action`: `grant` (the default) or `revoke`.\n- `targetType`: `user` for one member, or `org` for the whole workspace.\n- `targetId`: the member's user id. Required with `user`. Omit it with `org`.\n- `permission`: `read`, `edit` or `admin`. Required with `grant`.\n            \nGranting or revoking `org` access also sets `isShared`. The answer is the saved search after the change.\n            \nErrors:\n            \n- `400 validation_failed`: a field is missing or not one of the values above.\n- `403 forbidden`: you lack admin access to the saved search.\n- `404 not_found`: no saved search has this id.\n            \nRequires Search edit.\n\nRate limit: 4,800 calls a minute per API key, on top of the workspace limits.","operationId":"saved-searches.share","parameters":[{"name":"savedSearchId","in":"path","description":"The saved search's id.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"Ken-Version","in":"header","description":"The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions.","schema":{"enum":["2026-11-02","1.1"],"type":"string"},"examples":{"default":{"value":"2026-11-02","x-disabled":false}}},{"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/SavedSearchResponse"}}}},"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":["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"]},"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":"edit","summary":"Search edit"},"x-ken-rate-limit":{"limit":4800,"windowSeconds":60,"per":"api_key"}}}},"components":{"securitySchemes":{"Bearer":{"type":"http","description":"Enter: Bearer {your Kenso API key}. Create one in the Kenso app under Settings > Integrations > API Keys.","scheme":"bearer","bearerFormat":"Opaque API key"}},"headers":{"RateLimit-Limit":{"description":"The request limit of the rate limit this request is closest to reaching: your plan's limit for this kind of call, your API key's own limit, or the operation's own limit, whichever has the fewest requests left.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"The requests left under that limit. `0` on a `429`.","schema":{"type":"integer"}},"RateLimit-Reset":{"description":"The seconds until that limit resets.","schema":{"type":"integer"}}},"schemas":{"ApiKeyError":{"required":["error"],"type":"object","properties":{"error":{"type":"string","description":"A sentence for people that says what went wrong. It can change, so do not parse it."}},"additionalProperties":false,"description":"The body the API key check in front of the operations answered until November 2026, instead of the error body (`Failure`): `{ \"error\": \"Invalid or revoked API key\" }` on a `401`, `{ \"error\": \"Rate limit exceeded\" }` on a `429` and `{ \"error\": \"Authentication is temporarily unavailable\" }` on a `503`. It has no `code`, so branch on the HTTP status."},"ErrorAccount":{"type":"object","properties":{"accountId":{"type":"integer","description":"The account's id.","format":"int64"},"name":{"type":"string","description":"The account's name."},"stakeholderId":{"type":"integer","description":"The person's stakeholder id on this account.","format":"int64"}},"additionalProperties":false,"description":"An account named in an error detail."},"ErrorBody":{"type":"object","properties":{"code":{"type":"string","description":"Stable error code, such as `validation_failed` or `not_found`. Branch on this value."},"message":{"type":"string","description":"A sentence for people that explains the error. It can change, so do not parse it."},"details":{"type":"array","items":{"$ref":"#/components/schemas/ErrorDetail"},"description":"One entry per problem, naming the field or limit it is about. Omitted when there are none.","nullable":true},"requestId":{"type":"string","description":"The id of this request: the same value as the `X-Correlation-Id` response header. Quote it when you write\nto contact@ken.so."},"docUrl":{"type":"string","description":"The page on this code in the developer docs, which says what it means and how to fix it. The errors guide for a\ncode that has no page of its own.","readOnly":true},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"On a `402`, the plan rule or usage limit that refused the request and how to lift it. Omitted otherwise."},"impact":{"allOf":[{"$ref":"#/components/schemas/InvalidationImpact"}],"description":"On a `409` that refuses a change because it would clear stored AI output (a prompt edit, a restore or a\nreset), how much the change would clear. Omitted otherwise."},"surface":{"type":"string","description":"Set only by the voice ticket's `409` (code `voice_conversation_active`): the chat the person's other\nvoice conversation runs in, `support`, `ken` or `onboarding`. Omitted on every other error.","nullable":true}},"additionalProperties":false,"description":"What went wrong in a request."},"ErrorDetail":{"type":"object","properties":{"field":{"type":"string","description":"The request field, header or limit the problem is about, such as `name` or `Ken-Version`."},"code":{"type":"string","description":"Stable code for this problem, such as `required` or `invalid`."},"message":{"type":"string","description":"A sentence for people that explains this problem."},"count":{"type":"integer","description":"On `export_limit_exceeded`, how many rows match the export. Omitted otherwise.","format":"int32","nullable":true},"index":{"type":"integer","description":"The position of the refused item in the request's list. Omitted otherwise.","format":"int32","nullable":true},"limit":{"type":"integer","description":"On `export_limit_exceeded`, the row limit the export ran with. On a `quota_exceeded` detail whose\n`field` names a quota, that quota's limit. On a `rate_limited` detail from your workspace's rate\nlimits, the limit that was hit. Omitted otherwise.","format":"int32","nullable":true},"resetAt":{"type":"string","description":"On some `quota_exceeded` details, when the quota frees up, in UTC. It is the same instant as the top-level\n`quotaResetAt`. On a `rate_limited` detail from your workspace's rate limits, when that limit resets.\nOmitted otherwise.","format":"date-time","nullable":true},"retryAfterSeconds":{"type":"integer","description":"On those `quota_exceeded` details and on most `rate_limited` details, the seconds to wait. It is the\nsame value as the `Retry-After` header. Omitted otherwise.","format":"int32","nullable":true},"inboxId":{"type":"integer","description":"The inbox the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainId":{"type":"integer","description":"The domain the problem is about. Omitted otherwise.","format":"int64","nullable":true},"domainName":{"type":"string","description":"The name of that domain, or the domain name the request gave. Omitted otherwise.","nullable":true},"accountId":{"type":"integer","description":"On `domain_taken`, `already_stakeholder` and `previously_removed`, the existing account to use\ninstead. Omitted otherwise.","format":"int64","nullable":true},"personId":{"type":"integer","description":"On `email_taken` and `linkedin_url_taken`, the existing person to use instead. Omitted otherwise.","format":"int64","nullable":true},"stakeholderId":{"type":"integer","description":"The account stakeholder the problem is about. Omitted otherwise.","format":"int64","nullable":true},"championId":{"type":"integer","description":"Not used. Always omitted.","format":"int64","nullable":true},"callTaskId":{"type":"integer","description":"On `call_task_exists`, the open call task that already holds the person's slot. Omitted otherwise.","format":"int64","nullable":true},"status":{"type":"string","description":"On `invalid_transition`, the current status. Omitted otherwise.","nullable":true},"allowed":{"type":"array","items":{"type":"string"},"description":"On `out_of_range`, the allowed values. On `invalid_transition`, the statuses the change is allowed\nfrom. Omitted otherwise.","nullable":true},"scope":{"type":"string","description":"On a `permission_denied` for an account owner change, the account scope the call needs (`all`). On\n`sending_paused`, what the pause covers: `inbox`, `domain` or `workspace`. Omitted otherwise.","nullable":true},"removedAt":{"type":"string","description":"On `previously_removed`, when a person removed the stakeholder, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"page":{"type":"string","description":"On `permission_denied`, the page the call needs, such as `campaigns`. Omitted otherwise.","nullable":true},"required":{"type":"string","description":"On `permission_denied`, the access `page` needs: `view` or `edit`. Omitted otherwise.","nullable":true},"feature":{"type":"string","description":"On `permission_denied`, the permission the call needs, such as `launch`. Omitted otherwise.","nullable":true},"runId":{"type":"integer","description":"On `committee_run_active` and `run_not_finding`, the committee run the problem is about. Omitted\notherwise.","format":"int64","nullable":true},"mergedIntoId":{"type":"integer","description":"On `person_merged`, the person the merged person now lives on. On `account_merged`, the account the\nmerged account now lives on. Omitted otherwise.","format":"int64","nullable":true},"accounts":{"type":"array","items":{"$ref":"#/components/schemas/ErrorAccount"},"description":"On `person_on_accounts`, the accounts that block the change. Omitted otherwise.","nullable":true},"stage":{"type":"string","description":"On `stage_in_use` and `system_stage`, the opportunity stage key the problem is about. Omitted otherwise.","nullable":true},"opportunityCount":{"type":"integer","description":"On `stage_in_use`, how many opportunities are in that stage. Omitted otherwise.","format":"int32","nullable":true},"rule":{"type":"string","description":"On `guardrail_violation`, the contact limit rule the change breaks. Omitted otherwise.","nullable":true},"nextAllowedAt":{"type":"string","description":"On `guardrail_violation`, the first `dueAt` that passes every contact limit, in UTC. On a refused\nsend, when to retry. Omitted otherwise, and when waiting does not clear it.","format":"date-time","nullable":true},"fix":{"type":"string","description":"On a refused send, what to do next, in plain words. Omitted otherwise.","nullable":true},"opensAt":{"type":"string","description":"On `outside_calling_hours`, when the person's calling window opens, in UTC. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"On a knowledge file's `version_conflict`, the file's current version. Omitted otherwise.","format":"int32","nullable":true},"provider":{"type":"string","description":"On a CRM connection error (`provider_error`, `exchange_failed`, `already_connected`,\n`account_mismatch` or `provider_unavailable`), the CRM it is about. Omitted otherwise.","nullable":true},"sharedWithMaster":{"type":"boolean","description":"True on a `quota_exceeded` detail when the shared limit of the white-label master workspace was hit, so\n`limit` is the limit of the whole white-label account. Omitted otherwise. The master's id is never sent.","nullable":true},"stepId":{"type":"integer","description":"On `link_reputation_blocked`, the saved sequence step that holds the blocked link. Omitted otherwise, and\nfor a step the save would have created.","format":"int64","nullable":true},"stepOrder":{"type":"integer","description":"On `link_reputation_blocked`, the `stepOrder` of that step. Omitted otherwise.","format":"int32","nullable":true},"url":{"type":"string","description":"On `link_reputation_blocked`, the blocked link as the step's copy writes it. Omitted otherwise.","nullable":true},"key":{"type":"string","description":"On `unfilled_template_key`, the template key the text still holds, such as `first_name` for\n`{first_name}`. Omitted otherwise.","nullable":true},"marker":{"type":"string","description":"On `unfilled_template_key`, that key as the text writes it, such as `{first_name}` or `[company]`.\nOmitted otherwise.","nullable":true},"retryAt":{"type":"string","description":"On a warm path Start's `guardrail_connector_monthly`, `guardrail_account_monthly`,\n`guardrail_connector_cooldown` and `guardrail_handoff_weekly`, when the limit frees up, in UTC. Omitted\notherwise.","format":"date-time","nullable":true},"workspaceId":{"type":"integer","description":"On `last_admin`, a workspace that needs a new admin before the account can be deleted. On\n`new_admin_not_found`, the workspace of the refused choice. Omitted otherwise.","format":"int64","nullable":true},"workspaceName":{"type":"string","description":"On `last_admin`, the name of that workspace. Omitted otherwise.","nullable":true},"class":{"type":"string","description":"On a `rate_limited` detail from your workspace's rate limits, the class of call that hit its limit:\n`read`, `write`, `bulk`, `heavy` or `sensitive`. Omitted otherwise.","nullable":true},"window":{"type":"string","description":"On that detail, the window whose limit was hit: `minute`, `day` or `bulkItemsDay`. Omitted\notherwise.","nullable":true}},"additionalProperties":false,"description":"One problem in an error: the field or limit it is about, a stable `code` and a `message`. The other fields\nappear only with the codes their descriptions name."},"Failure":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false on an error."},"error":{"allOf":[{"$ref":"#/components/schemas/ErrorBody"}],"description":"What went wrong."},"quotaResetAt":{"type":"string","description":"When the quota that refused the request frees up, in UTC. Set on some quota refusals. Omitted otherwise.","format":"date-time","nullable":true},"currentVersion":{"type":"integer","description":"The current revision of a workflow draft, on a draft save's `409 version_conflict`. Read the workflow\nagain, then send this value as `baseVersion`. Omitted otherwise.","format":"int32","nullable":true},"current":{"allOf":[{"$ref":"#/components/schemas/MeetingRepNotesCurrent"}],"description":"Your meeting notes and their version as stored now, on a meeting notes save's `409 version_conflict`.\nMerge your change, then save again with `baseVersion` set to `current.repNotesVersion`. Omitted\notherwise."},"refusal":{"allOf":[{"$ref":"#/components/schemas/Refusal"}],"description":"A copy of `error.refusal`, set on some billing refusals. Omitted otherwise."},"message":{"type":"string","description":"A copy of `error.message`, set together with `refusal`. Omitted otherwise.","nullable":true},"lookalikeSeeds":{"description":"How Kenso read each seed of a lookalike search, on its `422 no_usable_seeds`:\n`{resolved: [{input, companyId, personId, name, domain}], unresolved: [{input, reason}]}`. Use it to show\nwhy no seed was usable. Omitted otherwise."}},"additionalProperties":false,"description":"The body of every error, with a 4xx or 5xx status. Branch on `error.code`."},"InvalidationImpact":{"type":"object","properties":{"qualificationResponses":{"type":"integer","description":"Stored qualification answers the change would clear.","format":"int32"},"qualifiedFlags":{"type":"integer","description":"Contacts whose qualified result the change would clear.","format":"int32"},"segmentationReasoning":{"type":"integer","description":"Stored segmentation explanations the change would clear.","format":"int32"},"segmentationAssignmentsKept":{"type":"integer","description":"Contacts that keep their segment.","format":"int32"},"segmentationAssignmentsReset":{"type":"integer","description":"Contacts that go back to the default segment.","format":"int32"},"personalizationLines":{"type":"integer","description":"Personalized lines the change would clear.","format":"int32"},"personalizationLeads":{"type":"integer","description":"Contacts that would lose their personalized lines.","format":"int32"},"rewritingLines":{"type":"integer","description":"Rewritten lines the change would clear.","format":"int32"},"rewritingLeads":{"type":"integer","description":"Contacts that would lose their rewritten lines.","format":"int32"}},"additionalProperties":false,"description":"How much stored AI output a change would clear in each AI step of a campaign, and how many segment assignments it\nkeeps or resets."},"MeetingRepNotesCurrent":{"type":"object","properties":{"repNotes":{"type":"string","description":"Your notes as stored now. Empty before your first save."},"repNotesVersion":{"type":"integer","description":"The stored notes' version. Send it as `baseVersion` when you save again.","format":"int32"}},"additionalProperties":false,"description":"Your meeting notes as Kenso stores them now, sent with a `409 version_conflict` on a notes save."},"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."},"SavedSearch":{"type":"object","properties":{"id":{"type":"integer","description":"The saved search's id.","format":"int64"},"clientId":{"type":"string","description":"The id of the workspace the saved search belongs to, as a string.","nullable":true},"userId":{"type":"string","description":"The Kenso user id of the member who created the saved search, as a string.","nullable":true},"ownerId":{"type":"string","description":"The Kenso user id of the saved search's owner, its creator, as a string.","nullable":true},"ownerName":{"type":"string","description":"The owner's display name, or their user id when Kenso has no name for them.","nullable":true},"name":{"type":"string","description":"The name shown in the list.","nullable":true},"searchType":{"type":"string","description":"What the filters search: `People`, `Account` (companies), `JobPosts` or `Places`.","nullable":true},"filtersJson":{"type":"string","description":"The saved filters: the search body, as a JSON-encoded string.","nullable":true},"resultCount":{"type":"integer","description":"How many matches the filters had when the saved search last ran. Null when it never ran, or since the filters\nchanged.","format":"int64","nullable":true},"currentCount":{"type":"integer","description":"Not filled: always null.","format":"int64","nullable":true},"isShared":{"type":"boolean","description":"True when the saved search is shared with the whole workspace."},"sharedWithMe":{"type":"boolean","description":"True when the saved search is someone else's and you have access to it."},"orgWide":{"type":"boolean","description":"True when the whole workspace has access to the saved search."},"permissions":{"type":"string","description":"Your access to the saved search: `read`, `edit`, `admin` or `none`.","nullable":true},"createdAt":{"type":"string","description":"When the saved search was created, in UTC. ISO 8601, such as `2026-11-15T10:00:00`, with or without a\ntrailing `Z`.","nullable":true},"cachedAt":{"type":"string","description":"When `resultCount` was last counted, in UTC. ISO 8601, such as `2026-11-15T10:00:00`, with or without\na trailing `Z`. Null when it never was, or since the filters changed.","nullable":true},"lastExecutedAt":{"type":"string","description":"When the saved search last ran, in UTC. ISO 8601, such as `2026-11-15T10:00:00`, with or without a\ntrailing `Z`. Null when it never ran, or since the filters changed.","nullable":true},"isValid":{"type":"boolean","description":"False when the saved filters can no longer run. `invalidReason` then says why."},"invalidReason":{"type":"string","description":"Why the saved filters can no longer run: `technology_filters_retired`, `unknown_filter_fields` or\n`web_tech_filters_disabled`. Null when they can.","nullable":true}},"additionalProperties":false,"description":"A saved search: a set of Search filters stored under a name, with your access to it."},"SavedSearchResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SavedSearch"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SavedSearchRunCompanies":{"type":"object","properties":{"savedSearchId":{"type":"integer","description":"The saved search's id.","format":"int64"},"searchType":{"allOf":[{"$ref":"#/components/schemas/SavedSearchRunCompaniesType"}],"description":"The kind of saved search: `Account`, a company search."},"totalResults":{"type":"integer","description":"How many companies match the saved filters in all.","format":"int64"},"results":{"allOf":[{"$ref":"#/components/schemas/SearchCompaniesResults"}],"description":"The first page of the company search, up to 25 companies."}},"additionalProperties":false,"description":"The first page of a company saved search, run with its saved filters."},"SavedSearchRunCompaniesResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SavedSearchRunCompanies"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SavedSearchRunCompaniesType":{"enum":["Account"],"type":"string","description":"The kind of a company saved search. Ken Search writes its `SearchType.Account` member's name."},"SavedSearchRunPeople":{"type":"object","properties":{"savedSearchId":{"type":"integer","description":"The saved search's id.","format":"int64"},"searchType":{"allOf":[{"$ref":"#/components/schemas/SavedSearchRunPeopleType"}],"description":"The kind of saved search: `People`."},"totalResults":{"type":"integer","description":"How many people match the saved filters in all.","format":"int64"},"results":{"allOf":[{"$ref":"#/components/schemas/SavedSearchRunPeoplePage"}],"description":"The first page of the people search, up to 25 people."}},"additionalProperties":false,"description":"The first page of a people saved search, run with its saved filters."},"SavedSearchRunPeoplePage":{"type":"object","properties":{"totalResults":{"type":"integer","description":"How many people match the saved filters in all.","format":"int64"},"page":{"type":"integer","description":"The page number: always 1.","format":"int32"},"pageSize":{"type":"integer","description":"The most people the page holds: always 25.","format":"int32"},"searchAfter":{"type":"string","description":"The cursor of the next page. 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/SavedSearchRunPerson"},"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`.","nullable":true},"lookalikeSeeds":{"type":"object","allOf":[{"$ref":"#/components/schemas/SearchPeopleLookalikeSeeds"}],"description":"How each lookalike seed resolved. Present only when the saved filters hold a lookalike filter.","nullable":true}},"additionalProperties":false,"description":"The first page of a people saved search."},"SavedSearchRunPeopleResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"Always true on a success."},"data":{"allOf":[{"$ref":"#/components/schemas/SavedSearchRunPeople"}],"description":"The result of the operation."}},"additionalProperties":false,"description":"The body of a successful operation that returns one result. The result is in `data`."},"SavedSearchRunPeopleType":{"enum":["People"],"type":"string","description":"The kind of a people saved search."},"SavedSearchRunPerson":{"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}},"additionalProperties":false,"description":"A person on a saved search's first page, as Ken Search writes 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."},"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."},"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."},"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."},"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."},"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."},"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."}}}}