{ "openapi": "3.0.4", "info": { "title": "Company Enrich API v2", "description": "The Company Enrich API v2 provides programmatic access to company and person data for enrichment, search, and lead generation.\n\n## Key Features\n\n- **Company Enrichment** — Enrich company profiles by domain or identifying properties, and retrieve stored companies by ID.\n- **Company Search** — Search and filter companies with cursor pagination, counts, and previews.\n- **Semantic and Lookalike Search** — Find companies using natural-language queries or similar company domains.\n- **People Enrichment** — Retrieve people by ID, identify people from their email address, and find work email addresses.\n- **People Search** — Search people by position, seniority, department, location, education, and company with cursor pagination, counts, and previews.\n- **Reference Data** — Look up industries, geographic data, keywords, technologies, and job titles.\n\nV2 intentionally excludes saved company lists, list-based exports, and filtering searches by saved-list IDs. These features remain available in V1 and are not planned for V2.\n\n## Authentication\n\nAll API requests require a Bearer token passed in the `Authorization` header:\n\n```\nAuthorization: Bearer YOUR_API_TOKEN\n```\n\nYou can generate API tokens from your [dashboard](https://companyenrich.com/dashboard).\n\n## Credits\n\nMost API calls consume credits. The credit cost for each endpoint is documented in its description. You can check your remaining credit balance using the User endpoint.\n\n## Rate Limiting\n\nThe global API limiter allows **500 requests per minute** per IP address. Authenticated API routes also use a per-user route limiter based on plan capabilities.\nSupplementary lookup endpoints (such as keyword/technology/industry autocompletes) use a separate per-user route-level bucket.", "termsOfService": "https://companyenrich.com/terms-and-conditions", "contact": { "url": "https://companyenrich.com/", "email": "support@companyenrich.com" }, "version": "2.0.0" }, "servers": [ { "url": "https://api.companyenrich.com" } ], "paths": { "/v2/companies/{companyId}": { "get": { "tags": [ "Company / Enrichment" ], "summary": "Get a company by ID", "description": "**Cost:** 1 credit per company returned, plus requested paid expansions.\n\nEach requested expansion (`financial`, `keywords`, `naicsCodes`, `technologies`, or `workforce`) adds 1 credit per returned company. `workforce` includes the latest 12 months of history. Use its `nextCursor` with `GET /v2/companies/workforce` to retrieve each preceding 12-month page for another 1 credit. Repeating an expansion does not multiply its cost.\n\nRetrieves stored company data using its CompanyEnrich ID. You can obtain this ID from enrichment or search results.\n\nReturns `404` without charging credits when the company cannot be found.", "parameters": [ { "name": "companyId", "in": "path", "description": "The CompanyEnrich ID of the company to retrieve", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expand", "in": "query", "description": "Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:\n\n- `financial`: 1 credit\n- `keywords`: 1 credit\n- `naicsCodes`: 1 credit\n- `technologies`: 1 credit\n- `workforce`: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from `GET /v2/companies/workforce` costs another 1 credit.", "schema": { "type": "array", "items": { "enum": [ "financial", "keywords", "naicsCodes", "technologies", "workforce" ], "type": "string" } } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/enrich": { "get": { "tags": [ "Company / Enrichment" ], "summary": "Enrich a company by domain", "description": "**Cost:** 1 credit per successful enrichment, plus requested paid expansions.\n\nEach requested expansion (`financial`, `keywords`, `naicsCodes`, `technologies`, or `workforce`) adds 1 credit per returned company. `workforce` includes the latest 12 months of history. Use its `nextCursor` with `GET /v2/companies/workforce` to retrieve each preceding 12-month page for another 1 credit. Repeating an expansion does not multiply its cost.\n\nEnriches a company using its domain name. Domain lookup is the preferred enrichment method.\n\nSet `waitForEnrichment` to `false` to return stored company data immediately. When the company is not stored yet, the endpoint returns `404` without charging credits and schedules enrichment in the background when eligible.", "parameters": [ { "name": "domain", "in": "query", "description": "The company domain to enrich", "required": true, "schema": { "maxLength": 1024, "type": "string" } }, { "name": "expand", "in": "query", "description": "Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:\n\n- `financial`: 1 credit\n- `keywords`: 1 credit\n- `naicsCodes`: 1 credit\n- `technologies`: 1 credit\n- `workforce`: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from `GET /v2/companies/workforce` costs another 1 credit.", "schema": { "type": "array", "items": { "enum": [ "financial", "keywords", "naicsCodes", "technologies", "workforce" ], "type": "string" } } }, { "name": "waitForEnrichment", "in": "query", "description": "Whether to wait for on-demand enrichment when the company is not stored yet. When false, a miss schedules background enrichment when eligible.", "schema": { "type": "boolean", "default": true } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Company / Enrichment" ], "summary": "Enrich a company by properties", "description": "**Cost:** 1 credit when a company is returned or when the properties cannot resolve a company domain. Paid expansions are charged only when returned.\n\nEach requested expansion (`financial`, `keywords`, `naicsCodes`, `technologies`, or `workforce`) adds 1 credit per returned company. `workforce` includes the latest 12 months of history. Use its `nextCursor` with `GET /v2/companies/workforce` to retrieve each preceding 12-month page for another 1 credit. Repeating an expansion does not multiply its cost.\n\nResolves and enriches a company using one or more identifying properties. When several properties are provided, all of them must match. If several companies match, the highest-ranked company is used.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyEnrichV2Request" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/enrich/batch": { "post": { "tags": [ "Company / Enrichment" ], "summary": "Enrich companies by domain in batch", "description": "**Cost:** 1 credit per unique company returned, plus requested paid expansions.\n\nEach requested expansion (`financial`, `keywords`, `naicsCodes`, `technologies`, or `workforce`) adds 1 credit per returned company. `workforce` includes the latest 12 months of history. Use its `nextCursor` with `GET /v2/companies/workforce` to retrieve each preceding 12-month page for another 1 credit. Repeating an expansion does not multiply its cost.\n\nEnriches up to 50 companies by domain in a single request. `items` contains one result per requested domain, in request order. Each result has a `status` of `found`, `not-found`, `invalid-domain`, or `pending`; only `found` results include `company` and consume credits.\n\nDuplicate domains are enriched once and share the same result. Domains that resolve to the same company are charged once.\n\nSet `waitForEnrichment` to `false` to return stored companies immediately. Companies that are not stored yet get the `pending` status and are scheduled for background enrichment when eligible.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyBatchEnrichV2Request" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyBatchEnrichV2Response" } } } } } } }, "/v2/companies/autocomplete": { "get": { "tags": [ "Company / Enrichment" ], "summary": "Autocomplete companies", "description": "Returns up to 10 companies whose domain matches the query in `items`: an exact domain match first, then domains that start with the query, then other matches, each ordered by company rank. A leading `www.` is ignored. A URL query is reduced to its host name. An empty query returns an empty list. No credits are deducted.", "parameters": [ { "name": "query", "in": "query", "description": "The domain prefix or URL to look up. At most 100 characters; surrounding whitespace is ignored.", "required": true, "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportListResponseOfCompanyAutocompleteResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/enrich/bulk": { "post": { "tags": [ "Company / Bulk Enrichment" ], "summary": "Enrich company domains asynchronously", "description": "Creates one API request per input domain, preserving input order and duplicates. Requires an API key. Requests use the ordinary V2 enrichment price and requested expansions; completed results become downloadable after their charges settle. Returns `402` unless the available balance covers every domain at that price; credits are not reserved. The request body must be UTF-8 JSON of at most 10 MiB.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyBulkEnrichmentRequest" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Payload Too Large", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "415": { "description": "Unsupported Media Type", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/search/export": { "post": { "tags": [ "Company / Search Export" ], "summary": "Export a company search asynchronously", "description": "Pages through a company search in the background, up to `limit` results, and stores the records for download. The query is the same as `POST /v2/companies/search`, without `pageSize` and `cursor`. Requires an API key. Each page is an ordinary search request at the normal per-record price, with the requested expansions; the last page asks only for the results still missing, and results whose record is unavailable are skipped. There is no upfront balance check: a failed page, such as a `402` once credits run out, stops the export, and the records already exported stay downloadable. `limit` cannot exceed your plan's search limit. `GET /v2/batches/{id}` reports progress with `recordCount` and `recordLimit`, and `resultsUrl` downloads the records.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchExportRequest" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/people/search/export": { "post": { "tags": [ "People / Search Export" ], "summary": "Export a people search asynchronously", "description": "Pages through a people search in the background, up to `limit` results, and stores the records for download. The query is the same as `POST /v2/people/search`, without `pageSize` and `cursor`. Requires an API key. Each page is an ordinary search request at the normal per-record price, with the requested expansions; the last page asks only for the results still missing, and results whose record is unavailable are skipped. There is no upfront balance check: a failed page, such as a `402` once credits run out, stops the export, and the records already exported stay downloadable. `limit` cannot exceed your plan's search limit. `GET /v2/batches/{id}` reports progress with `recordCount` and `recordLimit`, and `resultsUrl` downloads the records. Exports that expand `company` request 25 people per page, since a page can expand at most 500 unique companies.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchExportRequest" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchStatusResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "503": { "description": "Service Unavailable", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/enrich/bulk/{id}/results": { "get": { "tags": [ "Company / Bulk Enrichment" ], "summary": "Download company enrichment results", "description": "Streams one record per eligible input domain, in input order, including errors. Choose the format with `format`. JSON returns one document whose `results` array holds the records; NDJSON returns one record per line. Each record has the input index and domain, the HTTP status, the request state, a success flag, and either the V2 company in `company` or the error in `error`. CSV has one row per record with the columns `index`, `input_domain`, `status_code`, `request_state`, `success` and `error`, followed by the company columns. Each download captures a fixed snapshot; later downloads can include newly settled results. Requires the batch owner's credentials, or the signature from `resultsUrl` in a status response.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "description": "Download format: json, ndjson, or csv. Defaults to json.", "schema": { "type": "string" } }, { "name": "sig", "in": "query", "description": "The signature from a download URL in a status response. Not needed with the batch owner's credentials.", "schema": { "maxLength": 1024, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyBulkEnrichmentResultsResponse" } }, "application/x-ndjson": { "schema": { "$ref": "#/components/schemas/CompanyBulkEnrichmentResult" } }, "text/csv": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/search/export/{id}/results": { "get": { "tags": [ "Company / Search Export" ], "summary": "Download company search export results", "description": "Streams the companies of every settled page, in search result order. Choose the format with `format`. JSON returns one document whose `results` array holds the records; NDJSON returns one record per line. Each record has its zero-based `index`, the V2 company in `company`, and the ranking `score` for lookalike searches. CSV has one row per company with the columns `index` and `score`, followed by the company columns. Failed pages add no records; see the batch status or raw results. Each download captures a fixed snapshot; later downloads can include newly settled pages. Requires the batch owner's credentials, or the signature from `resultsUrl` in a status response.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "description": "Download format: json, ndjson, or csv. Defaults to json.", "schema": { "type": "string" } }, { "name": "sig", "in": "query", "description": "The signature from a download URL in a status response. Not needed with the batch owner's credentials.", "schema": { "maxLength": 1024, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchExportResultsResponse" } }, "application/x-ndjson": { "schema": { "$ref": "#/components/schemas/CompanySearchExportResult" } }, "text/csv": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/people/search/export/{id}/results": { "get": { "tags": [ "People / Search Export" ], "summary": "Download people search export results", "description": "Streams the people of every settled page, in search result order. Choose the format with `format`. JSON returns one document whose `results` array holds the records; NDJSON returns one record per line. Each record has its zero-based `index` and the V2 person in `person`. CSV has one row per person with the columns `index`, `id`, `name`, `first_name`, `last_name`, `position`, `seniority`, `department`, `linkedin_url`, `country`, `address`, `current_company_name` and `current_company_domain`. Failed pages add no records; see the batch status or raw results. Each download captures a fixed snapshot; later downloads can include newly settled pages. Requires the batch owner's credentials, or the signature from `resultsUrl` in a status response.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "format", "in": "query", "description": "Download format: json, ndjson, or csv. Defaults to json.", "schema": { "type": "string" } }, { "name": "sig", "in": "query", "description": "The signature from a download URL in a status response. Not needed with the batch owner's credentials.", "schema": { "maxLength": 1024, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchExportResultsResponse" } }, "application/x-ndjson": { "schema": { "$ref": "#/components/schemas/PersonSearchExportResult" } }, "text/csv": { "schema": { "type": "string" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/workforce": { "get": { "tags": [ "Company / Enrichment" ], "summary": "Get company workforce insights", "description": "**Cost:** 1 credit per successful page, including each earlier year of history.\n\nProvide exactly one lookup parameter: `id` or `domain`. Returns current observed employee count, employee range, and department headcounts, together with the latest 12 months of workforce history.\n\nPass `nextCursor` from this endpoint or a company's `workforce` expansion with the same company to retrieve the preceding 12-month page. Cursors expire 30 minutes after the first page.\n\nInvalid cursors and missing companies or historical pages do not consume credits.", "parameters": [ { "name": "id", "in": "query", "description": "The CompanyEnrich company ID. Provide exactly one of id or domain.", "schema": { "type": "string", "format": "uuid" } }, { "name": "domain", "in": "query", "description": "The company domain. Provide exactly one of id or domain.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "cursor", "in": "query", "description": "The nextCursor from a previous workforce response or company expansion. Omit for the latest 12 months.", "schema": { "maxLength": 1024, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyWorkforceResponse2" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/search": { "post": { "tags": [ "Company / Search" ], "summary": "Search companies", "description": "Search companies using filters, a natural-language query, or lookalike seed domains.\n\nStandard search costs 1 credit per returned company, semantic search costs 2, and lookalike search costs 5, plus requested paid expansions. Empty results cost one result's base price.\n\nEach requested expansion (`financial`, `keywords`, `naicsCodes`, `technologies`, or `workforce`) adds 1 credit per returned company. `workforce` includes the latest 12 months of history. Use its `nextCursor` with `GET /v2/companies/workforce` to retrieve each preceding 12-month page for another 1 credit. Repeating an expansion does not multiply its cost.\n\nThe request can contain standard filters, a semantic query, or lookalike seed companies. Filters can be combined with either search mode, but semantic and lookalike searches cannot be combined.\n\nSemantic queries infer company attributes by default. For example, `saas companies in Turkey` filters companies in Turkey and ranks companies categorized as SaaS higher. Inferred location, employee, founded year, and funding values filter results. Inferred company names, categories, and revenue rank matching companies higher without excluding others; a company the query names, such as `Monzo` in `Monzo digital bank`, ranks first. Request filters that include values take precedence over inferred values of the same kind; request exclusions apply together with inferred values. The response `interpretation` reports what was inferred. Set `semantic.autoFilter` to `false` to disable inference.\n\nSend an empty object (`{}`) to search without filters.\n\nResults use cursor pagination. Omit `cursor` for the first page and pass a cursor returned by the previous response to continue. Numbered pagination is not supported.\n\nKeep the same query when continuing a search. Cursors expire 24 hours after the first page. Lookalike searches reorder the first 150 matches; subsequent matches retain their original order. Preserve the returned order rather than sorting all results by score.\n\nA value filter supports these input forms:\n\n- match one value: `\"TR\"`\n- match several values using the field's default rule: `[\"TR\", \"US\"]`\n- configure advanced matching rules: `{ \"in\": [\"TR\"], \"notIn\": [\"US\"] }`\n\nA single value or array matches any provided value for scalar fields, NAICS codes, and funding rounds. For keywords, technologies, categories, and required features, every provided value must match. The object form can select another supported matching rule explicitly.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchV2Request" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchV2Response" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/search/count": { "post": { "tags": [ "Company / Search" ], "summary": "Count matching companies", "description": "Counts companies using the same filters, semantic query, and lookalike query as the search endpoint, without pagination or response expansions. Send an empty object (`{}`) to count companies without filters.\n\nThis endpoint does not consume credits. `count` is limited by the current plan; `total` is the matching search population before plan limits. Semantic and lookalike totals refer to the vector search candidate pool. Semantic queries infer company attributes as in search and report them in `interpretation`.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchQuery2" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchCountV2Response" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/companies/search/preview": { "post": { "tags": [ "Company / Search" ], "summary": "Preview matching companies", "description": "Returns up to 25 company summaries using the same filters and ranking as search, without pagination or response expansions. Send an empty object (`{}`) to preview companies without filters.\n\nRequires a plan with company previews and does not consume credits. Lookalike previews use the same first-150 reranking as search.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchQuery2" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchPreviewV2Response" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/people/search": { "post": { "tags": [ "People / Search" ], "summary": "Search people", "description": "Search people using person filters, a natural-language query, and an optional company query.\n\n**Cost:** 2 credits per returned person, plus requested paid expansions. Empty results cost one result's base price.\n\nThe `education` expansion adds 1 credit per returned person. Repeating an expansion does not multiply its cost.\n\nThe `company` expansion includes the standard company profile in `experiences[].company` for current and past experiences. It adds 1 credit per unique company successfully expanded across this response page, even when multiple people or experiences reference it. Unavailable companies retain their summary without an expansion charge. Companies on another page or request are charged again. Separately priced company expansions are not included.\n\nCompany expansion supports at most 500 unique available companies per response page. A page exceeding this limit returns `400` before company profiles are loaded or credits are charged. Reduce `pageSize` or remove `company` from `expand` and retry.\n\nPerson filters can be combined with a company query to find people whose current companies match. The company query accepts the same filters, semantic query, and lookalike seeds as company search. Company queries that use `query`, keyword, technology, funding, workforce, `reportedEmployees`, or required-feature filters, or a semantic or lookalike query, match people at the 1,000 best-matching companies.\n\nA semantic query infers person filters and a description of the current companies. For example, `VP of sales at Series A SaaS startups in Germany` filters VP-level sales people and searches their current companies with the semantic company query `Series A SaaS startups in Germany`. Inferred person names, positions, seniorities, departments, countries, current and past companies, schools, and recent company or position start dates filter results. Person locations are inferred at country level, so a city filters its country. Current company names and confidently equivalent aliases are OR alternatives in a company text query, matching names, keywords, and domain prefixes before finding current employees. Past company names resolve to domains. Request filters that include values take precedence over inferred values of the same kind, and request exclusions apply together with inferred values. A request `company.semantic` or `company.lookalike` query replaces the inferred company description. When the request includes specific current companies by id, domain, or LinkedIn handle in `filter`, or by id, domain, or query inclusions in `company.filter`, current companies are not inferred. A semantic query from which no filters can be inferred is rejected. The response `interpretation` reports what was inferred.\n\nTop-level company, seniority, department, position, and start date filters match current experiences. Use `filter.pastExperience` to find people by previous employment. Its inclusion rules must all match the same past experience, and people who still work at an included company are excluded. A past company exclusion removes people with any matching past experience. Past seniority, department, and position filters do not support exclusions.\n\nSend an empty object (`{}`) to search without filters.\n\nResults use cursor pagination. Omit `cursor` for the first page and pass a cursor returned by the previous response to continue. Numbered pagination is not supported. Keep the same query when continuing a search. Cursors expire 24 hours after the first page.\n\nExperiences that matched the search filters are marked with `isMatched`.\n\nA value filter supports these input forms:\n\n- match one value: `\"TR\"`\n- match several values: `[\"TR\", \"US\"]`\n- configure advanced matching rules: `{ \"in\": [\"TR\"], \"notIn\": [\"US\"] }`\n\nA single value or array matches any provided value. Use the object form to configure inclusion and exclusion rules together. Exclusions on current-experience fields (company, seniority, department, and position) remove a person when any of their current experiences matches.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchV2Request" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchV2Response" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/people/search/count": { "post": { "tags": [ "People / Search" ], "summary": "Count matching people", "description": "Counts people using the same person filters, semantic query, and company query as the search endpoint, without pagination or response expansions. Send an empty object (`{}`) to count people without filters.\n\nThis endpoint does not consume credits. `count` is limited by the current plan; `total` is the matching population before plan limits. Semantic queries infer filters as in search and report them in `interpretation`.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchQuery" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchCountV2Response" } } } } } } }, "/v2/people/search/preview": { "post": { "tags": [ "People / Search" ], "summary": "Preview matching people", "description": "Returns up to 10 person summaries using the same filters and ranking as search, without pagination or response expansions. Send an empty object (`{}`) to preview people without filters.\n\nRequires a plan with people previews and does not consume credits.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchQuery" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchPreviewV2Response" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/industries": { "get": { "tags": [ "Industries" ], "summary": "List industries", "description": "Returns all industries and their NAICS code prefixes in `items`. Pass the string codes to the company search `filter.naicsCodes` field. No credits are deducted.", "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportListResponseOfIndustryResponse" } } } } } } }, "/v2/keywords/autocomplete": { "get": { "tags": [ "Keywords" ], "summary": "Lookup keywords", "description": "Returns up to 10 keyword suggestions in `items`, ordered by popularity. An empty query returns an empty list. No credits are deducted.", "parameters": [ { "name": "query", "in": "query", "description": "The keyword prefix to look up. At most 100 characters; surrounding whitespace is ignored.", "required": true, "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportListResponseOfstring" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/technologies/autocomplete": { "get": { "tags": [ "Technologies" ], "summary": "Lookup technologies", "description": "Returns up to 10 technology suggestions in `items`, ordered by popularity. An empty query returns an empty list. No credits are deducted.", "parameters": [ { "name": "query", "in": "query", "description": "The technology prefix to look up. At most 100 characters; surrounding whitespace is ignored.", "required": true, "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportListResponseOfstring" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/positions/autocomplete": { "get": { "tags": [ "Positions" ], "summary": "Lookup positions", "description": "Returns up to 10 position or job title suggestions in `items`, ordered by popularity. An empty query returns an empty list. No credits are deducted.", "parameters": [ { "name": "query", "in": "query", "description": "The position or job title prefix to look up. At most 100 characters; surrounding whitespace is ignored.", "required": true, "schema": { "maxLength": 100, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportListResponseOfstring" } } } }, "500": { "description": "Internal Server Error", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/me": { "get": { "tags": [ "User" ], "summary": "Get current user information", "description": "**Cost:** FREE - No credits deducted\n\nReturns information about the authenticated user, including their API key, credit balance, and account capabilities.\nThis endpoint requires authentication via an API key in the Authorization header.", "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiUserV2Info" } } } } } } }, "/v2/batches": { "get": { "tags": [ "Batches" ], "summary": "List batches", "description": "Returns your batches, newest first, with the same status and progress as `GET /v2/batches/{id}`. To fetch the next page, pass `nextCursor` as `cursor` with the same `kind`.", "parameters": [ { "name": "kind", "in": "query", "description": "Only return batches of this kind, such as `company-enrichment`.", "schema": { "maxLength": 64, "type": "string" } }, { "name": "cursor", "in": "query", "description": "The `nextCursor` from the previous page. Omit for the newest batches.", "schema": { "maxLength": 1024, "type": "string" } }, { "name": "pageSize", "in": "query", "description": "The maximum number of batches to return. Defaults to 20.", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int32", "default": 20 } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchListResponse" } } } } } } }, "/v2/batches/{id}": { "get": { "tags": [ "Batches" ], "summary": "Get batch status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/batches/{id}/cancel": { "post": { "tags": [ "Batches" ], "summary": "Cancel remaining batch requests", "description": "Stops remaining work. Already charged results remain downloadable. Cancelling an owned batch that is already terminal is harmless.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/batches/{id}/results": { "get": { "tags": [ "Batches" ], "summary": "Download raw batch results", "description": "Streams a fixed snapshot of eligible HTTP outcomes as NDJSON, one record per line, in input order. Unfinished and unsettled results are excluded. Requires the batch owner's credentials, or the signature from `rawResultsUrl` in a status response.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sig", "in": "query", "description": "The signature from a download URL in a status response. Not needed with the batch owner's credentials.", "schema": { "maxLength": 1024, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/x-ndjson": { "schema": { "$ref": "#/components/schemas/BatchRawResultResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/people/{personId}": { "get": { "tags": [ "People / Enrichment" ], "summary": "Get a person by ID", "description": "**Cost:** 2 credits per person returned, plus requested paid expansions.\n\nThe `education` expansion adds 1 credit per returned person. Repeating an expansion does not multiply its cost.\n\nThe `company` expansion includes the standard company profile in `experiences[].company` for current and past experiences. It adds 1 credit per unique company successfully expanded. Unavailable companies retain their summary without an expansion charge. Separately priced company expansions are not included.\n\nCompany expansion is limited to 500 unique available companies per request. Exceeding the limit returns `400` without charging credits; remove `company` from `expand` to retrieve the person without company profiles.\n\nRetrieves stored person data using its CompanyEnrich ID. You can obtain this ID from search or enrichment results.\n\nReturns `404` without charging credits when the person cannot be found.", "parameters": [ { "name": "personId", "in": "path", "description": "The CompanyEnrich ID of the person to retrieve", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "expand", "in": "query", "description": "Additional person data to include, charged on top of the base cost. Repeating an expansion does not multiply its cost:\n\n- `education`: 1 credit per returned person.\n- `company`: 1 credit per unique company successfully expanded across the returned current and past experiences. Includes the standard company profile; separately priced company expansions are not included. Unavailable companies retain their summary without an expansion charge. Search charges each company once per response page. Limited to 500 unique available companies per request; exceeding the limit returns `400` without charging credits. Reduce `pageSize` for searches or remove `company` from `expand`.", "schema": { "type": "array", "items": { "enum": [ "education", "company" ], "type": "string" } } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/people/enrich": { "post": { "tags": [ "People / Enrichment" ], "summary": "Enrich a person by email", "description": "**Cost:** 5 credits when a person is returned, plus requested paid expansions.\n\nThe `education` expansion adds 1 credit per returned person. Repeating an expansion does not multiply its cost.\n\nThe `company` expansion includes the standard company profile in `experiences[].company` for current and past experiences. It adds 1 credit per unique company successfully expanded. Unavailable companies retain their summary without an expansion charge. Separately priced company expansions are not included.\n\nCompany expansion is limited to 500 unique available companies per request. Exceeding the limit returns `400` without charging credits; remove `company` from `expand` to retrieve the person without company profiles.\n\nResolves the company from the email domain, then matches the person using common email address patterns such as `first.last` or `flast`. Returns the best match, with the experience at the email's company marked as `isMatched`.\n\nReturns `404` without charging credits when no person matches the email address.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonEnrichV2Request" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/people/{personId}/email": { "get": { "tags": [ "People / Enrichment" ], "summary": "Find a person's work email", "description": "**Cost:** 10 credits when a work email is found that your account has not accessed before. Other outcomes, and repeated lookups of an email you already accessed, do not consume credits.\n\nResolves the work email address of a person on a company domain.\n\nWhen `domain` is omitted, the domains of the person's current companies are tried in seniority order. When `domain` is provided, it must belong to one of the person's companies.\n\nThe response has a `status` of `found`, `not-found`, `unavailable`, or `pending`. `email` is included only when `status` is `found`. A `pending` lookup is still running; retry the request later to get its outcome.", "parameters": [ { "name": "personId", "in": "path", "description": "The CompanyEnrich ID of the person", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "domain", "in": "query", "description": "The company domain to resolve the email address on. When omitted, the domains of the person's current companies are tried in seniority order.", "schema": { "maxLength": 1024, "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonEmailV2Response" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/geo/regions": { "get": { "tags": [ "Geo" ], "summary": "Get regions", "description": "Returns all geographic regions and their country codes. This endpoint does not consume credits.", "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupportListResponseOfGeoRegionResponse" } } } } } } }, "/v2/geo/countries/{countryCode}": { "get": { "tags": [ "Geo" ], "summary": "Get country by code", "description": "Retrieves a country by its two-letter code. This endpoint does not consume credits.", "parameters": [ { "name": "countryCode", "in": "path", "description": "The two-letter country code, case-insensitive", "required": true, "schema": { "pattern": "^[A-Za-z]{2}$", "type": "string" } } ], "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoCountryResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/geo/countries": { "post": { "tags": [ "Geo" ], "summary": "Search countries", "description": "Searches names using a literal, case-insensitive substring. Results use cursor pagination in stable code or ID order. Cursors expire 30 minutes after the first page; keep the same filters when continuing. This endpoint does not consume credits.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoSearchRequest" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoSearchResponseOfGeoCountryResponse" } } } } } } }, "/v2/geo/states": { "post": { "tags": [ "Geo" ], "summary": "Search states", "description": "Searches names using a literal, case-insensitive substring. Results use cursor pagination in stable code or ID order. Cursors expire 30 minutes after the first page; keep the same filters when continuing. This endpoint does not consume credits.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoStateSearchRequest" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoSearchResponseOfGeoStateResponse" } } } } } } }, "/v2/geo/cities": { "post": { "tags": [ "Geo" ], "summary": "Search cities", "description": "Searches names using a literal, case-insensitive substring. Results use cursor pagination in stable code or ID order. Cursors expire 30 minutes after the first page; keep the same filters when continuing. This endpoint does not consume credits.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoCitySearchRequest" } } }, "required": true }, "responses": { "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "402": { "description": "Payment Required", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoSearchResponseOfGeoCityResponse" } } } } } } } }, "components": { "schemas": { "AmountRangeFilter": { "type": "object", "properties": { "min": { "type": "number", "description": "The minimum value (inclusive)", "format": "double", "nullable": true }, "max": { "type": "number", "description": "The maximum value (inclusive)", "format": "double", "nullable": true } }, "description": "The funding amount range of companies", "nullable": true }, "ApiCreditV2Info": { "required": [ "used", "total" ], "type": "object", "properties": { "used": { "type": "number", "description": "The credits used, including fractional credits", "format": "double" }, "total": { "type": "number", "description": "The total credit allowance", "format": "double" } }, "description": "Credit totals in user-facing credits, including fractional credits" }, "ApiUserV2Info": { "required": [ "userId", "credits", "capabilities" ], "type": "object", "properties": { "userId": { "type": "string", "description": "The authenticated user ID", "format": "uuid" }, "credits": { "$ref": "#/components/schemas/ApiCreditV2Info" }, "capabilities": { "$ref": "#/components/schemas/CapabilitiesInfo" } } }, "BatchListResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BatchStatusResponse" }, "description": "The batches in this page." }, "nextCursor": { "type": "string", "description": "The cursor for the next page. Omitted when no more batches remain.", "nullable": true } } }, "BatchProgressResponse": { "required": [ "total", "pending", "running", "succeeded", "failed", "unknown", "cancelled" ], "type": "object", "properties": { "total": { "type": "integer", "description": "The number of requests. A search export adds one for each page as the previous page settles.", "format": "int32" }, "pending": { "type": "integer", "description": "Requests awaiting dispatch, including retries.", "format": "int32" }, "running": { "type": "integer", "description": "Requests still being processed, including saved results not yet settled.", "format": "int32" }, "succeeded": { "type": "integer", "description": "Requests that returned a successful HTTP response.", "format": "int32" }, "failed": { "type": "integer", "description": "Requests that returned an HTTP error response.", "format": "int32" }, "unknown": { "type": "integer", "description": "Requests whose execution outcome could not be confirmed.", "format": "int32" }, "cancelled": { "type": "integer", "description": "Requests cancelled before their results were published.", "format": "int32" } }, "description": "The number of requests in each state." }, "BatchRawResultResponse": { "required": [ "index", "state", "credits" ], "type": "object", "properties": { "index": { "type": "integer", "description": "The zero-based position of this request in the batch.", "format": "int32" }, "customId": { "type": "string", "description": "The original input domain for a company enrichment batch.", "nullable": true }, "state": { "$ref": "#/components/schemas/HttpBatchItemState2" }, "statusCode": { "type": "integer", "description": "The HTTP response status, or null if no response was recorded.", "format": "int32", "nullable": true }, "contentType": { "type": "string", "description": "The response content type, when a response was recorded.", "nullable": true }, "body": { "$ref": "#/components/schemas/NullableOfJsonElement3" }, "error": { "type": "string", "description": "The execution error, if any.", "nullable": true }, "credits": { "type": "number", "description": "The charged cost of this request, in user-visible credits.", "format": "double" } } }, "BatchStatusResponse": { "required": [ "id", "kind", "status", "progress", "creditsCharged", "createdAt", "statusUrl", "resultsUrl", "rawResultsUrl" ], "type": "object", "properties": { "id": { "type": "string", "description": "The batch ID.", "format": "uuid" }, "kind": { "type": "string", "description": "The task represented by the batch." }, "status": { "$ref": "#/components/schemas/HttpBatchState" }, "progress": { "$ref": "#/components/schemas/BatchProgressResponse" }, "creditsCharged": { "type": "number", "description": "The credits charged so far, in user-visible credits.", "format": "double" }, "recordCount": { "type": "integer", "description": "For a search export, the number of records its settled pages returned.", "format": "int32", "nullable": true }, "recordLimit": { "type": "integer", "description": "For a search export, the most search results it requests. Results whose record is unavailable are skipped, so `recordCount` can end below it.", "format": "int32", "nullable": true }, "createdAt": { "type": "string", "description": "When the batch was created.", "format": "date-time" }, "completedAt": { "type": "string", "description": "When the batch completed or was cancelled, if terminal.", "format": "date-time", "nullable": true }, "statusUrl": { "type": "string", "description": "The authenticated URL for checking batch status and progress." }, "resultsUrl": { "type": "string", "description": "The download URL for the task's projected results. It is signed, so it works without credentials for one hour; after that, use the owner's credentials or a URL from a new status response." }, "rawResultsUrl": { "type": "string", "description": "The download URL for raw HTTP outcomes in NDJSON format, signed like `resultsUrl`." } } }, "CapabilitiesInfo": { "required": [ "lists", "previews", "companySearchLimit", "companySearchAsyncLimit", "peopleSearchLimit", "searchTermLimit" ], "type": "object", "properties": { "lists": { "type": "boolean" }, "previews": { "type": "boolean" }, "companySearchLimit": { "type": "integer", "format": "int32" }, "companySearchAsyncLimit": { "type": "integer", "format": "int32" }, "peopleSearchLimit": { "type": "integer", "format": "int32" }, "searchTermLimit": { "type": "integer", "format": "int32" } }, "description": "The features and limits available to the user" }, "CompanyAutocompleteResponse": { "required": [ "id", "domain", "logoUrl" ], "type": "object", "properties": { "id": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "name": { "type": "string", "description": "The company name", "nullable": true }, "domain": { "type": "string", "description": "The primary domain of the company" }, "logoUrl": { "type": "string", "description": "The company logo URL" } } }, "CompanyBatchEnrichItemResponse": { "required": [ "domain", "status" ], "type": "object", "properties": { "domain": { "type": "string", "description": "The domain as provided in the request" }, "status": { "$ref": "#/components/schemas/CompanyEnrichStatus" }, "company": { "$ref": "#/components/schemas/CompanyResponse2" } } }, "CompanyBatchEnrichV2Request": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "maxItems": 50, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "The company domains to enrich, between 1 and 50. Each domain can be at most 1024 characters. Duplicate domains are enriched once." }, "expand": { "type": "array", "items": { "enum": [ "financial", "keywords", "naicsCodes", "technologies", "workforce" ], "type": "string" }, "description": "Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:\n\n- `financial`: 1 credit\n- `keywords`: 1 credit\n- `naicsCodes`: 1 credit\n- `technologies`: 1 credit\n- `workforce`: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from `GET /v2/companies/workforce` costs another 1 credit.", "nullable": true }, "waitForEnrichment": { "type": "boolean", "description": "Whether to wait for on-demand enrichment of companies that are not stored yet. When false, stored companies are returned immediately and the rest get the `pending` status and are scheduled for background enrichment when eligible." } } }, "CompanyBatchEnrichV2Response": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyBatchEnrichItemResponse" }, "description": "One result per requested domain, in request order" } } }, "CompanyBulkEnrichmentRequest": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "maxItems": 10000, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Between 1 and 10,000 company domains, in the desired output order. Each domain can be at most 1024 characters. Duplicate inputs are separate requests." }, "expand": { "type": "array", "items": { "enum": [ "financial", "keywords", "naicsCodes", "technologies", "workforce" ], "type": "string" }, "description": "Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:\n\n- `financial`: 1 credit\n- `keywords`: 1 credit\n- `naicsCodes`: 1 credit\n- `technologies`: 1 credit\n- `workforce`: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from `GET /v2/companies/workforce` costs another 1 credit.", "nullable": true }, "waitForEnrichment": { "type": "boolean", "description": "Whether each request waits for on-demand enrichment. When false, a company that is not stored yet may return an error indicating that enrichment was scheduled." } } }, "CompanyBulkEnrichmentResult": { "required": [ "index", "domain", "state", "success" ], "type": "object", "properties": { "index": { "type": "integer", "description": "The zero-based position of this domain in the original request.", "format": "int32" }, "domain": { "type": "string", "description": "The domain exactly as provided in the original request." }, "statusCode": { "type": "integer", "description": "The HTTP status returned by the enrichment endpoint, or null when no response was recorded.", "format": "int32", "nullable": true }, "state": { "$ref": "#/components/schemas/HttpBatchItemState" }, "success": { "type": "boolean", "description": "Whether the company was successfully enriched." }, "company": { "$ref": "#/components/schemas/NullableOfJsonElement" }, "error": { "$ref": "#/components/schemas/NullableOfJsonElement2" } } }, "CompanyBulkEnrichmentResultsResponse": { "required": [ "batchId", "kind", "status", "creditsCharged", "resultCount", "results" ], "type": "object", "properties": { "batchId": { "type": "string", "description": "The batch ID.", "format": "uuid" }, "kind": { "type": "string", "description": "The task represented by the batch." }, "status": { "$ref": "#/components/schemas/HttpBatchState2" }, "creditsCharged": { "type": "number", "description": "The credits charged so far, in user-visible credits.", "format": "double" }, "resultCount": { "type": "integer", "description": "The number of records in `results`.", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyBulkEnrichmentResult" }, "description": "One record per eligible input domain, in input order. Pending and unsettled inputs are absent." } } }, "CompanyCategory": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ] }, "CompanyCityResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The CompanyEnrich city ID", "format": "int32" }, "name": { "type": "string", "description": "The city name" } }, "description": "The city where the company is located", "nullable": true }, "CompanyCountryResponse": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code" }, "name": { "type": "string", "description": "The country name" } }, "description": "The country where the company is located", "nullable": true }, "CompanyEnrichStatus": { "enum": [ "found", "not-found", "invalid-domain", "pending" ], "description": "The enrichment outcome for the domain" }, "CompanyEnrichV2Request": { "type": "object", "properties": { "name": { "maxLength": 250, "type": "string", "description": "The company name", "nullable": true }, "linkedinUrl": { "maxLength": 2048, "type": "string", "description": "The company LinkedIn URL", "format": "uri", "nullable": true }, "linkedinId": { "maxLength": 100, "type": "string", "description": "The company LinkedIn ID", "nullable": true }, "twitterUrl": { "maxLength": 2048, "type": "string", "description": "The company Twitter/X URL", "format": "uri", "nullable": true }, "facebookUrl": { "maxLength": 2048, "type": "string", "description": "The company Facebook URL", "format": "uri", "nullable": true }, "instagramUrl": { "maxLength": 2048, "type": "string", "description": "The company Instagram URL", "format": "uri", "nullable": true }, "youtubeUrl": { "maxLength": 2048, "type": "string", "description": "The company YouTube URL", "format": "uri", "nullable": true }, "expand": { "type": "array", "items": { "enum": [ "financial", "keywords", "naicsCodes", "technologies", "workforce" ], "type": "string" }, "description": "Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:\n\n- `financial`: 1 credit\n- `keywords`: 1 credit\n- `naicsCodes`: 1 credit\n- `technologies`: 1 credit\n- `workforce`: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from `GET /v2/companies/workforce` costs another 1 credit.", "nullable": true } } }, "CompanyFinancialResponse": { "type": "object", "properties": { "stockSymbol": { "type": "string", "description": "The company stock symbol", "nullable": true }, "stockExchange": { "type": "string", "description": "The stock exchange where the company is listed", "nullable": true }, "totalFunding": { "type": "integer", "description": "The total disclosed funding in USD", "format": "int64", "nullable": true }, "fundingStage": { "type": "string", "description": "The latest funding stage", "nullable": true }, "fundingDate": { "type": "string", "description": "The date of the latest funding round", "format": "date-time", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRoundResponse" }, "description": "The company's disclosed funding rounds", "nullable": true } }, "description": "Financial and funding data. Included when `financial` is requested in `expand`.", "nullable": true }, "CompanyFundingRoundResponse": { "type": "object", "properties": { "date": { "type": "string", "description": "The funding round date", "format": "date-time", "nullable": true }, "amount": { "type": "string", "description": "The disclosed funding amount and currency", "nullable": true }, "type": { "type": "string", "description": "The funding round type", "nullable": true }, "url": { "type": "string", "description": "A source URL for the funding round", "nullable": true }, "investors": { "type": "string", "description": "The disclosed investors", "nullable": true } } }, "CompanyLocationResponse": { "type": "object", "properties": { "country": { "$ref": "#/components/schemas/CompanyCountryResponse" }, "state": { "$ref": "#/components/schemas/CompanyStateResponse" }, "city": { "$ref": "#/components/schemas/CompanyCityResponse" }, "address": { "type": "string", "description": "The company street address", "nullable": true }, "postalCode": { "type": "string", "description": "The company postal code", "nullable": true }, "phone": { "type": "string", "description": "The company phone number", "nullable": true } }, "description": "The company location and contact details", "nullable": true }, "CompanyLookalikeQuery": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "The seed company domains used to find lookalike companies" }, "weight": { "maximum": 1, "minimum": -1, "type": "number", "description": "The ranking weight for company similarity. Larger values prioritize more similar companies.", "format": "double", "nullable": true }, "minScore": { "maximum": 1, "minimum": 0, "type": "number", "description": "The minimum vector similarity required before lookalike ranking penalties are applied", "format": "double", "nullable": true } }, "description": "The seed companies used to find lookalike companies", "nullable": true }, "CompanyResponse": { "required": [ "id", "domain", "website", "logoUrl", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "name": { "type": "string", "description": "The company name", "nullable": true }, "legalName": { "type": "string", "description": "The legal name of the company", "nullable": true }, "domain": { "type": "string", "description": "The primary domain of the company" }, "website": { "type": "string", "description": "The company website URL" }, "logoUrl": { "type": "string", "description": "The company logo URL" }, "description": { "type": "string", "description": "The company description", "nullable": true }, "type": { "$ref": "#/components/schemas/NullableOfCompanyType" }, "foundedYear": { "type": "integer", "description": "The year the company was founded", "format": "int32", "nullable": true }, "employees": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "revenue": { "$ref": "#/components/schemas/NullableOfCompanyRevenue" }, "industry": { "type": "string", "description": "The primary industry of the company", "nullable": true }, "industries": { "type": "array", "items": { "type": "string" }, "description": "The industries associated with the company", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The categories associated with the company, from most to least specific", "nullable": true }, "location": { "$ref": "#/components/schemas/CompanyLocationResponse" }, "socials": { "$ref": "#/components/schemas/CompanySocialsResponse" }, "updatedAt": { "type": "string", "description": "When the company data was last updated", "format": "date-time" }, "financial": { "$ref": "#/components/schemas/CompanyFinancialResponse" }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Keywords associated with the company. Included when `keywords` is requested in `expand`.", "nullable": true }, "naicsCodes": { "type": "array", "items": { "type": "string" }, "description": "The NAICS codes associated with the company. Included when `naicsCodes` is requested in `expand`.", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "Technologies used by the company. Included when `technologies` is requested in `expand`.", "nullable": true }, "workforce": { "$ref": "#/components/schemas/CompanyWorkforceResponse" } } }, "CompanyResponse2": { "required": [ "id", "domain", "website", "logoUrl", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "name": { "type": "string", "description": "The company name", "nullable": true }, "legalName": { "type": "string", "description": "The legal name of the company", "nullable": true }, "domain": { "type": "string", "description": "The primary domain of the company" }, "website": { "type": "string", "description": "The company website URL" }, "logoUrl": { "type": "string", "description": "The company logo URL" }, "description": { "type": "string", "description": "The company description", "nullable": true }, "type": { "$ref": "#/components/schemas/NullableOfCompanyType" }, "foundedYear": { "type": "integer", "description": "The year the company was founded", "format": "int32", "nullable": true }, "employees": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "revenue": { "$ref": "#/components/schemas/NullableOfCompanyRevenue" }, "industry": { "type": "string", "description": "The primary industry of the company", "nullable": true }, "industries": { "type": "array", "items": { "type": "string" }, "description": "The industries associated with the company", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The categories associated with the company, from most to least specific", "nullable": true }, "location": { "$ref": "#/components/schemas/CompanyLocationResponse" }, "socials": { "$ref": "#/components/schemas/CompanySocialsResponse" }, "updatedAt": { "type": "string", "description": "When the company data was last updated", "format": "date-time" }, "financial": { "$ref": "#/components/schemas/CompanyFinancialResponse" }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Keywords associated with the company. Included when `keywords` is requested in `expand`.", "nullable": true }, "naicsCodes": { "type": "array", "items": { "type": "string" }, "description": "The NAICS codes associated with the company. Included when `naicsCodes` is requested in `expand`.", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "Technologies used by the company. Included when `technologies` is requested in `expand`.", "nullable": true }, "workforce": { "$ref": "#/components/schemas/CompanyWorkforceResponse" } }, "description": "The enriched company. Included only when `status` is `found`.", "nullable": true }, "CompanyRevenue": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ] }, "CompanySearchCountV2Response": { "required": [ "count", "total" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of matching companies accessible under the current plan", "format": "int32" }, "total": { "type": "integer", "description": "The total number of matching companies before plan limits are applied", "format": "int32" }, "interpretation": { "$ref": "#/components/schemas/CompanySemanticInterpretationResponse" } } }, "CompanySearchExportRequest": { "required": [ "limit" ], "type": "object", "properties": { "limit": { "maximum": 1000000, "minimum": 1, "type": "integer", "description": "The maximum number of search results to export. Results whose company is no longer available are skipped, so an export can return fewer companies. Your plan's search limit also applies.", "format": "int32", "nullable": true }, "expand": { "type": "array", "items": { "enum": [ "financial", "keywords", "naicsCodes", "technologies", "workforce" ], "type": "string" }, "description": "Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:\n\n- `financial`: 1 credit\n- `keywords`: 1 credit\n- `naicsCodes`: 1 credit\n- `technologies`: 1 credit\n- `workforce`: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from `GET /v2/companies/workforce` costs another 1 credit.", "nullable": true }, "filter": { "$ref": "#/components/schemas/CompanySearchFilter" }, "semantic": { "$ref": "#/components/schemas/CompanySemanticQuery" }, "lookalike": { "$ref": "#/components/schemas/CompanyLookalikeQuery" } } }, "CompanySearchExportResult": { "required": [ "index", "company" ], "type": "object", "properties": { "index": { "type": "integer", "description": "The zero-based position of this company in the export.", "format": "int32" }, "score": { "type": "number", "description": "The lookalike ranking score, for lookalike searches. Scores are not probabilities.", "format": "double", "nullable": true }, "company": { "$ref": "#/components/schemas/JsonElement" } } }, "CompanySearchExportResultsResponse": { "required": [ "batchId", "kind", "status", "creditsCharged", "resultCount", "results" ], "type": "object", "properties": { "batchId": { "type": "string", "description": "The batch ID.", "format": "uuid" }, "kind": { "type": "string", "description": "The task represented by the batch." }, "status": { "$ref": "#/components/schemas/HttpBatchState2" }, "creditsCharged": { "type": "number", "description": "The credits charged so far, in user-visible credits.", "format": "double" }, "resultCount": { "type": "integer", "description": "The number of records in `results`.", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySearchExportResult" }, "description": "The exported companies from every settled page, in search result order." } } }, "CompanySearchFilter": { "type": "object", "properties": { "query": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "Queries matching company names, keywords, or domain prefixes. A string or array matches any query. Inclusions use OR; exclusions remove matches. Each entry supports the existing text query syntax, up to 250 characters. A blank string is treated as no query; blank entries in arrays or matching rules are invalid.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "id": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value.", "format": "uuid" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "domain": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company domains to match. A single value or array matches any provided domain.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "keywords": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The keywords to match. A single value or array requires every provided keyword.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "technologies": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The technologies to match. A single value or array requires every provided technology.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "region": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The regions to match. A single value or array matches any provided region.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "country": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The countries to match. A single value or array matches any provided country.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "state": { "oneOf": [ { "title": "Single value", "type": "integer", "description": "Include results that match this value.", "format": "int32" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The state ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "city": { "oneOf": [ { "title": "Single value", "type": "integer", "description": "Include results that match this value.", "format": "int32" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The city ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "type": { "oneOf": [ { "title": "Single value", "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company types to match. A single value or array matches any provided type.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "employees": { "oneOf": [ { "title": "Single value", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The employee ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "reportedEmployees": { "oneOf": [ { "title": "Single value", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The externally reported employee ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "revenue": { "oneOf": [ { "title": "Single value", "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The revenue ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthV2Filter" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeV2Filter" }, "description": "The workforce headcount ranges of companies, by department", "nullable": true }, "naicsCodes": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The NAICS code strings to match, each containing 2 to 6 ASCII digits without a leading zero. Surrounding whitespace is ignored. A single value or array matches any provided code.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "categories": { "oneOf": [ { "title": "Single value", "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The categories to match. A single value or array requires every provided category.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRangeFilter" }, "fundingRounds": { "oneOf": [ { "title": "Single value", "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The funding rounds to match. A single value or array matches any provided round.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "fundingAmount": { "$ref": "#/components/schemas/AmountRangeFilter" }, "fundingYear": { "$ref": "#/components/schemas/YearRangeFilter2" }, "require": { "oneOf": [ { "title": "Single value", "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "all": { "minItems": 1, "type": "array", "items": { "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string" }, "description": "Only match when every provided value matches the target" } }, "additionalProperties": false, "description": "Configure values that must all match." } ], "description": "The features companies must have. A single value or array requires every provided feature.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true } }, "description": "The filters to apply to the company search", "nullable": true }, "CompanySearchFilter2": { "type": "object", "properties": { "query": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "Queries matching company names, keywords, or domain prefixes. A string or array matches any query. Inclusions use OR; exclusions remove matches. Each entry supports the existing text query syntax, up to 250 characters. A blank string is treated as no query; blank entries in arrays or matching rules are invalid.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "id": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value.", "format": "uuid" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "domain": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company domains to match. A single value or array matches any provided domain.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "keywords": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The keywords to match. A single value or array requires every provided keyword.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "technologies": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The technologies to match. A single value or array requires every provided technology.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "region": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The regions to match. A single value or array matches any provided region.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "country": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The countries to match. A single value or array matches any provided country.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "state": { "oneOf": [ { "title": "Single value", "type": "integer", "description": "Include results that match this value.", "format": "int32" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The state ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "city": { "oneOf": [ { "title": "Single value", "type": "integer", "description": "Include results that match this value.", "format": "int32" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The city ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "type": { "oneOf": [ { "title": "Single value", "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company types to match. A single value or array matches any provided type.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "employees": { "oneOf": [ { "title": "Single value", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The employee ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "reportedEmployees": { "oneOf": [ { "title": "Single value", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The externally reported employee ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "revenue": { "oneOf": [ { "title": "Single value", "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The revenue ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthV2Filter" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeV2Filter" }, "description": "The workforce headcount ranges of companies, by department", "nullable": true }, "naicsCodes": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The NAICS code strings to match, each containing 2 to 6 ASCII digits without a leading zero. Surrounding whitespace is ignored. A single value or array matches any provided code.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "categories": { "oneOf": [ { "title": "Single value", "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The categories to match. A single value or array requires every provided category.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRangeFilter" }, "fundingRounds": { "oneOf": [ { "title": "Single value", "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The funding rounds to match. A single value or array matches any provided round.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "fundingAmount": { "$ref": "#/components/schemas/AmountRangeFilter" }, "fundingYear": { "$ref": "#/components/schemas/YearRangeFilter2" }, "require": { "oneOf": [ { "title": "Single value", "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "all": { "minItems": 1, "type": "array", "items": { "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string" }, "description": "Only match when every provided value matches the target" } }, "additionalProperties": false, "description": "Configure values that must all match." } ], "description": "The features companies must have. A single value or array requires every provided feature.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true } }, "description": "Filters inferred from the query and applied together with the request filters, in the request filter format. Omitted when none were inferred. Attributes the request includes values for are not inferred.", "nullable": true }, "CompanySearchFilter3": { "type": "object", "properties": { "query": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "Queries matching company names, keywords, or domain prefixes. A string or array matches any query. Inclusions use OR; exclusions remove matches. Each entry supports the existing text query syntax, up to 250 characters. A blank string is treated as no query; blank entries in arrays or matching rules are invalid.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "id": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value.", "format": "uuid" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "domain": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company domains to match. A single value or array matches any provided domain.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "keywords": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The keywords to match. A single value or array requires every provided keyword.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "technologies": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The technologies to match. A single value or array requires every provided technology.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "region": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The regions to match. A single value or array matches any provided region.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "country": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The countries to match. A single value or array matches any provided country.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "state": { "oneOf": [ { "title": "Single value", "type": "integer", "description": "Include results that match this value.", "format": "int32" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The state ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "city": { "oneOf": [ { "title": "Single value", "type": "integer", "description": "Include results that match this value.", "format": "int32" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The city ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "type": { "oneOf": [ { "title": "Single value", "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The company types to match. A single value or array matches any provided type.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "employees": { "oneOf": [ { "title": "Single value", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The employee ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "reportedEmployees": { "oneOf": [ { "title": "Single value", "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The externally reported employee ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "revenue": { "oneOf": [ { "title": "Single value", "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The revenue ranges to match. A single value or array matches any provided range.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthV2Filter" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeV2Filter" }, "description": "The workforce headcount ranges of companies, by department", "nullable": true }, "naicsCodes": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The NAICS code strings to match, each containing 2 to 6 ASCII digits without a leading zero. Surrounding whitespace is ignored. A single value or array matches any provided code.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "categories": { "oneOf": [ { "title": "Single value", "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" }, "all": { "minItems": 1, "type": "array", "items": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas", "local-business" ], "type": "string" }, "description": "Only match when every provided value is present in the target collection" } }, "additionalProperties": false, "description": "Configure values that may match, must all match, or must be excluded." } ], "description": "The categories to match. A single value or array requires every provided category.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRangeFilter" }, "fundingRounds": { "oneOf": [ { "title": "Single value", "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The funding rounds to match. A single value or array matches any provided round.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "fundingAmount": { "$ref": "#/components/schemas/AmountRangeFilter" }, "fundingYear": { "$ref": "#/components/schemas/YearRangeFilter2" }, "require": { "oneOf": [ { "title": "Single value", "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string", "description": "Only match when this value matches the target." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string" }, "description": "Only match when every provided value matches the target." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "all": { "minItems": 1, "type": "array", "items": { "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ], "type": "string" }, "description": "Only match when every provided value matches the target" } }, "additionalProperties": false, "description": "Configure values that must all match." } ], "description": "The features companies must have. A single value or array requires every provided feature.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true } }, "description": "Company filters inferred from the description and applied together with the request company filters, in the company search filter format. Omitted when none were inferred.", "nullable": true }, "CompanySearchPreviewItemResponse": { "required": [ "id", "logoUrl", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "name": { "type": "string", "description": "The company name", "nullable": true }, "logoUrl": { "type": "string", "description": "The company logo URL" }, "industry": { "type": "string", "description": "The primary industry of the company", "nullable": true }, "updatedAt": { "type": "string", "description": "When the company data was last updated", "format": "date-time" } } }, "CompanySearchPreviewV2Response": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySearchPreviewItemResponse" }, "description": "The companies included in the preview" }, "total": { "type": "integer", "description": "The total number of matching companies accessible under the current plan", "format": "int32" }, "scores": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Ranking scores by company ID for lookalike previews, including ranking penalties. Scores are not probabilities.", "nullable": true }, "interpretation": { "$ref": "#/components/schemas/CompanySemanticInterpretationResponse" } } }, "CompanySearchQuery": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/CompanySearchFilter" }, "semantic": { "$ref": "#/components/schemas/CompanySemanticQuery" }, "lookalike": { "$ref": "#/components/schemas/CompanyLookalikeQuery" } }, "description": "The company query used to find people whose current companies match", "nullable": true }, "CompanySearchQuery2": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/CompanySearchFilter" }, "semantic": { "$ref": "#/components/schemas/CompanySemanticQuery" }, "lookalike": { "$ref": "#/components/schemas/CompanyLookalikeQuery" } } }, "CompanySearchV2Request": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The maximum number of companies to return", "format": "int32" }, "cursor": { "maxLength": 1024, "type": "string", "description": "An opaque cursor returned by a previous search response. Omit for the first page.", "nullable": true }, "expand": { "type": "array", "items": { "enum": [ "financial", "keywords", "naicsCodes", "technologies", "workforce" ], "type": "string" }, "description": "Additional company data to include. Each requested expansion is charged per returned company, on top of the base cost:\n\n- `financial`: 1 credit\n- `keywords`: 1 credit\n- `naicsCodes`: 1 credit\n- `technologies`: 1 credit\n- `workforce`: 1 credit. Includes the latest 12 months of history; each earlier 12-month page from `GET /v2/companies/workforce` costs another 1 credit.", "nullable": true }, "filter": { "$ref": "#/components/schemas/CompanySearchFilter" }, "semantic": { "$ref": "#/components/schemas/CompanySemanticQuery" }, "lookalike": { "$ref": "#/components/schemas/CompanyLookalikeQuery" } } }, "CompanySearchV2Response": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyResponse" }, "description": "The companies returned for this page" }, "nextCursor": { "type": "string", "description": "An opaque cursor for the next page. Omitted when there are no more results.", "nullable": true }, "scores": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Ranking scores by company ID for lookalike searches. The first 150 matches include ranking penalties; later matches retain their original scores and order. Scores are not probabilities. Preserve the returned item order.", "nullable": true }, "interpretation": { "$ref": "#/components/schemas/CompanySemanticInterpretationResponse" } } }, "CompanySemanticBoostResponse": { "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "Company names detected in the query. A company whose name contains one of them, or whose domain matches it, ranks above all other results.", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "A company in any of these categories ranks higher", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "A company in one of these revenue ranges ranks higher", "nullable": true } }, "description": "Attributes inferred from the query that rank matching companies higher without excluding or adding companies. Omitted when none were inferred.", "nullable": true }, "CompanySemanticBoostResponse2": { "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "description": "Company names detected in the query. A company whose name contains one of them, or whose domain matches it, ranks above all other results.", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "A company in any of these categories ranks higher", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "A company in one of these revenue ranges ranks higher", "nullable": true } }, "description": "Company attributes inferred from the description that rank matching companies higher when selecting the best-matching companies. Omitted when none were inferred or the description is not searched semantically.", "nullable": true }, "CompanySemanticInterpretationResponse": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/CompanySearchFilter2" }, "boost": { "$ref": "#/components/schemas/CompanySemanticBoostResponse" } }, "description": "How the semantic query was interpreted. Present for semantic queries with `autoFilter` enabled.", "nullable": true }, "CompanySemanticQuery": { "required": [ "query" ], "type": "object", "properties": { "query": { "maxLength": 500, "type": "string", "description": "The natural-language query used to find companies" }, "weight": { "maximum": 1, "minimum": 0, "type": "number", "description": "The semantic relevance weight. Larger values prioritize semantic similarity.", "format": "double", "nullable": true }, "autoFilter": { "type": "boolean", "description": "Whether to infer company attributes such as location, size, and business model from the query. Defaults to true. Inferred location, employee, founded year, and funding values filter results; inferred company names, categories, and revenue rank matching companies higher. Attributes the request includes values for are not inferred; request exclusions apply together with inferred values. The response `interpretation` reports inferred values.", "nullable": true } }, "description": "The semantic query used to find relevant companies", "nullable": true }, "CompanySocialsResponse": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "description": "The company LinkedIn URL", "nullable": true }, "linkedinId": { "type": "string", "description": "The company LinkedIn ID", "nullable": true }, "twitterUrl": { "type": "string", "description": "The company Twitter/X URL", "nullable": true }, "facebookUrl": { "type": "string", "description": "The company Facebook URL", "nullable": true }, "instagramUrl": { "type": "string", "description": "The company Instagram URL", "nullable": true }, "angellistUrl": { "type": "string", "description": "The company AngelList URL", "nullable": true }, "crunchbaseUrl": { "type": "string", "description": "The company Crunchbase URL", "nullable": true }, "youtubeUrl": { "type": "string", "description": "The company YouTube URL", "nullable": true }, "githubUrl": { "type": "string", "description": "The company GitHub URL", "nullable": true }, "g2Url": { "type": "string", "description": "The company G2 URL", "nullable": true } }, "description": "The company social profiles", "nullable": true }, "CompanyStateResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The CompanyEnrich state ID", "format": "int32" }, "name": { "type": "string", "description": "The state or province name" }, "code": { "type": "string", "description": "The ISO 3166-2 subdivision code", "nullable": true } }, "description": "The state or province where the company is located", "nullable": true }, "CompanyWorkforceDepartmentResponse": { "type": "object", "properties": { "cSuite": { "type": "integer", "description": "Observed c-suite headcount", "format": "int32", "nullable": true }, "productManagement": { "type": "integer", "description": "Observed product management headcount", "format": "int32", "nullable": true }, "engineeringTechnical": { "type": "integer", "description": "Observed engineering and technical headcount", "format": "int32", "nullable": true }, "design": { "type": "integer", "description": "Observed design headcount", "format": "int32", "nullable": true }, "education": { "type": "integer", "description": "Observed education headcount", "format": "int32", "nullable": true }, "finance": { "type": "integer", "description": "Observed finance headcount", "format": "int32", "nullable": true }, "humanResources": { "type": "integer", "description": "Observed human resources headcount", "format": "int32", "nullable": true }, "informationTechnology": { "type": "integer", "description": "Observed information technology headcount", "format": "int32", "nullable": true }, "legal": { "type": "integer", "description": "Observed legal headcount", "format": "int32", "nullable": true }, "marketing": { "type": "integer", "description": "Observed marketing headcount", "format": "int32", "nullable": true }, "medicalHealth": { "type": "integer", "description": "Observed medical and health headcount", "format": "int32", "nullable": true }, "operations": { "type": "integer", "description": "Observed operations headcount", "format": "int32", "nullable": true }, "sales": { "type": "integer", "description": "Observed sales headcount", "format": "int32", "nullable": true }, "consulting": { "type": "integer", "description": "Observed consulting headcount", "format": "int32", "nullable": true } }, "description": "Observed headcount grouped by department" }, "CompanyWorkforceGrowthV2Filter": { "type": "object", "properties": { "period": { "$ref": "#/components/schemas/NullableOfCompanyWorkforceGrowthPeriod" }, "department": { "$ref": "#/components/schemas/NullableOfCompanyWorkforceGrowthDepartment" }, "min": { "type": "number", "description": "The minimum growth ratio (inclusive). 0.15 represents 15% growth.", "format": "float", "nullable": true }, "max": { "type": "number", "description": "The maximum growth ratio (inclusive). 0.15 represents 15% growth.", "format": "float", "nullable": true } }, "description": "The workforce growth ratio range of companies", "nullable": true }, "CompanyWorkforceHistoryResponse": { "required": [ "date", "observedEmployeeCount", "departmentHeadcount", "unclassifiedHeadcount" ], "type": "object", "properties": { "date": { "type": "string", "description": "The first day of the snapshot month", "format": "date" }, "observedEmployeeCount": { "type": "integer", "description": "The observed number of distinct employees in the people dataset", "format": "int32" }, "employeeCountRange": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "departmentHeadcount": { "$ref": "#/components/schemas/CompanyWorkforceDepartmentResponse" }, "unclassifiedHeadcount": { "type": "integer", "description": "Observed headcount that could not be classified by department", "format": "int32" } } }, "CompanyWorkforceResponse": { "required": [ "companyId", "domain", "observedEmployeeCount", "departmentHeadcount", "unclassifiedHeadcount", "historyFrom", "historyTo" ], "type": "object", "properties": { "companyId": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "domain": { "type": "string", "description": "The canonical company domain" }, "observedEmployeeCount": { "type": "integer", "description": "The observed number of distinct current employees in the people dataset", "format": "int32" }, "employeeCountRange": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "departmentHeadcount": { "$ref": "#/components/schemas/CompanyWorkforceDepartmentResponse" }, "unclassifiedHeadcount": { "type": "integer", "description": "Observed headcount that could not be classified by department", "format": "int32" }, "historyFrom": { "type": "string", "description": "The inclusive first month of the returned 12-month history window", "format": "date" }, "historyTo": { "type": "string", "description": "The exclusive end of the returned 12-month history window", "format": "date" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceHistoryResponse" }, "description": "Workforce change points within the history window, newest first. A point at the start carries forward the last known earlier headcount when available.", "nullable": true }, "nextCursor": { "type": "string", "description": "Pass this cursor with the company ID or domain to GET /v2/companies/workforce to fetch the preceding year for 1 credit. Omitted when no older history is available. Expires 30 minutes after the first page.", "nullable": true } }, "description": "Workforce insights. Included when `workforce` is requested in `expand`.", "nullable": true }, "CompanyWorkforceResponse2": { "required": [ "companyId", "domain", "observedEmployeeCount", "departmentHeadcount", "unclassifiedHeadcount", "historyFrom", "historyTo" ], "type": "object", "properties": { "companyId": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "domain": { "type": "string", "description": "The canonical company domain" }, "observedEmployeeCount": { "type": "integer", "description": "The observed number of distinct current employees in the people dataset", "format": "int32" }, "employeeCountRange": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "departmentHeadcount": { "$ref": "#/components/schemas/CompanyWorkforceDepartmentResponse" }, "unclassifiedHeadcount": { "type": "integer", "description": "Observed headcount that could not be classified by department", "format": "int32" }, "historyFrom": { "type": "string", "description": "The inclusive first month of the returned 12-month history window", "format": "date" }, "historyTo": { "type": "string", "description": "The exclusive end of the returned 12-month history window", "format": "date" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceHistoryResponse" }, "description": "Workforce change points within the history window, newest first. A point at the start carries forward the last known earlier headcount when available.", "nullable": true }, "nextCursor": { "type": "string", "description": "Pass this cursor with the company ID or domain to GET /v2/companies/workforce to fetch the preceding year for 1 credit. Omitted when no older history is available. Expires 30 minutes after the first page.", "nullable": true } } }, "CompanyWorkforceSizeV2Filter": { "type": "object", "properties": { "department": { "$ref": "#/components/schemas/NullableOfCompanyWorkforceGrowthDepartment2" }, "min": { "type": "integer", "description": "The minimum headcount (inclusive).", "format": "int32", "nullable": true }, "max": { "type": "integer", "description": "The maximum headcount (inclusive).", "format": "int32", "nullable": true } } }, "DateRangeFilter": { "type": "object", "properties": { "after": { "type": "string", "description": "Include results after this date (inclusive)", "format": "date-time", "nullable": true }, "before": { "type": "string", "description": "Include results before this date (inclusive)", "format": "date-time", "nullable": true } }, "description": "The date range in which people joined their current company", "nullable": true }, "DateRangeFilter2": { "type": "object", "properties": { "after": { "type": "string", "description": "Include results after this date (inclusive)", "format": "date-time", "nullable": true }, "before": { "type": "string", "description": "Include results before this date (inclusive)", "format": "date-time", "nullable": true } }, "description": "The date range in which people started their current position", "nullable": true }, "DateRangeFilter3": { "type": "object", "properties": { "after": { "type": "string", "description": "Include results after this date (inclusive)", "format": "date-time", "nullable": true }, "before": { "type": "string", "description": "Include results before this date (inclusive)", "format": "date-time", "nullable": true } }, "description": "The date range in which the past experience started", "nullable": true }, "DateRangeFilter4": { "type": "object", "properties": { "after": { "type": "string", "description": "Include results after this date (inclusive)", "format": "date-time", "nullable": true }, "before": { "type": "string", "description": "Include results before this date (inclusive)", "format": "date-time", "nullable": true } }, "description": "The date range in which the past experience ended", "nullable": true }, "GeoCityResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The city ID accepted by company search filters", "format": "int32" }, "name": { "type": "string", "description": "The city name" }, "countryCode": { "type": "string", "description": "The two-letter code of the parent country", "nullable": true }, "stateId": { "type": "integer", "description": "The ID of the parent state", "format": "int32", "nullable": true }, "latitude": { "type": "number", "description": "The latitude of the city", "format": "float", "nullable": true }, "longitude": { "type": "number", "description": "The longitude of the city", "format": "float", "nullable": true } } }, "GeoCitySearchRequest": { "type": "object", "properties": { "stateIds": { "maxItems": 100, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Up to 100 positive state IDs. Results may belong to any supplied state and must also match any country filter.", "nullable": true }, "countryCodes": { "maxItems": 250, "type": "array", "items": { "type": "string" }, "description": "Up to 250 two-letter country codes. Results may belong to any supplied country. Codes are trimmed and case-insensitive.", "nullable": true }, "query": { "maxLength": 100, "type": "string", "description": "A literal, case-insensitive substring of the name. Leading and trailing whitespace is ignored.", "nullable": true }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The maximum number of results to return. Defaults to 100.", "format": "int32" }, "cursor": { "maxLength": 2048, "type": "string", "description": "The cursor from the previous response. Omit for the first page. Keep the same filters; pageSize may change.", "nullable": true } } }, "GeoCountryResponse": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The two-letter country code" }, "name": { "type": "string", "description": "The country name" }, "latitude": { "type": "number", "description": "The latitude of the country", "format": "float", "nullable": true }, "longitude": { "type": "number", "description": "The longitude of the country", "format": "float", "nullable": true } } }, "GeoRegionResponse": { "required": [ "id", "name", "countryCodes" ], "type": "object", "properties": { "id": { "type": "string", "description": "The region ID accepted by company search filters" }, "name": { "type": "string", "description": "The name of the region" }, "parentId": { "type": "string", "description": "The parent region ID, when this is a subregion", "nullable": true }, "countryCodes": { "type": "array", "items": { "type": "string" }, "description": "The two-letter country codes belonging to this region" } } }, "GeoSearchRequest": { "type": "object", "properties": { "query": { "maxLength": 100, "type": "string", "description": "A literal, case-insensitive substring of the name. Leading and trailing whitespace is ignored.", "nullable": true }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The maximum number of results to return. Defaults to 100.", "format": "int32" }, "cursor": { "maxLength": 2048, "type": "string", "description": "The cursor from the previous response. Omit for the first page. Keep the same filters; pageSize may change.", "nullable": true } } }, "GeoSearchResponseOfGeoCityResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GeoCityResponse" }, "description": "The geographic records in this page" }, "nextCursor": { "type": "string", "description": "The cursor for the next page. Omitted when no more results remain. Expires 30 minutes after the first page.", "nullable": true } } }, "GeoSearchResponseOfGeoCountryResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GeoCountryResponse" }, "description": "The geographic records in this page" }, "nextCursor": { "type": "string", "description": "The cursor for the next page. Omitted when no more results remain. Expires 30 minutes after the first page.", "nullable": true } } }, "GeoSearchResponseOfGeoStateResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GeoStateResponse" }, "description": "The geographic records in this page" }, "nextCursor": { "type": "string", "description": "The cursor for the next page. Omitted when no more results remain. Expires 30 minutes after the first page.", "nullable": true } } }, "GeoStateResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The state ID accepted by city and company search filters", "format": "int32" }, "name": { "type": "string", "description": "The state name" }, "code": { "type": "string", "description": "The ISO 3166-2 state code, when available", "nullable": true }, "countryCode": { "type": "string", "description": "The two-letter code of the parent country", "nullable": true }, "latitude": { "type": "number", "description": "The latitude of the state", "format": "float", "nullable": true }, "longitude": { "type": "number", "description": "The longitude of the state", "format": "float", "nullable": true } } }, "GeoStateSearchRequest": { "type": "object", "properties": { "countryCodes": { "maxItems": 250, "type": "array", "items": { "type": "string" }, "description": "Up to 250 two-letter country codes. Results may belong to any supplied country. Codes are trimmed and case-insensitive.", "nullable": true }, "query": { "maxLength": 100, "type": "string", "description": "A literal, case-insensitive substring of the name. Leading and trailing whitespace is ignored.", "nullable": true }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The maximum number of results to return. Defaults to 100.", "format": "int32" }, "cursor": { "maxLength": 2048, "type": "string", "description": "The cursor from the previous response. Omit for the first page. Keep the same filters; pageSize may change.", "nullable": true } } }, "HttpBatchItemState": { "enum": [ "pending", "running", "succeeded", "failed", "unknown", "cancelled" ], "description": "The recorded request state, including unknown and cancelled outcomes." }, "HttpBatchItemState2": { "enum": [ "pending", "running", "succeeded", "failed", "unknown", "cancelled" ], "description": "The recorded outcome of the request." }, "HttpBatchState": { "enum": [ "pending", "running", "completed", "cancelling", "cancelled" ], "description": "The current batch state." }, "HttpBatchState2": { "enum": [ "pending", "running", "completed", "cancelling", "cancelled" ], "description": "The batch state when the download started." }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "IndustryResponse": { "required": [ "name", "naicsCodes" ], "type": "object", "properties": { "name": { "type": "string", "description": "The industry name" }, "naicsCodes": { "type": "array", "items": { "type": "string" }, "description": "NAICS code prefixes, represented as strings of two to six digits without leading zeros. Pass these values to company search filter.naicsCodes." } } }, "JsonElement": { "description": "The V2 company, as returned by `POST /v2/companies/search`." }, "JsonElement2": { "description": "The V2 person, as returned by `POST /v2/people/search`." }, "NullableOfCompanyEmployees": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K", null ], "description": "The estimated employee count range", "nullable": true }, "NullableOfCompanyRevenue": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b", null ], "description": "The estimated annual revenue range in USD", "nullable": true }, "NullableOfCompanyType": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government", null ], "description": "The company type", "nullable": true }, "NullableOfCompanyWorkforceGrowthDepartment": { "enum": [ "overall", "c_suite", "product_management", "engineering_technical", "design", "education", "finance", "human_resources", "information_technology", "legal", "marketing", "medical_health", "operations", "sales", "consulting", null ], "description": "The department to measure workforce growth for.", "nullable": true }, "NullableOfCompanyWorkforceGrowthDepartment2": { "enum": [ "overall", "c_suite", "product_management", "engineering_technical", "design", "education", "finance", "human_resources", "information_technology", "legal", "marketing", "medical_health", "operations", "sales", "consulting", null ], "description": "The department to filter headcount for. Defaults to overall if not specified.", "nullable": true }, "NullableOfCompanyWorkforceGrowthPeriod": { "enum": [ "m6", "y1", "y2", null ], "description": "The period to measure workforce growth over.", "nullable": true }, "NullableOfJsonElement": { "description": "The enriched V2 company, when the request succeeded.", "nullable": true }, "NullableOfJsonElement2": { "description": "The complete endpoint error body, or the runner's recorded error when no HTTP body is available.", "nullable": true }, "NullableOfJsonElement3": { "description": "The saved endpoint response body, without task-specific projection.", "nullable": true }, "NullableOfPersonDepartment": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant", null ], "description": "The person's current department", "nullable": true }, "NullableOfPersonDepartment2": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant", null ], "description": "The department associated with the experience", "nullable": true }, "NullableOfPersonEmailCertainty": { "enum": [ "unknown", "medium", "high", "very-high", null ], "description": "How certain the email address is. Included only when `status` is `found`.", "nullable": true }, "NullableOfPersonSeniority": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern", null ], "description": "The person's current seniority level", "nullable": true }, "NullableOfPersonSeniority2": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern", null ], "description": "The seniority level associated with the experience", "nullable": true }, "PersonCompanyResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "name": { "type": "string", "description": "The company name", "nullable": true }, "domain": { "type": "string", "description": "The primary company domain", "nullable": true }, "logoUrl": { "type": "string", "description": "The company logo URL", "nullable": true }, "industry": { "type": "string", "description": "The company's primary industry", "nullable": true } }, "description": "The matched educational institution", "nullable": true }, "PersonCountryResponse": { "required": [ "code", "name" ], "type": "object", "properties": { "code": { "type": "string", "description": "The ISO 3166-1 alpha-2 country code" }, "name": { "type": "string", "description": "The country name" } }, "description": "The country where the person is located", "nullable": true }, "PersonEducationResponse": { "required": [ "institutionName" ], "type": "object", "properties": { "institutionName": { "type": "string", "description": "The name of the educational institution" }, "institution": { "$ref": "#/components/schemas/PersonCompanyResponse" }, "socialHandle": { "type": "string", "description": "The social media handle of the educational institution", "nullable": true }, "degree": { "type": "array", "items": { "type": "string" }, "description": "The degrees or fields of study associated with this education entry", "nullable": true }, "startYear": { "type": "integer", "description": "The year this education entry started", "format": "int16", "nullable": true }, "endYear": { "type": "integer", "description": "The year this education entry ended", "format": "int16", "nullable": true } } }, "PersonEducationSearchFilter": { "type": "object", "properties": { "institutionLinkedinHandle": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The education institution LinkedIn handles or URLs to match. A single value or array matches any provided handle.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "institutionName": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The phrases to match against education institution names. A single value or array matches any provided phrase.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true } }, "description": "The education history filters to apply", "nullable": true }, "PersonEmailLookupStatus": { "enum": [ "found", "not-found", "unavailable", "pending" ], "description": "The outcome of the email lookup" }, "PersonEmailV2Response": { "required": [ "personId", "domain", "status" ], "type": "object", "properties": { "personId": { "type": "integer", "description": "The CompanyEnrich ID of the person", "format": "int64" }, "domain": { "type": "string", "description": "The company domain the result belongs to. When `domain` is omitted from the request, this is the domain of the selected lookup." }, "status": { "$ref": "#/components/schemas/PersonEmailLookupStatus" }, "email": { "type": "string", "description": "The work email address. Included only when `status` is `found`.", "nullable": true }, "certainty": { "$ref": "#/components/schemas/NullableOfPersonEmailCertainty" } } }, "PersonEnrichV2Request": { "required": [ "email" ], "type": "object", "properties": { "email": { "maxLength": 320, "type": "string", "description": "The email address of the person" }, "expand": { "type": "array", "items": { "enum": [ "education", "company" ], "type": "string" }, "description": "Additional person data to include, charged on top of the base cost. Repeating an expansion does not multiply its cost:\n\n- `education`: 1 credit per returned person.\n- `company`: 1 credit per unique company successfully expanded across the returned current and past experiences. Includes the standard company profile; separately priced company expansions are not included. Unavailable companies retain their summary without an expansion charge. Search charges each company once per response page. Limited to 500 unique available companies per request; exceeding the limit returns `400` without charging credits. Reduce `pageSize` for searches or remove `company` from `expand`.", "nullable": true } } }, "PersonExperienceCompanyResponse": { "required": [ "id" ], "type": "object", "properties": { "legalName": { "type": "string", "description": "The legal name of the company", "nullable": true }, "website": { "type": "string", "description": "The company website URL", "nullable": true }, "description": { "type": "string", "description": "The company description", "nullable": true }, "type": { "$ref": "#/components/schemas/NullableOfCompanyType" }, "foundedYear": { "type": "integer", "description": "The year the company was founded", "format": "int32", "nullable": true }, "employees": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "revenue": { "$ref": "#/components/schemas/NullableOfCompanyRevenue" }, "industries": { "type": "array", "items": { "type": "string" }, "description": "The industries associated with the company", "nullable": true }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The categories associated with the company, from most to least specific", "nullable": true }, "location": { "$ref": "#/components/schemas/CompanyLocationResponse" }, "socials": { "$ref": "#/components/schemas/CompanySocialsResponse" }, "updatedAt": { "type": "string", "description": "When the company data was last updated", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "name": { "type": "string", "description": "The company name", "nullable": true }, "domain": { "type": "string", "description": "The primary company domain", "nullable": true }, "logoUrl": { "type": "string", "description": "The company logo URL", "nullable": true }, "industry": { "type": "string", "description": "The company's primary industry", "nullable": true } }, "description": "The matched company associated with the experience. Includes the standard company profile when `company` is requested in `expand` and the company is available.", "nullable": true }, "PersonExperienceResponse": { "required": [ "isCurrent", "isMatched" ], "type": "object", "properties": { "startDate": { "type": "string", "description": "The date the experience started", "format": "date", "nullable": true }, "endDate": { "type": "string", "description": "The date the experience ended", "format": "date", "nullable": true }, "isCurrent": { "type": "boolean", "description": "Whether this is a current experience" }, "isMatched": { "type": "boolean", "description": "Whether this experience matched the search filters" }, "position": { "type": "string", "description": "The position or title held during the experience", "nullable": true }, "seniority": { "$ref": "#/components/schemas/NullableOfPersonSeniority2" }, "department": { "$ref": "#/components/schemas/NullableOfPersonDepartment2" }, "company": { "$ref": "#/components/schemas/PersonExperienceCompanyResponse" }, "companyName": { "type": "string", "description": "The reported company name when no company record was matched", "nullable": true } } }, "PersonLocationResponse": { "type": "object", "properties": { "country": { "$ref": "#/components/schemas/PersonCountryResponse" }, "address": { "type": "string", "description": "The person's reported location", "nullable": true } }, "description": "The person location", "nullable": true }, "PersonPastExperienceSearchFilter": { "type": "object", "properties": { "companyId": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value.", "format": "uuid" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The past company ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "domain": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The past company domains to match. A single value or array matches any provided domain.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "companyLinkedinHandle": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The past company LinkedIn handles or URLs to match. A single value or array matches any provided handle.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "seniority": { "oneOf": [ { "title": "Single value", "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The seniority levels to match in the past experience. A single value or array matches any provided seniority. Exclusions are not supported.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "department": { "oneOf": [ { "title": "Single value", "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The departments to match in the past experience, including their sub-departments. A single value or array matches any provided department. Exclusions are not supported.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "position": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The phrases to match against the past position or title. A single value or array matches any provided phrase. Exclusions are not supported.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "startDate": { "$ref": "#/components/schemas/DateRangeFilter3" }, "endDate": { "$ref": "#/components/schemas/DateRangeFilter4" } }, "description": "The past experience filters to apply", "nullable": true }, "PersonResponse": { "required": [ "id", "socials", "experiences" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The CompanyEnrich ID of the person", "format": "int64" }, "name": { "type": "string", "description": "The full name of the person", "nullable": true }, "firstName": { "type": "string", "description": "The first name of the person", "nullable": true }, "lastName": { "type": "string", "description": "The last name of the person", "nullable": true }, "imageUrl": { "type": "string", "description": "The person image URL", "nullable": true }, "position": { "type": "string", "description": "The person's current position or title", "nullable": true }, "seniority": { "$ref": "#/components/schemas/NullableOfPersonSeniority" }, "department": { "$ref": "#/components/schemas/NullableOfPersonDepartment" }, "location": { "$ref": "#/components/schemas/PersonLocationResponse" }, "socials": { "$ref": "#/components/schemas/PersonSocialsResponse" }, "experiences": { "type": "array", "items": { "$ref": "#/components/schemas/PersonExperienceResponse" }, "description": "The person's work experience" }, "updatedAt": { "type": "string", "description": "When the person data was last updated", "format": "date-time", "nullable": true }, "education": { "type": "array", "items": { "$ref": "#/components/schemas/PersonEducationResponse" }, "description": "The person's education history. Included when `education` is requested in `expand`.", "nullable": true } } }, "PersonSearchCountV2Response": { "required": [ "count", "total" ], "type": "object", "properties": { "count": { "type": "integer", "description": "The number of matching people accessible under the current plan", "format": "int32" }, "total": { "type": "integer", "description": "The total number of matching people before plan limits are applied", "format": "int32" }, "interpretation": { "$ref": "#/components/schemas/PersonSemanticInterpretationResponse" } } }, "PersonSearchExportRequest": { "required": [ "limit" ], "type": "object", "properties": { "limit": { "maximum": 1000000, "minimum": 1, "type": "integer", "description": "The maximum number of search results to export. Results whose person is no longer available are skipped, so an export can return fewer people. Your plan's search limit also applies.", "format": "int32", "nullable": true }, "expand": { "type": "array", "items": { "enum": [ "education", "company" ], "type": "string" }, "description": "Additional person data to include, charged on top of the base cost. Repeating an expansion does not multiply its cost:\n\n- `education`: 1 credit per returned person.\n- `company`: 1 credit per unique company successfully expanded across the returned current and past experiences. Includes the standard company profile; separately priced company expansions are not included. Unavailable companies retain their summary without an expansion charge. Search charges each company once per response page. Limited to 500 unique available companies per request; exceeding the limit returns `400` without charging credits. Reduce `pageSize` for searches or remove `company` from `expand`.", "nullable": true }, "filter": { "$ref": "#/components/schemas/PersonSearchFilter" }, "semantic": { "$ref": "#/components/schemas/PersonSemanticQuery" }, "company": { "$ref": "#/components/schemas/CompanySearchQuery" } } }, "PersonSearchExportResult": { "required": [ "index", "person" ], "type": "object", "properties": { "index": { "type": "integer", "description": "The zero-based position of this person in the export.", "format": "int32" }, "person": { "$ref": "#/components/schemas/JsonElement2" } } }, "PersonSearchExportResultsResponse": { "required": [ "batchId", "kind", "status", "creditsCharged", "resultCount", "results" ], "type": "object", "properties": { "batchId": { "type": "string", "description": "The batch ID.", "format": "uuid" }, "kind": { "type": "string", "description": "The task represented by the batch." }, "status": { "$ref": "#/components/schemas/HttpBatchState2" }, "creditsCharged": { "type": "number", "description": "The credits charged so far, in user-visible credits.", "format": "double" }, "resultCount": { "type": "integer", "description": "The number of records in `results`.", "format": "int32" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSearchExportResult" }, "description": "The exported people from every settled page, in search result order." } } }, "PersonSearchFilter": { "type": "object", "properties": { "query": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "Queries matching person names. A string or array matches any query. Inclusions use OR; exclusions remove matches. Each entry supports the existing text query syntax, up to 250 characters. A blank string is treated as no query; blank entries in arrays or matching rules are invalid.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "companyId": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value.", "format": "uuid" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current company ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "domain": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current company domains to match, up to 2,500 per rule. A single value or array matches any provided domain.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "companyLinkedinHandle": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current company LinkedIn handles or URLs to match. A single value or array matches any provided handle.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "seniority": { "oneOf": [ { "title": "Single value", "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current seniority levels to match. A single value or array matches any provided seniority.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "department": { "oneOf": [ { "title": "Single value", "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current departments to match, including their sub-departments. A single value or array matches any provided department.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "country": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The country codes to match. A single value or array matches any provided country.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "position": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The phrases to match against current positions or titles. A single value or array matches any provided phrase.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "currentCompanyStartDate": { "$ref": "#/components/schemas/DateRangeFilter" }, "currentPositionStartDate": { "$ref": "#/components/schemas/DateRangeFilter2" }, "education": { "$ref": "#/components/schemas/PersonEducationSearchFilter" }, "pastExperience": { "$ref": "#/components/schemas/PersonPastExperienceSearchFilter" } }, "description": "The filters to apply to the people search", "nullable": true }, "PersonSearchFilter2": { "type": "object", "properties": { "query": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "Queries matching person names. A string or array matches any query. Inclusions use OR; exclusions remove matches. Each entry supports the existing text query syntax, up to 250 characters. A blank string is treated as no query; blank entries in arrays or matching rules are invalid.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "companyId": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value.", "format": "uuid" }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current company ids to match. A single value or array matches any provided id.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "domain": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current company domains to match, up to 2,500 per rule. A single value or array matches any provided domain.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "companyLinkedinHandle": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current company LinkedIn handles or URLs to match. A single value or array matches any provided handle.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "seniority": { "oneOf": [ { "title": "Single value", "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current seniority levels to match. A single value or array matches any provided seniority.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "department": { "oneOf": [ { "title": "Single value", "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "enum": [ "c-suite", "c-suite/executive", "c-suite/finance-executive", "c-suite/founder", "c-suite/human-resources-executive", "c-suite/information-technology-executive", "c-suite/legal-executive", "c-suite/marketing-executive", "c-suite/medical-health-executive", "c-suite/operations-executive", "c-suite/sales-executive", "product-management", "product-management/product-development", "product-management/product-management", "engineering-technical", "engineering-technical/artificial-intelligence-machine-learning", "engineering-technical/bioengineering", "engineering-technical/biometrics", "engineering-technical/business-intelligence", "engineering-technical/chemical-engineering", "engineering-technical/cloud-mobility", "engineering-technical/data-science", "engineering-technical/devops", "engineering-technical/digital-transformation", "engineering-technical/emerging-technology-innovation", "engineering-technical/engineering-technical", "engineering-technical/industrial-engineering", "engineering-technical/mechanic", "engineering-technical/mobile-development", "engineering-technical/project-management", "engineering-technical/research-development", "engineering-technical/scrum-master-agile-coach", "engineering-technical/software-development", "engineering-technical/support-technical-services", "engineering-technical/technician", "engineering-technical/technology-operations", "engineering-technical/test-quality-assurance", "engineering-technical/ui-ux", "engineering-technical/web-development", "design", "design/all-design", "design/product-ui-ux-design", "design/graphic-design", "education", "education/teacher", "education/principal", "education/superintendent", "education/professor", "finance", "finance/accounting", "finance/finance", "finance/financial-planning-analysis", "finance/financial-reporting", "finance/financial-strategy", "finance/financial-systems", "finance/internal-audit-control", "finance/investor-relations", "finance/mergers-acquisitions", "finance/real-estate-finance", "finance/financial-risk", "finance/shared-services", "finance/sourcing-procurement", "finance/tax", "finance/treasury", "human-resources", "human-resources/compensation-benefits", "human-resources/culture-diversity-inclusion", "human-resources/employee-labor-relations", "human-resources/health-safety", "human-resources/human-resource-information-system", "human-resources/human-resources", "human-resources/hr-business-partner", "human-resources/learning-development", "human-resources/organizational-development", "human-resources/recruiting-talent-acquisition", "human-resources/talent-management", "human-resources/workforce-management", "human-resources/people-operations", "information-technology", "information-technology/application-development", "information-technology/business-service-management-itsm", "information-technology/collaboration-web-app", "information-technology/data-center", "information-technology/data-warehouse", "information-technology/database-administration", "information-technology/ecommerce-development", "information-technology/enterprise-architecture", "information-technology/help-desk-desktop-services", "information-technology/hr-financial-erp-systems", "information-technology/information-security", "information-technology/information-technology", "information-technology/infrastructure", "information-technology/it-asset-management", "information-technology/it-audit-it-compliance", "information-technology/it-operations", "information-technology/it-procurement", "information-technology/it-strategy", "information-technology/it-training", "information-technology/networking", "information-technology/project-program-management", "information-technology/quality-assurance", "information-technology/retail-store-systems", "information-technology/servers", "information-technology/storage-disaster-recovery", "information-technology/telecommunications", "information-technology/virtualization", "legal", "legal/acquisitions", "legal/compliance", "legal/contracts", "legal/corporate-secretary", "legal/ediscovery", "legal/ethics", "legal/governance", "legal/governmental-affairs-regulatory-law", "legal/intellectual-property-patent", "legal/labor-employment", "legal/lawyer-attorney", "legal/legal", "legal/legal-counsel", "legal/legal-operations", "legal/litigation", "legal/privacy", "marketing", "marketing/advertising", "marketing/brand-management", "marketing/content-marketing", "marketing/customer-experience", "marketing/customer-marketing", "marketing/demand-generation", "marketing/digital-marketing", "marketing/ecommerce-marketing", "marketing/event-marketing", "marketing/field-marketing", "marketing/lead-generation", "marketing/marketing", "marketing/marketing-analytics-insights", "marketing/marketing-communications", "marketing/marketing-operations", "marketing/product-marketing", "marketing/public-relations", "marketing/search-engine-optimization-pay-per-click", "marketing/social-media-marketing", "marketing/strategic-communications", "marketing/technical-marketing", "medical-health", "medical-health/anesthesiology", "medical-health/chiropractics", "medical-health/clinical-systems", "medical-health/dentistry", "medical-health/dermatology", "medical-health/doctors-physicians", "medical-health/epidemiology", "medical-health/first-responder", "medical-health/infectious-disease", "medical-health/medical-administration", "medical-health/medical-education-training", "medical-health/medical-research", "medical-health/medicine", "medical-health/neurology", "medical-health/nursing", "medical-health/nutrition-dietetics", "medical-health/obstetrics-gynecology", "medical-health/oncology", "medical-health/opthalmology", "medical-health/optometry", "medical-health/orthopedics", "medical-health/pathology", "medical-health/pediatrics", "medical-health/pharmacy", "medical-health/physical-therapy", "medical-health/psychiatry", "medical-health/psychology", "medical-health/public-health", "medical-health/radiology", "medical-health/social-work", "operations", "operations/call-center", "operations/construction", "operations/corporate-strategy", "operations/customer-service-support", "operations/enterprise-resource-planning", "operations/facilities-management", "operations/leasing", "operations/logistics", "operations/office-operations", "operations/operations", "operations/physical-security", "operations/project-development", "operations/quality-management", "operations/real-estate", "operations/safety", "operations/store-operations", "operations/supply-chain", "sales", "sales/account-management", "sales/business-development", "sales/channel-sales", "sales/customer-retention-development", "sales/customer-success", "sales/field-outside-sales", "sales/inside-sales", "sales/partnerships", "sales/revenue-operations", "sales/sales", "sales/sales-enablement", "sales/sales-engineering", "sales/sales-operations", "sales/sales-training", "consulting", "consulting/consultant" ], "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The current departments to match, including their sub-departments. A single value or array matches any provided department.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "country": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The country codes to match. A single value or array matches any provided country.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "position": { "oneOf": [ { "title": "Single value", "type": "string", "description": "Include results that match this value." }, { "title": "Multiple values", "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Include results that match at least one of these values." }, { "title": "Advanced matching rules", "minProperties": 1, "type": "object", "properties": { "in": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Only match when the target value is one of the provided values" }, "notIn": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Exclude results when the target value is one of the provided values" } }, "additionalProperties": false, "description": "Configure values that may match or must be excluded." } ], "description": "The phrases to match against current positions or titles. A single value or array matches any provided phrase.\n\nProvide a single value, multiple values, or advanced matching rules.", "nullable": true }, "currentCompanyStartDate": { "$ref": "#/components/schemas/DateRangeFilter" }, "currentPositionStartDate": { "$ref": "#/components/schemas/DateRangeFilter2" }, "education": { "$ref": "#/components/schemas/PersonEducationSearchFilter" }, "pastExperience": { "$ref": "#/components/schemas/PersonPastExperienceSearchFilter" } }, "description": "Person filters inferred from the query and applied together with the request filters, in the request filter format. Omitted when none were inferred. Attributes the request includes values for are not inferred. Recent company or position start dates are reported as date ranges starting on the first day of a month, since profile start dates have month precision.", "nullable": true }, "PersonSearchPreviewCompanyResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The CompanyEnrich ID of the company", "format": "uuid" }, "name": { "type": "string", "description": "The company name", "nullable": true }, "logoUrl": { "type": "string", "description": "The company logo URL", "nullable": true }, "industry": { "type": "string", "description": "The company's primary industry", "nullable": true } }, "description": "The matched company associated with the experience", "nullable": true }, "PersonSearchPreviewExperienceResponse": { "required": [ "isCurrent" ], "type": "object", "properties": { "isCurrent": { "type": "boolean", "description": "Whether this is a current experience" }, "position": { "type": "string", "description": "The position or title held during the experience", "nullable": true }, "company": { "$ref": "#/components/schemas/PersonSearchPreviewCompanyResponse" } } }, "PersonSearchPreviewItemResponse": { "required": [ "id", "experiences" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The CompanyEnrich ID of the person", "format": "int64" }, "name": { "type": "string", "description": "The masked name of the person. Every name after the first keeps only its first and last letters, for example `Jason S****h`.", "nullable": true }, "position": { "type": "string", "description": "The person's current position or title", "nullable": true }, "department": { "type": "string", "description": "The person's current department. Sub-departments are masked, for example `engineering-technical/***`.", "nullable": true }, "experiences": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSearchPreviewExperienceResponse" }, "description": "The work experiences that matched the search filters. Empty when the query has no experience filters." } } }, "PersonSearchPreviewV2Response": { "required": [ "items", "total" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSearchPreviewItemResponse" }, "description": "The people included in the preview" }, "total": { "type": "integer", "description": "The total number of matching people accessible under the current plan", "format": "int32" }, "interpretation": { "$ref": "#/components/schemas/PersonSemanticInterpretationResponse" } } }, "PersonSearchQuery": { "type": "object", "properties": { "filter": { "$ref": "#/components/schemas/PersonSearchFilter" }, "semantic": { "$ref": "#/components/schemas/PersonSemanticQuery" }, "company": { "$ref": "#/components/schemas/CompanySearchQuery" } } }, "PersonSearchV2Request": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The maximum number of people to return", "format": "int32" }, "cursor": { "maxLength": 1024, "type": "string", "description": "An opaque cursor returned by a previous search response. Omit for the first page.", "nullable": true }, "expand": { "type": "array", "items": { "enum": [ "education", "company" ], "type": "string" }, "description": "Additional person data to include, charged on top of the base cost. Repeating an expansion does not multiply its cost:\n\n- `education`: 1 credit per returned person.\n- `company`: 1 credit per unique company successfully expanded across the returned current and past experiences. Includes the standard company profile; separately priced company expansions are not included. Unavailable companies retain their summary without an expansion charge. Search charges each company once per response page. Limited to 500 unique available companies per request; exceeding the limit returns `400` without charging credits. Reduce `pageSize` for searches or remove `company` from `expand`.", "nullable": true }, "filter": { "$ref": "#/components/schemas/PersonSearchFilter" }, "semantic": { "$ref": "#/components/schemas/PersonSemanticQuery" }, "company": { "$ref": "#/components/schemas/CompanySearchQuery" } } }, "PersonSearchV2Response": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonResponse" }, "description": "The people returned for this page" }, "nextCursor": { "type": "string", "description": "An opaque cursor for the next page. Omitted when there are no more results.", "nullable": true }, "interpretation": { "$ref": "#/components/schemas/PersonSemanticInterpretationResponse" } } }, "PersonSemanticCompanyInterpretationResponse": { "required": [ "query" ], "type": "object", "properties": { "query": { "type": "string", "description": "The company description inferred from the query. It is searched like a company `semantic.query` together with the request company filters. A description that does not say what the companies do, such as `startups with over $10M revenue`, applies its inferred filters without a semantic company search; inferred categories and revenue then filter companies instead of ranking them." }, "filter": { "$ref": "#/components/schemas/CompanySearchFilter3" }, "boost": { "$ref": "#/components/schemas/CompanySemanticBoostResponse2" } }, "description": "The current companies described by the query. Omitted when the query does not describe them, the description adds no company filters, the request has a semantic or lookalike company query, or the request includes specific current companies.", "nullable": true }, "PersonSemanticInterpretationResponse": { "type": "object", "properties": { "companyNames": { "type": "array", "items": { "type": "string" }, "description": "Current employer names and aliases inferred from the query. These are applied as OR alternatives through company.filter.query, matching company names, keywords, and domain prefixes before resolving current employers. Omitted when explicit employer ids, domains, LinkedIn handles, or company query inclusions take precedence. This is interpretation output, not a request filter.", "nullable": true }, "filter": { "$ref": "#/components/schemas/PersonSearchFilter2" }, "company": { "$ref": "#/components/schemas/PersonSemanticCompanyInterpretationResponse" } }, "description": "How the semantic query was interpreted. Present for semantic queries.", "nullable": true }, "PersonSemanticQuery": { "required": [ "query" ], "type": "object", "properties": { "query": { "maxLength": 500, "type": "string", "description": "The natural-language query used to find people, such as `marketing leaders at Series B fintech startups in London`. Person names, positions, seniorities, departments, countries, current and past companies, schools, and recent company or position start dates are inferred as filters, and the current companies it describes are searched with a semantic company query. Attributes the request includes values for are not inferred. The response `interpretation` reports inferred values." } }, "description": "The natural-language query used to infer person filters and the current companies", "nullable": true }, "PersonSocialsResponse": { "type": "object", "properties": { "linkedinUrl": { "type": "string", "description": "The person LinkedIn URL", "nullable": true } }, "description": "The person social profiles" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } } }, "SupportListResponseOfCompanyAutocompleteResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyAutocompleteResponse" }, "description": "The reference values or suggestions returned by the request" } } }, "SupportListResponseOfGeoRegionResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/GeoRegionResponse" }, "description": "The reference values or suggestions returned by the request" } } }, "SupportListResponseOfIndustryResponse": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IndustryResponse" }, "description": "The reference values or suggestions returned by the request" } } }, "SupportListResponseOfstring": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "type": "string" }, "description": "The reference values or suggestions returned by the request" } } }, "YearRangeFilter": { "type": "object", "properties": { "min": { "type": "integer", "description": "The minimum value (inclusive)", "format": "int32", "nullable": true }, "max": { "type": "integer", "description": "The maximum value (inclusive)", "format": "int32", "nullable": true } }, "description": "The founded year range of companies", "nullable": true }, "YearRangeFilter2": { "type": "object", "properties": { "min": { "type": "integer", "description": "The minimum value (inclusive)", "format": "int32", "nullable": true }, "max": { "type": "integer", "description": "The maximum value (inclusive)", "format": "int32", "nullable": true } }, "description": "The latest funding year range of companies", "nullable": true } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "API Token used for authentication. Example: \"Authorization: Bearer {token}\"", "name": "Authorization", "in": "header", "x-bearer-format": "bearer" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "Company / Enrichment", "description": "Enrich company data by domain, properties, or in batch. Get company details by ID." }, { "name": "Company / Bulk Enrichment", "description": "Create and manage asynchronous bulk enrichment jobs for large domain lists." }, { "name": "Company / Search", "description": "Search companies by filters with pagination and cursor scrolling." }, { "name": "People / Search", "description": "Search people by various criteria with page-based or cursor-based pagination." }, { "name": "People / Enrichment", "description": "Resolve work email addresses for individual people in realtime or background jobs." }, { "name": "Geo", "description": "Endpoints for looking up geographic data including regions, countries, states, and cities." }, { "name": "Industries", "description": "Endpoints for listing available industry classifications used in company search filters." }, { "name": "Keywords", "description": "Endpoints for looking up keywords used in company search filters." }, { "name": "Technologies", "description": "Endpoints for looking up technologies used in company search filters." }, { "name": "User", "description": "Endpoints for retrieving information about the authenticated user, including credit balance and account details." }, { "name": "Positions", "description": "Endpoints for looking up job positions and titles." } ] }