{ "openapi": "3.0.1", "info": { "title": "Company Enrich API", "description": "The Company Enrich API provides programmatic access to a comprehensive database of company and person data for enrichment, search, and lead generation.\n\n## Key Features\n\n- **Company Enrichment** — Enrich company profiles by domain, ID, or matching properties. Supports single lookups, batch requests, and bulk background jobs.\n- **Company Search** — Search and filter companies by industry, location, size, technology usage, keywords, and more. Supports page-based, cursor-based, and async export pagination.\n- **People Search** — Search for professionals by job title, company, location, and other criteria. Export results in CSV or JSON.\n- **Similar Companies** — Find companies similar to a given company based on shared attributes.\n- **Company Lists** — Create and manage saved lists of companies for organizing and exporting your data.\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": "1.0.0" }, "servers": [ { "url": "https://api.companyenrich.com" } ], "paths": { "/companies/enrich": { "get": { "tags": [ "Company / Enrichment" ], "summary": "Enrich by domain", "description": "**Cost:** 1 credit per call\n\nEnriches a company using its domain name as lookup parameter.\n\nWe map each domain to a unique company so lookups via domain are fast and reliable.\nIt is the preferred way to enrich a company.\n\nIn case the domain name could not be enriched, the API will return a 404 error.", "parameters": [ { "name": "domain", "in": "query", "required": true, "schema": { "maxLength": 1024, "type": "string" } }, { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "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/CompanyInfo" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Company / Enrichment" ], "summary": "Enrich by properties", "description": "**Cost:** 1 credit per call\n\nEnriches a company using its properties.\n\nYou need to provide at least one of the following properties:\n- Name\n- LinkedinUrl\n- LinkedinId\n- TwitterUrl\n- FacebookUrl\n- InstagramUrl\n\nBest match is used to determine the company in case of ambiguity.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichRequest" } } }, "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/CompanyInfo" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/companies/enrich/batch": { "post": { "tags": [ "Company / Enrichment" ], "summary": "Batch enrich", "description": "**Cost:** 1 credit per domain enriched\n\nEnriches a list of companies using their domain names. Up to 50 domains can be provided in a single request.\n\nWe map each domain to a unique company so lookups via domain are fast and reliable.\nIt is the preferred way to enrich a company.\n\nBatching is recommended for larger lists of domains. It allows you to enrich multiple companies in a single request.\nEliminating the need to make multiple requests to the API. Also the rate limiter would be able to handle more requests.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchEnrichRequest" } } }, "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": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyInfo" } } } } } } } }, "/companies/enrich/bulk": { "post": { "tags": [ "Company / Bulk Enrichment" ], "summary": "Create job", "description": "**Cost:** 1 credit per domain successfully enriched (charged on completion)\n\nCreates an asynchronous bulk enrichment job for up to 10,000 domains.\nReturns a job ID immediately. The webhook URL will be called with a notification when processing completes.\n\nUse the status endpoint to track progress and retrieve results.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkEnrichmentRequest" } } }, "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/BulkEnrichmentResponse" } } } } } } }, "/companies/enrich/bulk/{jobId}": { "get": { "tags": [ "Company / Bulk Enrichment" ], "summary": "Get job status", "description": "**Cost:** FREE - No credits deducted\n\nReturns the current status of a bulk enrichment job.\nOnce completed, includes the results_url to download the enrichment results.", "parameters": [ { "name": "jobId", "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/BulkEnrichmentStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/companies/enrich/bulk/jobs": { "get": { "tags": [ "Company / Bulk Enrichment" ], "summary": "List jobs", "description": "**Cost:** FREE - No credits deducted\n\nReturns a paginated list of all bulk enrichment jobs for the authenticated user.\nSupports optional filtering by job status.", "parameters": [ { "name": "page", "in": "query", "description": "Page number (default: 1).", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 20, max: 100).", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "Filter jobs by status.", "schema": { "$ref": "#/components/schemas/NullableOfJobStatus" } } ], "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/PaginatedListOfBulkEnrichmentJobListItem" } } } } } } }, "/companies/search": { "post": { "tags": [ "Company / Search" ], "summary": "Search", "description": "**Cost:** 1 credit per company returned. 1 credit minimum if no results are found.\n\n**Notice**: Up to 10.000 results can be returned from this endpoint (page * pageSize can not exceed 10.000). If you need more results, please use the scroll endpoint.\n\nSearches companies based on given criteria. You can search by name, domain, industry, employees, revenue, founded year, and more.\nAt most 100 companies are returned per request. If you need more results, please use the pagination parameters.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchPageInput" } } }, "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/PaginatedListOfCompanyInfo" } } } } } } }, "/companies/search/preview": { "post": { "tags": [ "Company / Search" ], "summary": "Preview", "description": "**Cost:** FREE - No credits deducted\n\n**Requirements:** Requires **Scale** plans\n\n**Notice:** Returns top 25 results only\n\nPreview search for companies based on given criteria. You can search by name, domain, industry, employees, revenue, founded year, and more.\nThis endpoint returns the top 25 results for free, perfect for previewing search results before running a full search.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchInput" } } }, "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/PaginatedListOfCompanySummary" } } } } } } }, "/companies/search/count": { "post": { "tags": [ "Company / Search" ], "summary": "Count", "description": "**Cost:** FREE - No credits deducted\n\nReturns the total count of companies matching the given search criteria without retrieving the actual results.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchInput" } } }, "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": { "type": "integer", "format": "int32" } } } } } } }, "/companies/search/scroll": { "post": { "tags": [ "Company / Search" ], "summary": "Scroll", "description": "**Cost:** 1 credit per company returned. 1 credit minimum if no results are found.\n\nSearches companies based on given criteria. You can search by name, domain, industry, employees, revenue, founded year, and more.\nAt most 100 companies are returned per request.\n\nYou can request the next page of results by using the `cursor` parameter. The cursor is a string that encodes the current position in the result set.\nIn case on no cursor is provided, the first page of results is returned. You can then use the `next_cursor` parameter to get the next page of results.\n\nThis will allow you to scroll over the results without having to keep track of the current page number and also allow paginating into more than 10.000 results.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySearchScrollInput" } } }, "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/CursorListWithMetadataOfCompanyInfoAndScrollMetadata" } } } } } } }, "/companies/search/async": { "post": { "tags": [ "Company / Export" ], "summary": "Create export job", "description": "**Cost:** 1 credit per company returned (reserved when the job is created, settled on completion)\n\nCreates an asynchronous search export job for up to 50,000 companies.\nSupports both standard company search and similar-company search.\nReturns a job ID immediately. The webhook URL will be called with a notification when processing completes.\n\nUse the status endpoint to track progress and retrieve results.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncSearchRequest" } } }, "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/AsyncSearchResponse" } } } } } } }, "/companies/search/async/{jobId}": { "get": { "tags": [ "Company / Export" ], "summary": "Get export job status", "description": "**Cost:** FREE - No credits deducted\n\nReturns the current status of a search export job.\nOnce completed, includes the results_url to download the export results.", "parameters": [ { "name": "jobId", "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/AsyncSearchStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/companies/search/async/jobs": { "get": { "tags": [ "Company / Export" ], "summary": "List export jobs", "description": "**Cost:** FREE - No credits deducted\n\nReturns a paginated list of all search export jobs for the authenticated user.\nSupports optional filtering by job status.", "parameters": [ { "name": "page", "in": "query", "description": "Page number (default: 1).", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 20, max: 100).", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "Filter jobs by status.", "schema": { "$ref": "#/components/schemas/NullableOfJobStatus" } } ], "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/PaginatedListOfAsyncSearchJobListItem" } } } } } } }, "/companies/similar": { "post": { "tags": [ "Company / Similar" ], "summary": "Find similar", "description": "**Cost:** 5 credit per company returned. 5 credits if no results are found.\n\nFinds similar companies to the given company by id or domain. The POST route allows specifying further filtering parameters.\nAt most 100 companies are returned per request.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySimilarPageInput" } } }, "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/PaginatedListWithMetadataOfCompanyInfoAndSimilarMetadata" } } } } } } }, "/companies/similar/preview": { "post": { "tags": [ "Company / Similar" ], "summary": "Preview", "description": "**Cost:** FREE - No credits deducted\n\n**Requirements:** Requires **Scale** plans\n\n**Notice:** Returns top 25 results only\n\nPreview search for similar companies based on given criteria. You can search by domain, industry, employees, revenue, founded year, and more.\nThis endpoint returns the top 25 similar companies for free, perfect for previewing results before running a full similar search.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySimilarInput2" } } }, "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/PaginatedListWithMetadataOfCompanySummaryAndSimilarMetadata" } } } } } } }, "/companies/similar/count": { "post": { "tags": [ "Company / Similar" ], "summary": "Count", "description": "**Cost:** FREE - No credits deducted\n\nReturns the total count of similar companies matching the given search criteria without retrieving the actual results.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySimilarInput2" } } }, "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" } } } } } } }, "/companies/similar/scroll": { "post": { "tags": [ "Company / Similar" ], "summary": "Scroll", "description": "**Cost:** 5 credit per company returned. 5 credits if no results are found.\n\nFinds similar companies to the given company by id or domain. The POST route allows specifying further filtering parameters.\nAt most 100 companies are returned per request.\n\nYou can request the next page of results by using the `cursor` parameter. The cursor is a string that encodes the current position in the result set.\nIn case on no cursor is provided, the first page of results is returned. You can then use the `next_cursor` parameter to get the next page of results.\n\nThis will allow you to scroll over the results without having to keep track of the current page number and also allow paginating into more than 10.000 results.", "parameters": [ { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "workforce" ], "type": "string" } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarScrollInput" } } }, "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/CursorListWithMetadataOfCompanyInfoAndScrollSimilarMetadata" } } } } } } }, "/companies": { "get": { "tags": [ "Company / Search" ], "summary": "Get by ID", "description": "**Cost:** 1 credits per call\n\nGets a company information by its CompanyEnrich ID. You can obtain this ID by calling the Enrich endpoint or other endpoints returning company information.", "parameters": [ { "name": "id", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "expand", "in": "query", "description": "Expandable response fields. Repeat the parameter to request multiple expansions.\n\nSupported values:\n- `workforce`: costs 5 credits per company and adds the `workforce` field to `CompanyInfo`.", "schema": { "type": "array", "items": { "enum": [ "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/CompanyInfo" } } } } } } }, "/companies/workforce": { "get": { "tags": [ "Company / Enrichment" ], "summary": "Workforce", "description": "**Cost:** 5 credits per successful call\n\nReturns workforce insights for a single company.\nYou must provide exactly one lookup parameter: `id` or `domain`.\n\nThe response includes observed employee count, an employee range bucket, and headcounts grouped by root departments.", "parameters": [ { "name": "id", "in": "query", "description": "CompanyEnrich company ID. Provide either `id` or `domain`.", "schema": { "type": "string", "format": "uuid" } }, { "name": "domain", "in": "query", "description": "Company domain. Provide either `id` or `domain`.", "schema": { "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/CompanyWorkforceInfo2" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/companies/autocomplete": { "get": { "tags": [ "Company / Enrichment" ], "summary": "Autocomplete", "description": "**Cost:** FREE - No credits deducted\n\nReturns a list of companies matching the given partial domain name. This is useful for autocompleting domain names in your application.\nUp to 10 companies are returned per request.", "parameters": [ { "name": "query", "in": "query", "description": "The query to autocomplete", "required": true, "schema": { "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": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyAutoCompleteInfo" } } } } } } } }, "/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/ApiUserInfo" } } } } } } }, "/jobs": { "get": { "tags": [ "Jobs" ], "summary": "List all jobs", "description": "**Cost:** FREE - No credits deducted\n\nReturns a paginated list of all jobs (bulk enrichment, etc.) for the authenticated user.\nSupports optional filtering by job status and type.", "parameters": [ { "name": "page", "in": "query", "description": "Page number (default: 1).", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 20, max: 100).", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "Filter jobs by status.", "schema": { "$ref": "#/components/schemas/NullableOfJobStatus" } }, { "name": "type", "in": "query", "description": "Filter jobs by type (bulk_enrichment, etc.).", "schema": { "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/PaginatedListOfJobSummaryDto" } } } } } } }, "/jobs/{jobId}": { "get": { "tags": [ "Jobs" ], "summary": "Get job details", "description": "**Cost:** FREE - No credits deducted\n\nReturns details for a specific job by ID.", "parameters": [ { "name": "jobId", "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/JobSummaryDto" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/lists/companies": { "get": { "tags": [ "Company / Lists" ], "summary": "Get all lists", "description": "Get all company lists for the current user", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExhaustiveListOfCompanyListInfo" } } } }, "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" } } } } } }, "post": { "tags": [ "Company / Lists" ], "summary": "Create list", "description": "**Cost:**\n - For search: 1 credit per company returned. 1 credit if no results are found.\n - For similar: 5 credits per company returned. 5 credits if no results are found.\n\nCreates a new list based on a search or similar company request. Up to first 5000 results can be selected to be added to the list.\nIf no companies are found, the list is not created.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateListInput" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyListInfo" } } } }, "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" } } } } } } }, "/lists/companies/{id}": { "get": { "tags": [ "Company / Lists" ], "summary": "Get a list by id", "description": "Get a company list by id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyListInfo" } } } }, "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" } } } } } }, "put": { "tags": [ "Company / Lists" ], "summary": "Update list", "description": "Updates a list's properties", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateListRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyListInfo" } } } }, "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" } } } } } }, "delete": { "tags": [ "Company / Lists" ], "summary": "Delete list", "description": "Deletes a list and all its entries", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "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" } } } } } } }, "/people/lookup": { "post": { "tags": [ "People / Search" ], "summary": "Lookup person", "description": "**Cost:** 5 credits per successful call\n\nLooks up a person by email address.\n\nWe resolve the company from the email domain first, then match the person by email local-part patterns.\nReturns the best deterministic match when found.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonLookupRequest" } } }, "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/PersonInfo" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/people/email": { "get": { "tags": [ "People / Enrichment" ], "summary": "Email (BETA)", "description": "**BETA:** This endpoint is currently in beta and may change based on provider coverage and response tuning.\n\n**Cost:** 10 credits per newly accessed found email\n\nResolves a work email address for a single person on a specific domain.\n\nIf `domain` is omitted, current experience domains are tried automatically in seniority order.\nIf `domain` is provided, it must match one of the person's experiences.\n\nThe response does not expose provider details. It returns a person summary, the selected domain, and a status of `pending`, `found`, `not-found`, or `unavailable`.\nWhen the lookup completes successfully, the response also includes the resolved email and certainty value.", "parameters": [ { "name": "id", "in": "query", "description": "The CompanyEnrich person ID.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "domain", "in": "query", "description": "Optional company domain to resolve the email address on. If omitted, current experience domains are tried in seniority order.", "schema": { "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/PersonEmailEnrichmentResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/people/email/bulk": { "post": { "tags": [ "People / Enrichment" ], "summary": "Create bulk email enrichment job (BETA)", "description": "**BETA:** This endpoint is currently in beta and may change based on provider coverage, job orchestration, and response tuning.\n\n**Cost:** up to 10 credits per item (charged on completion for newly accessed found emails only)\n\nCreates an asynchronous bulk person email enrichment job for up to 1,000 lookup items.\nWhen `domain` is omitted for an item, current experience domains are tried in seniority order.\nProcessing happens asynchronously in the background. Use the status endpoint to monitor progress and retrieve the results download URL.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkPersonEmailEnrichmentRequest" } } }, "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/BulkPersonEmailEnrichmentResponse" } } } } } } }, "/people/email/bulk/{jobId}": { "get": { "tags": [ "People / Enrichment" ], "summary": "Get bulk email enrichment job status (BETA)", "description": "**BETA:** This endpoint is currently in beta and may change based on provider coverage, job orchestration, and response tuning.\n\n**Cost:** FREE - No credits deducted\n\nReturns the current status of a bulk person email enrichment job.\nOnce completed, includes the results_url to download the full results.", "parameters": [ { "name": "jobId", "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/BulkPersonEmailEnrichmentStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/people": { "get": { "tags": [ "People / Search" ], "summary": "Get by ID", "description": "**Cost:** 2 credits per call\n\nGets person information by its CompanyEnrich ID. You can obtain this ID from people search results, lookup responses, and other endpoints returning person information.", "parameters": [ { "name": "id", "in": "query", "description": "The CompanyEnrich ID of the person", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "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/PersonInfo" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/people/search": { "post": { "tags": [ "People / Search" ], "summary": "Search", "description": "**Cost:** 2 credits per person returned. 2 credits minimum if no results are found.\n\n**Notice**: Up to 10.000 results can be returned from this endpoint (page * pageSize can not exceed 10.000). If you need more results, please use the scroll endpoint.\n\nSearches people based on given criteria using page-based pagination.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchPageInput" } } }, "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/PaginatedListOfPersonInfo" } } } } } } }, "/people/search/preview": { "post": { "tags": [ "People / Search" ], "summary": "Preview", "description": "**Cost:** FREE - No credits deducted\n\n**Requirements:** Requires **Scale** plans\n\n**Notice:** Returns top 10 results only\n\nPreview search for people based on given criteria.\nThis endpoint returns the top 10 results for free, perfect for previewing search results before running a full search.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchInput" } } }, "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/PaginatedListOfPersonPreview" } } } } } } }, "/people/search/scroll": { "post": { "tags": [ "People / Search" ], "summary": "Scroll", "description": "**Cost:** 2 credits per person returned. 2 credits minimum if no results are found.\n\nSearches people based on given criteria using cursor-based pagination.\n\nYou can request the next page of results by using the `cursor` parameter. The cursor is a string that encodes the current position in the result set.\nIn case no cursor is provided, the first page of results is returned. You can then use the `next_cursor` parameter to get the next page of results.\n\nThis will allow you to scroll over the results without having to keep track of the current page number and also allow paginating into more than 10.000 results.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonSearchScrollInput" } } }, "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/CursorListWithMetadataOfPersonInfoAndPersonScrollMetadata" } } } } } } }, "/people/search/async": { "post": { "tags": [ "People / Export" ], "summary": "Create export job", "description": "**Cost:** 2 credits per person returned (reserved when the job is created, settled on completion)\n\nCreates an asynchronous search export job for up to 50,000 people.\nReturns a job ID immediately. The webhook URL will be called with a notification when processing completes.\n\nUse the status endpoint to track progress and retrieve results.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncPersonSearchRequest" } } }, "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/AsyncPersonSearchResponse" } } } } } } }, "/people/search/async/{jobId}": { "get": { "tags": [ "People / Export" ], "summary": "Get export job status", "description": "**Cost:** FREE - No credits deducted\n\nReturns the current status of a person search export job.\nOnce completed, includes the results_url to download the export results.", "parameters": [ { "name": "jobId", "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/AsyncPersonSearchStatusResponse" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/people/search/async/jobs": { "get": { "tags": [ "People / Export" ], "summary": "List export jobs", "description": "**Cost:** FREE - No credits deducted\n\nReturns a paginated list of all person search export jobs for the authenticated user.\nSupports optional filtering by job status.", "parameters": [ { "name": "page", "in": "query", "description": "Page number (default: 1).", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Number of items per page (default: 20, max: 100).", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "Filter jobs by status.", "schema": { "$ref": "#/components/schemas/NullableOfJobStatus" } } ], "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/PaginatedListOfAsyncPersonSearchJobListItem" } } } } } } }, "/geo/regions": { "get": { "tags": [ "Geo" ], "summary": "Get regions", "description": "Returns all regions.", "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/ExhaustiveListOfRegionInfo" } } } } } } }, "/geo/countries/{countryCode}": { "get": { "tags": [ "Geo" ], "summary": "Get country by code", "description": "Searches a country by its ISO 3166-1 alpha-2 code.", "parameters": [ { "name": "countryCode", "in": "path", "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/CountryInfo2" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/geo/countries": { "post": { "tags": [ "Geo" ], "summary": "Search countries", "description": "Searches countries by name. Returns up to 100 countries per page.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCountriesRequest" } } } }, "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/PaginatedListOfCountryInfo" } } } } } } }, "/geo/states": { "post": { "tags": [ "Geo" ], "summary": "Search states", "description": "Searches states by name or country codes. Returns up to 100 states per page.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchStatesRequest" } } }, "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/PaginatedListOfStateInfo" } } } } } } }, "/geo/cities": { "post": { "tags": [ "Geo" ], "summary": "Search cities", "description": "Searches cities by name or country codes. Returns up to 100 cities per page.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchCitiesRequest" } } }, "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/PaginatedListOfCityInfo" } } } } } } }, "/industries": { "get": { "tags": [ "Industries" ], "summary": "List industries", "description": "Obtain a list of all company industries", "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": { "type": "array", "items": { "$ref": "#/components/schemas/IndustryInfo" } } } } } } } }, "/keywords/autocomplete": { "get": { "tags": [ "Keywords" ], "summary": "Lookup keywords", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "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": { "type": "array", "items": { "type": "string" } } } } } } } }, "/technologies/autocomplete": { "get": { "tags": [ "Technologies" ], "summary": "Lookup technologies", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "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": { "type": "array", "items": { "type": "string" } } } } } } } }, "/positions/autocomplete": { "get": { "tags": [ "Positions" ], "summary": "Lookup positions", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "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": { "type": "array", "items": { "type": "string" } } } } } } } } }, "components": { "schemas": { "ApiUserInfo": { "required": [ "userId", "credits", "capabilities" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "credits": { "$ref": "#/components/schemas/CreditInfo" }, "capabilities": { "$ref": "#/components/schemas/CapabilitiesInfo" } } }, "AsyncPersonSearchJobListItem": { "required": [ "job_id", "status", "requested_count", "total_matching", "exported_count", "credits_charged", "created_at" ], "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the person search export job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "requested_count": { "type": "integer", "description": "Number of people requested for export.", "format": "int32" }, "total_matching": { "type": "integer", "description": "Total number of people matching the search criteria.", "format": "int32" }, "exported_count": { "type": "integer", "description": "Number of people exported in the results.", "format": "int32" }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true } } }, "AsyncPersonSearchRequest": { "required": [ "count" ], "type": "object", "properties": { "count": { "maximum": 1000000, "minimum": 1, "type": "integer", "description": "The number of people to export.", "format": "int32" }, "webhook_url": { "maxLength": 2048, "type": "string", "description": "The webhook URL to receive the notification when processing completes.", "format": "uri", "nullable": true }, "companyFilter": { "$ref": "#/components/schemas/CompanyLookupInput" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "positionQuery": { "type": "array", "items": { "type": "string" }, "description": "The list of search queries to apply on the person's current job position/title", "nullable": true }, "atCurrentCompanyAfter": { "type": "string", "description": "Filter by current company join date - only include people who joined after this UTC date", "format": "date-time", "nullable": true }, "atCurrentCompanyBefore": { "type": "string", "description": "Filter by current company join date - only include people who joined before this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionAfter": { "type": "string", "description": "Filter by current position start date - only include people who started after this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionBefore": { "type": "string", "description": "Filter by current position start date - only include people who started before this UTC date", "format": "date-time", "nullable": true }, "exclude": { "$ref": "#/components/schemas/PersonExcludeFilters" }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "domains": { "type": "array", "items": { "type": "string" }, "description": "The domains to find people for. Up to 100 domains are allowed.", "nullable": true }, "seniority": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSeniority" }, "description": "The seniorities to filter by", "nullable": true }, "department": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDepartment" }, "description": "The departments to filter by", "nullable": true }, "education": { "$ref": "#/components/schemas/PersonEducationFilterInput" } } }, "AsyncPersonSearchResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the person search export job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "requested_count": { "type": "integer", "description": "Number of people requested for export.", "format": "int32" }, "total_matching": { "type": "integer", "description": "Total number of people matching the search criteria.", "format": "int32" }, "estimated_credits": { "type": "integer", "description": "Estimated credit cost for the export job.", "format": "int32" } } }, "AsyncPersonSearchStatusResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the person search export job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "requested_count": { "type": "integer", "description": "Number of people requested for export.", "format": "int32" }, "total_matching": { "type": "integer", "description": "Total number of people matching the search criteria.", "format": "int32" }, "exported_count": { "type": "integer", "description": "Number of people exported in the results.", "format": "int32" }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true }, "results_url": { "type": "string", "description": "URL to download the person search export results (available when completed).", "nullable": true }, "error_message": { "type": "string", "description": "Error message if the job failed.", "nullable": true } } }, "AsyncSearchJobListItem": { "required": [ "job_id", "status", "requested_count", "total_matching", "exported_count", "credits_charged", "created_at" ], "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the search export job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "requested_count": { "type": "integer", "description": "Number of companies requested for export.", "format": "int32" }, "total_matching": { "type": "integer", "description": "Total number of companies matching the search criteria.", "format": "int32" }, "exported_count": { "type": "integer", "description": "Number of companies exported in the results.", "format": "int32" }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true } } }, "AsyncSearchRequest": { "required": [ "count" ], "type": "object", "properties": { "count": { "maximum": 1000000, "minimum": 1, "type": "integer", "description": "The number of companies to export.", "format": "int32" }, "webhook_url": { "maxLength": 2048, "type": "string", "description": "The webhook URL to receive the notification when processing completes.", "format": "uri", "nullable": true }, "search": { "$ref": "#/components/schemas/CompanySearchInput2" }, "similar": { "$ref": "#/components/schemas/CompanySimilarInput" } } }, "AsyncSearchResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the search export job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "requested_count": { "type": "integer", "description": "Number of companies requested for export.", "format": "int32" }, "total_matching": { "type": "integer", "description": "Total number of companies matching the search criteria.", "format": "int32" }, "estimated_credits": { "type": "integer", "description": "Estimated credit cost for the export job.", "format": "int32" } } }, "AsyncSearchStatusResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the search export job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "requested_count": { "type": "integer", "description": "Number of companies requested for export.", "format": "int32" }, "total_matching": { "type": "integer", "description": "Total number of companies matching the search criteria.", "format": "int32" }, "exported_count": { "type": "integer", "description": "Number of companies exported in the results.", "format": "int32" }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true }, "results_url": { "type": "string", "description": "URL to download the search export results (available when completed).", "nullable": true }, "error_message": { "type": "string", "description": "Error message if the job failed.", "nullable": true } } }, "BatchEnrichRequest": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "maxItems": 50, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "A list of domains to enrich. Up to 50 domains can be provided in a single request." } } }, "BulkEnrichmentJobListItem": { "required": [ "job_id", "status", "total_domains", "success_count", "failed_count", "credits_charged", "created_at" ], "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the bulk enrichment job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "total_domains": { "type": "integer", "description": "Total number of domains in the job.", "format": "int32" }, "success_count": { "type": "integer", "description": "Number of domains successfully enriched.", "format": "int32" }, "failed_count": { "type": "integer", "description": "Number of domains that failed enrichment.", "format": "int32" }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true } } }, "BulkEnrichmentRequest": { "required": [ "domains" ], "type": "object", "properties": { "domains": { "maxItems": 10000, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "A list of domains to enrich. Up to 10,000 domains can be provided." }, "webhook_url": { "maxLength": 2048, "type": "string", "description": "The webhook URL to receive the notification when processing completes.", "format": "uri", "nullable": true } } }, "BulkEnrichmentResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the bulk enrichment job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "total_domains": { "type": "integer", "description": "Total number of unique domains to be enriched.", "format": "int32" }, "estimated_credits": { "type": "integer", "description": "Estimated credit cost for the enrichment job.", "format": "int32" }, "invalid_url_count": { "type": "integer", "description": "Number of input URLs that could not be parsed as valid LinkedIn company URLs.", "format": "int32" } } }, "BulkEnrichmentStatusResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the bulk enrichment job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "total_domains": { "type": "integer", "description": "Total number of domains in the job.", "format": "int32" }, "success_count": { "type": "integer", "description": "Number of domains successfully enriched.", "format": "int32" }, "failed_count": { "type": "integer", "description": "Number of domains that failed enrichment.", "format": "int32" }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true }, "results_url": { "type": "string", "description": "URL to download the enrichment results (available when completed).", "nullable": true }, "error_message": { "type": "string", "description": "Error message if the job failed.", "nullable": true } } }, "BulkPersonEmailEnrichmentItemRequest": { "required": [ "person_id" ], "type": "object", "properties": { "person_id": { "maximum": 9223372036854776000, "minimum": 1, "type": "integer", "description": "The CompanyEnrich person ID to enrich.", "format": "int64" }, "domain": { "maxLength": 1024, "type": "string", "description": "Optional company domain to resolve the email address on. If omitted, current experience domains are tried in seniority order.", "nullable": true } } }, "BulkPersonEmailEnrichmentRequest": { "required": [ "items" ], "type": "object", "properties": { "items": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/BulkPersonEmailEnrichmentItemRequest" }, "description": "A list of person email enrichment lookups. Up to 1,000 items can be provided." }, "webhook_url": { "maxLength": 2048, "type": "string", "description": "The webhook URL to receive the notification when processing completes.", "format": "uri", "nullable": true } } }, "BulkPersonEmailEnrichmentResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the bulk person email enrichment job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "total_requests": { "type": "integer", "description": "Number of lookup items queued in the job.", "format": "int32" }, "estimated_credits": { "type": "integer", "description": "Estimated maximum credit cost for the job.", "format": "int32" } } }, "BulkPersonEmailEnrichmentStatusResponse": { "type": "object", "properties": { "job_id": { "type": "string", "description": "Unique identifier for the bulk person email enrichment job.", "format": "uuid" }, "status": { "$ref": "#/components/schemas/JobStatus" }, "total_requests": { "type": "integer", "description": "Number of lookup items queued in the job.", "format": "int32" }, "found_count": { "type": "integer", "description": "Number of lookup items that found an email.", "format": "int32" }, "not_found_count": { "type": "integer", "description": "Number of lookup items that were definitively not found.", "format": "int32" }, "unavailable_count": { "type": "integer", "description": "Number of lookup items that ended in unavailable status.", "format": "int32" }, "chunk_count": { "type": "integer", "description": "Total number of chunks in the job.", "format": "int32" }, "processed_chunks": { "type": "integer", "description": "Number of chunks that have been completed.", "format": "int32" }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true }, "results_url": { "type": "string", "description": "URL to download the enrichment results (available when completed).", "nullable": true }, "error_message": { "type": "string", "description": "Error message if the job failed.", "nullable": true } } }, "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" } } }, "CityInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the city", "format": "int32" }, "name": { "type": "string", "description": "The name of the city" }, "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 } }, "description": "The city information of the company", "nullable": true }, "CityInfo2": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the city", "format": "int32" }, "name": { "type": "string", "description": "The name of the city" }, "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 } } }, "CompanyAutoCompleteInfo": { "required": [ "domain" ], "type": "object", "properties": { "domain": { "type": "string", "description": "The domain of the company" }, "name": { "type": "string", "description": "The name of the company", "nullable": true }, "logoUrl": { "type": "string", "description": "The URL to the company logo", "nullable": true } } }, "CompanyCategory": { "enum": [ "b2b", "b2c", "b2g", "e-commerce", "media", "service-provider", "mobile", "saas" ] }, "CompanyEmployees": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K" ] }, "CompanyExcludeFilters": { "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" }, "description": "The domain names of companies to exclude from the results", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } }, "description": "Exclusion filters to apply on the companies. If a company matches any of the filters here, it will be excluded from the results.", "nullable": true }, "CompanyFinancialInfo": { "type": "object", "properties": { "stock_symbol": { "type": "string", "nullable": true }, "stock_exchange": { "type": "string", "nullable": true }, "total_funding": { "type": "integer", "format": "int64", "nullable": true }, "funding_stage": { "type": "string", "nullable": true }, "funding_date": { "type": "string", "format": "date-time", "nullable": true }, "funding": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingInfo" }, "nullable": true } }, "description": "The financial information of the company", "nullable": true }, "CompanyFundingAmountRange": { "type": "object", "properties": { "min": { "type": "number", "description": "The minimum funding amount (inclusive)", "format": "double", "nullable": true }, "max": { "type": "number", "description": "The maximum funding amount (inclusive)", "format": "double", "nullable": true } }, "description": "The funding amount range to filter by", "nullable": true }, "CompanyFundingInfo": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "nullable": true }, "amount": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } } }, "CompanyFundingRound": { "enum": [ "seed", "debt_financing", "angel", "venture", "series_a", "series_b", "series_c", "series_d", "series_e", "series_f", "series_g", "series_h", "other" ] }, "CompanyHandle": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the company", "format": "uuid" }, "name": { "maxLength": 1024, "type": "string", "description": "The name of the company", "nullable": true }, "domain": { "maxLength": 1024, "type": "string", "description": "The primary domain name of the company", "nullable": true }, "industry": { "type": "string", "description": "The main industry of the company", "nullable": true }, "logo_url": { "type": "string", "description": "The logo URL of the company", "nullable": true } }, "description": "The company handle of the experience", "nullable": true }, "CompanyInfo": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the company", "format": "uuid" }, "name": { "maxLength": 1024, "type": "string", "description": "The name of the company", "nullable": true }, "domain": { "maxLength": 1024, "type": "string", "description": "The primary domain name of the company", "nullable": true }, "website": { "type": "string", "description": "The website URL of the company", "format": "uri", "nullable": true }, "type": { "$ref": "#/components/schemas/NullableOfCompanyType" }, "industry": { "type": "string", "description": "The main 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 of the company from most to least specific.", "nullable": true }, "employees": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "revenue": { "$ref": "#/components/schemas/NullableOfCompanyRevenue" }, "description": { "type": "string", "description": "The description of the company", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The search keywords of the company", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies associated with the company", "nullable": true }, "subsidiaries": { "type": "array", "items": { "type": "string" }, "description": "The subsidiaries associated with the company", "nullable": true }, "founded_year": { "type": "integer", "description": "The year the company was founded", "format": "int32", "nullable": true }, "naics_codes": { "type": "array", "items": { "type": "string" }, "description": "The NAICS codes associated with the company", "nullable": true }, "location": { "$ref": "#/components/schemas/CompanyLocationInfo" }, "financial": { "$ref": "#/components/schemas/CompanyFinancialInfo" }, "socials": { "$ref": "#/components/schemas/CompanySocialUrls" }, "page_rank": { "type": "number", "description": "The page rank of the company", "format": "float", "nullable": true }, "workforce": { "$ref": "#/components/schemas/CompanyWorkforceInfo" }, "logo_url": { "type": "string", "description": "The logo URL of the company", "nullable": true }, "seo_description": { "type": "string", "description": "The SEO description of the company", "nullable": true }, "updated_at": { "type": "string", "description": "The last updated timestamp of the company", "format": "date-time" } } }, "CompanyListInfo": { "required": [ "id", "name", "createdAt", "originalCount", "type" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "originalCount": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/CompanyListType" } } }, "CompanyListType": { "enum": [ "Manual", "Export" ] }, "CompanyLocationInfo": { "type": "object", "properties": { "country": { "$ref": "#/components/schemas/CountryInfo" }, "state": { "$ref": "#/components/schemas/StateInfo" }, "city": { "$ref": "#/components/schemas/CityInfo" }, "address": { "type": "string", "nullable": true }, "postal_code": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } }, "description": "The location information of the company", "nullable": true }, "CompanyLookupInput": { "type": "object", "properties": { "search": { "$ref": "#/components/schemas/CompanySearchInput2" }, "similar": { "$ref": "#/components/schemas/CompanySimilarInput" } }, "description": "The filters to be applied on the companies to find people for", "nullable": true }, "CompanyRevenue": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b" ] }, "CompanySearchInput": { "type": "object", "properties": { "lists": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The list IDs to filter by", "nullable": true }, "semanticQuery": { "maxLength": 500, "type": "string", "description": "The semantic search query to find companies with. More natural language version of the standard query.", "nullable": true }, "semanticWeight": { "maximum": 1, "minimum": 0, "type": "number", "description": "The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default. Larger values will prioritize semantic similarity, smaller values will prioritize traditional search factors.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeInput" }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } } }, "CompanySearchInput2": { "type": "object", "properties": { "lists": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The list IDs to filter by", "nullable": true }, "semanticQuery": { "maxLength": 500, "type": "string", "description": "The semantic search query to find companies with. More natural language version of the standard query.", "nullable": true }, "semanticWeight": { "maximum": 1, "minimum": 0, "type": "number", "description": "The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default. Larger values will prioritize semantic similarity, smaller values will prioritize traditional search factors.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeInput" }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } }, "description": "The filters to be applied on the companies", "nullable": true }, "CompanySearchPageInput": { "type": "object", "properties": { "page": { "type": "integer", "description": "The page number to return. Must be greater than 0", "format": "int32" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The number of results to return in each page. Must be between 1 and 100", "format": "int32" }, "lists": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The list IDs to filter by", "nullable": true }, "semanticQuery": { "maxLength": 500, "type": "string", "description": "The semantic search query to find companies with. More natural language version of the standard query.", "nullable": true }, "semanticWeight": { "maximum": 1, "minimum": 0, "type": "number", "description": "The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default. Larger values will prioritize semantic similarity, smaller values will prioritize traditional search factors.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeInput" }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } } }, "CompanySearchScrollInput": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The number of results to return in each page. Must be between 1 and 100", "format": "int32" }, "cursor": { "maxLength": 1024, "type": "string", "description": "The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.", "nullable": true }, "lists": { "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "The list IDs to filter by", "nullable": true }, "semanticQuery": { "maxLength": 500, "type": "string", "description": "The semantic search query to find companies with. More natural language version of the standard query.", "nullable": true }, "semanticWeight": { "maximum": 1, "minimum": 0, "type": "number", "description": "The semantic weight to apply to the results. Must be between 0 and 1. 0.7 is default. Larger values will prioritize semantic similarity, smaller values will prioritize traditional search factors.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeInput" }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } } }, "CompanySimilarInput": { "type": "object", "properties": { "domains": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "The domains to find similar companies for. Up to 10 domains are allowed." }, "similarityWeight": { "maximum": 1, "minimum": -1, "type": "number", "description": "The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. Larger values will prioritize more similar companies, smaller values will prioritize more established companies.", "format": "double" }, "minScore": { "maximum": 1, "minimum": 0, "type": "number", "description": "The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } }, "description": "The filters used to find similar companies", "nullable": true }, "CompanySimilarInput2": { "type": "object", "properties": { "domains": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "The domains to find similar companies for. Up to 10 domains are allowed." }, "similarityWeight": { "maximum": 1, "minimum": -1, "type": "number", "description": "The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. Larger values will prioritize more similar companies, smaller values will prioritize more established companies.", "format": "double" }, "minScore": { "maximum": 1, "minimum": 0, "type": "number", "description": "The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeInput" }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } } }, "CompanySimilarPageInput": { "type": "object", "properties": { "domain": { "type": "string", "description": "The domain to find similar companies for. This is deprecated, use `domains` instead. Using `domains` with a single domain acts the same as using the `domain` parameter.", "nullable": true }, "page": { "type": "integer", "description": "The page number to return. Must be greater than 0", "format": "int32" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The number of results to return. Must be between 1 and 100", "format": "int32" }, "domains": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "The domains to find similar companies for. Up to 10 domains are allowed." }, "similarityWeight": { "maximum": 1, "minimum": -1, "type": "number", "description": "The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. Larger values will prioritize more similar companies, smaller values will prioritize more established companies.", "format": "double" }, "minScore": { "maximum": 1, "minimum": 0, "type": "number", "description": "The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeInput" }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } } }, "CompanySocialUrls": { "type": "object", "properties": { "linkedin_url": { "type": "string", "description": "The LinkedIn URL of the company", "format": "uri", "nullable": true }, "linkedin_id": { "maxLength": 1024, "type": "string", "description": "The LinkedIn ID of the company", "nullable": true }, "twitter_url": { "type": "string", "description": "The Twitter URL of the company", "format": "uri", "nullable": true }, "facebook_url": { "type": "string", "description": "The Facebook URL of the company", "format": "uri", "nullable": true }, "instagram_url": { "type": "string", "description": "The Instagram URL of the company", "format": "uri", "nullable": true }, "angellist_url": { "type": "string", "description": "The AngelList URL of the company", "format": "uri", "nullable": true }, "crunchbase_url": { "type": "string", "description": "The Crunchbase URL of the company", "format": "uri", "nullable": true }, "youtube_url": { "type": "string", "description": "The YouTube URL of the company", "format": "uri", "nullable": true }, "github_url": { "type": "string", "description": "The GitHub URL of the company", "format": "uri", "nullable": true }, "g2_url": { "type": "string", "description": "The G2 URL of the company", "format": "uri", "nullable": true } }, "description": "The social URLs of the company" }, "CompanySummary": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the company", "format": "uuid" }, "name": { "maxLength": 1024, "type": "string", "description": "The name of the company", "nullable": true }, "domain": { "maxLength": 1024, "type": "string", "description": "The primary domain name of the company", "nullable": true }, "website": { "type": "string", "description": "The website URL of the company", "format": "uri", "nullable": true }, "industry": { "type": "string", "description": "The main industry of the company", "nullable": true }, "description": { "type": "string", "description": "The description of the company", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The search keywords of the company", "nullable": true }, "logo_url": { "type": "string", "description": "The logo URL of the company", "nullable": true }, "updated_at": { "type": "string", "description": "The last updated timestamp of the company", "format": "date-time" } } }, "CompanyType": { "enum": [ "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government" ] }, "CompanyWorkforceDepartmentHeadcount": { "type": "object", "properties": { "c_suite": { "type": "integer", "description": "Headcount in the c-suite root department.", "format": "int32", "nullable": true }, "product_management": { "type": "integer", "description": "Headcount in the product management root department.", "format": "int32", "nullable": true }, "engineering_technical": { "type": "integer", "description": "Headcount in the engineering and technical root department.", "format": "int32", "nullable": true }, "design": { "type": "integer", "description": "Headcount in the design root department.", "format": "int32", "nullable": true }, "education": { "type": "integer", "description": "Headcount in the education root department.", "format": "int32", "nullable": true }, "finance": { "type": "integer", "description": "Headcount in the finance root department.", "format": "int32", "nullable": true }, "human_resources": { "type": "integer", "description": "Headcount in the human resources root department.", "format": "int32", "nullable": true }, "information_technology": { "type": "integer", "description": "Headcount in the information technology root department.", "format": "int32", "nullable": true }, "legal": { "type": "integer", "description": "Headcount in the legal root department.", "format": "int32", "nullable": true }, "marketing": { "type": "integer", "description": "Headcount in the marketing root department.", "format": "int32", "nullable": true }, "medical_health": { "type": "integer", "description": "Headcount in the medical and health root department.", "format": "int32", "nullable": true }, "operations": { "type": "integer", "description": "Headcount in the operations root department.", "format": "int32", "nullable": true }, "sales": { "type": "integer", "description": "Headcount in the sales root department.", "format": "int32", "nullable": true }, "consulting": { "type": "integer", "description": "Headcount in the consulting root department.", "format": "int32", "nullable": true } }, "description": "Headcount grouped by root department name." }, "CompanyWorkforceGrowthInput": { "type": "object", "properties": { "period": { "$ref": "#/components/schemas/NullableOfCompanyWorkforceGrowthPeriod" }, "department": { "$ref": "#/components/schemas/NullableOfCompanyWorkforceGrowthDepartment" }, "minPercent": { "type": "number", "description": "The minimum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.", "format": "double", "nullable": true }, "maxPercent": { "type": "number", "description": "The maximum workforce growth percentage (inclusive). Example: 15 means 15% growth, -10 means 10% decline.", "format": "double", "nullable": true } }, "description": "Filter companies by workforce growth percentage over a selected period and department.", "nullable": true }, "CompanyWorkforceHistoryEntry": { "required": [ "date", "department_headcount" ], "type": "object", "properties": { "date": { "type": "string", "description": "First day of the month for this snapshot.", "format": "date" }, "observed_employee_count": { "type": "integer", "description": "Observed number of distinct employees in our people dataset for this month.", "format": "int32" }, "employee_count_range": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "department_headcount": { "$ref": "#/components/schemas/CompanyWorkforceDepartmentHeadcount" }, "unclassified_headcount": { "type": "integer", "description": "Headcount where department could not be classified.", "format": "int32" } } }, "CompanyWorkforceInfo": { "required": [ "company_id", "domain", "department_headcount" ], "type": "object", "properties": { "company_id": { "type": "string", "description": "The CompanyEnrich ID of the company.", "format": "uuid" }, "domain": { "type": "string", "description": "The canonical domain of the company." }, "observed_employee_count": { "type": "integer", "description": "Observed number of distinct current employees in our people dataset.", "format": "int32" }, "employee_count_range": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "department_headcount": { "$ref": "#/components/schemas/CompanyWorkforceDepartmentHeadcount" }, "unclassified_headcount": { "type": "integer", "description": "Headcount where department could not be classified.", "format": "int32" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceHistoryEntry" }, "description": "Monthly workforce snapshots showing headcount changes over time. Only months where headcount changed are included.", "nullable": true } }, "description": "Expanded workforce insights for the company. This field is only returned when `expand=workforce` is requested.", "nullable": true }, "CompanyWorkforceInfo2": { "required": [ "company_id", "domain", "department_headcount" ], "type": "object", "properties": { "company_id": { "type": "string", "description": "The CompanyEnrich ID of the company.", "format": "uuid" }, "domain": { "type": "string", "description": "The canonical domain of the company." }, "observed_employee_count": { "type": "integer", "description": "Observed number of distinct current employees in our people dataset.", "format": "int32" }, "employee_count_range": { "$ref": "#/components/schemas/NullableOfCompanyEmployees" }, "department_headcount": { "$ref": "#/components/schemas/CompanyWorkforceDepartmentHeadcount" }, "unclassified_headcount": { "type": "integer", "description": "Headcount where department could not be classified.", "format": "int32" }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceHistoryEntry" }, "description": "Monthly workforce snapshots showing headcount changes over time. Only months where headcount changed are included.", "nullable": true } } }, "CompanyWorkforceSizeInput": { "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 } } }, "CountryInfo": { "type": "object", "properties": { "code": { "type": "string", "description": "The ISO 3166-1 alpha-2 code of the country" }, "name": { "type": "string", "description": "The name of the country" }, "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 } }, "description": "The origin country information of the company", "nullable": true }, "CountryInfo2": { "type": "object", "properties": { "code": { "type": "string", "description": "The ISO 3166-1 alpha-2 code of the country" }, "name": { "type": "string", "description": "The name of the country" }, "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 } } }, "CreateListInput": { "required": [ "name", "count" ], "type": "object", "properties": { "name": { "maxLength": 1024, "type": "string", "description": "The name of the list" }, "count": { "maximum": 10000, "minimum": 1, "type": "integer", "description": "The number of companies to add to the list", "format": "int32" }, "search": { "$ref": "#/components/schemas/CompanySearchInput2" }, "similar": { "$ref": "#/components/schemas/CompanySimilarInput" } } }, "CreditInfo": { "required": [ "used", "total" ], "type": "object", "properties": { "used": { "type": "integer", "format": "int32" }, "total": { "type": "integer", "format": "int32" } } }, "CursorListWithMetadataOfCompanyInfoAndScrollMetadata": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyInfo" }, "description": "The items in the list" }, "metadata": { "$ref": "#/components/schemas/ScrollMetadata" }, "nextCursor": { "type": "string", "description": "The cursor for the next page", "nullable": true }, "previousCursor": { "type": "string", "description": "The cursor for the previous page", "nullable": true }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" }, "startIndex": { "type": "integer", "description": "The index of the first item in the entire result set", "format": "int32", "nullable": true } } }, "CursorListWithMetadataOfCompanyInfoAndScrollSimilarMetadata": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyInfo" }, "description": "The items in the list" }, "metadata": { "$ref": "#/components/schemas/ScrollSimilarMetadata" }, "nextCursor": { "type": "string", "description": "The cursor for the next page", "nullable": true }, "previousCursor": { "type": "string", "description": "The cursor for the previous page", "nullable": true }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" }, "startIndex": { "type": "integer", "description": "The index of the first item in the entire result set", "format": "int32", "nullable": true } } }, "CursorListWithMetadataOfPersonInfoAndPersonScrollMetadata": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonInfo" }, "description": "The items in the list" }, "metadata": { "$ref": "#/components/schemas/PersonScrollMetadata" }, "nextCursor": { "type": "string", "description": "The cursor for the next page", "nullable": true }, "previousCursor": { "type": "string", "description": "The cursor for the previous page", "nullable": true }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" }, "startIndex": { "type": "integer", "description": "The index of the first item in the entire result set", "format": "int32", "nullable": true } } }, "EnrichRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the company to enrich", "nullable": true }, "linkedinUrl": { "type": "string", "description": "The LinkedIn URL of the company to enrich", "format": "uri", "nullable": true }, "linkedinId": { "type": "string", "description": "The LinkedIn ID of the company to enrich", "nullable": true }, "twitterUrl": { "type": "string", "description": "The Twitter URL of the company to enrich", "format": "uri", "nullable": true }, "facebookUrl": { "type": "string", "description": "The Facebook URL of the company to enrich", "format": "uri", "nullable": true }, "instagramUrl": { "type": "string", "description": "The Instagram URL of the company to enrich", "format": "uri", "nullable": true }, "youTubeUrl": { "type": "string", "description": "The YouTube URL of the company to enrich", "format": "uri", "nullable": true } } }, "ExhaustiveListOfCompanyListInfo": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyListInfo" }, "description": "The items in the list" } } }, "ExhaustiveListOfRegionInfo": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/RegionInfo" }, "description": "The items in the list" } } }, "FeatureRequirement": { "enum": [ "linkedin", "twitter", "facebook", "instagram", "angellist", "crunchbase", "youtube", "country", "city", "state", "revenue", "foundedYear", "anyFunding" ] }, "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" } } } } }, "IndustryInfo": { "required": [ "name", "naicsCodes" ], "type": "object", "properties": { "name": { "type": "string", "description": "Name of the industry" }, "naicsCodes": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "NAICS code prefixes associated with the industry" } } }, "JobStatus": { "enum": [ "pending", "processing", "completing", "completed", "failed" ], "description": "Current status of the job (pending, processing, completing, completed, failed)." }, "JobSummaryDto": { "required": [ "id", "type", "status", "title", "created_at", "credits_charged" ], "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the job.", "format": "uuid" }, "type": { "type": "string", "description": "The type of job (bulk_enrichment, bulk_person_email_enrichment, etc.)." }, "status": { "$ref": "#/components/schemas/JobStatus" }, "title": { "type": "string", "description": "Human-readable title of the job." }, "created_at": { "type": "string", "description": "Timestamp when the job was created.", "format": "date-time" }, "started_at": { "type": "string", "description": "Timestamp when the job started processing.", "format": "date-time", "nullable": true }, "completed_at": { "type": "string", "description": "Timestamp when the job completed.", "format": "date-time", "nullable": true }, "credits_charged": { "type": "integer", "description": "Total credits charged for this job.", "format": "int32" }, "error_message": { "type": "string", "description": "Error message if the job failed.", "nullable": true } } }, "NullableOfCompanyEmployees": { "enum": [ "1-10", "11-50", "51-200", "201-500", "501-1K", "1K-5K", "5K-10K", "over-10K", null ], "description": "The employee count range.", "nullable": true }, "NullableOfCompanyRevenue": { "enum": [ "under-1m", "1m-10m", "10m-50m", "50m-100m", "100m-200m", "200m-1b", "over-1b", null ], "description": "The range of annual revenue of the company in USD", "nullable": true }, "NullableOfCompanyType": { "enum": [ "unknown", "private", "public", "self-employed", "self-owned", "partnership", "nonprofit", "educational", "government", null ], "description": "The type of the company", "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 }, "NullableOfFilterOperator": { "enum": [ "And", "Or", null ], "description": "The operator to apply to the filters. Defaults to And.", "nullable": true }, "NullableOfJobStatus": { "enum": [ "pending", "processing", "completing", "completed", "failed", null ] }, "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 department of the person", "nullable": true }, "NullableOfPersonSeniority": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern", null ], "description": "The seniority level of the person", "nullable": true }, "PaginatedListOfAsyncPersonSearchJobListItem": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncPersonSearchJobListItem" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfAsyncSearchJobListItem": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AsyncSearchJobListItem" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfBulkEnrichmentJobListItem": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/BulkEnrichmentJobListItem" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfCityInfo": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CityInfo2" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfCompanyInfo": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyInfo" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfCompanySummary": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySummary" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfCountryInfo": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CountryInfo2" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfJobSummaryDto": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/JobSummaryDto" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfPersonInfo": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonInfo" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfPersonPreview": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PersonPreview" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListOfStateInfo": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/StateInfo2" }, "description": "The items in the list" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListWithMetadataOfCompanyInfoAndSimilarMetadata": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyInfo" }, "description": "The items in the list" }, "metadata": { "$ref": "#/components/schemas/SimilarMetadata" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PaginatedListWithMetadataOfCompanySummaryAndSimilarMetadata": { "required": [ "items" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySummary" }, "description": "The items in the list" }, "metadata": { "$ref": "#/components/schemas/SimilarMetadata" }, "page": { "type": "integer", "description": "The current page number. 1-indexed", "format": "int32" }, "totalPages": { "type": "integer", "description": "The total number of pages", "format": "int32" }, "totalItems": { "type": "integer", "description": "The total number of items in the list", "format": "int32" } } }, "PersonDepartment": { "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" ] }, "PersonEducationFilterInput": { "type": "object", "properties": { "institutionLinkedinHandles": { "type": "array", "items": { "type": "string" }, "description": "The LinkedIn handles of education institutions to filter by", "nullable": true }, "institutionNameQuery": { "type": "array", "items": { "type": "string" }, "description": "The search queries to apply on education institution names", "nullable": true } }, "description": "The education history filters to apply", "nullable": true }, "PersonEmailCertainty": { "enum": [ "unknown", "medium", "high", "very-high" ], "description": "Normalized certainty value. One of: unknown, medium, high, very-high." }, "PersonEmailEnrichmentResponse": { "required": [ "person", "person_id", "domain", "status", "certainty" ], "type": "object", "properties": { "person": { "$ref": "#/components/schemas/PersonSummary" }, "person_id": { "type": "integer", "description": "The CompanyEnrich person ID used for the lookup.", "format": "int64" }, "domain": { "type": "string", "description": "The normalized registrable domain selected for the response. When `domain` is omitted, the endpoint tries current experience domains ordered by seniority and returns the domain associated with the selected lookup result." }, "status": { "$ref": "#/components/schemas/PersonEmailEnrichmentResponseStatus" }, "email": { "type": "string", "description": "The resolved work email address when the lookup succeeds.", "nullable": true }, "certainty": { "$ref": "#/components/schemas/PersonEmailCertainty" } } }, "PersonEmailEnrichmentResponseStatus": { "enum": [ "pending", "found", "not-found", "unavailable" ], "description": "Lookup status. One of: pending, found, not-found, unavailable." }, "PersonExcludeFilters": { "type": "object", "properties": { "positionQuery": { "type": "array", "items": { "type": "string" }, "description": "The list of search queries to exclude on the person's current job position/title", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "domains": { "type": "array", "items": { "type": "string" }, "description": "The domains to find people for. Up to 100 domains are allowed.", "nullable": true }, "seniority": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSeniority" }, "description": "The seniorities to filter by", "nullable": true }, "department": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDepartment" }, "description": "The departments to filter by", "nullable": true }, "education": { "$ref": "#/components/schemas/PersonEducationFilterInput" } }, "description": "Exclusion filters to apply on the people. If a person matches any of the filters here, it will be excluded from the results.", "nullable": true }, "PersonExperience": { "required": [ "type" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/PersonExperiencePersonCompanyExperience" }, { "$ref": "#/components/schemas/PersonExperiencePersonUnknownExperience" } ], "discriminator": { "propertyName": "type", "mapping": { "company": "#/components/schemas/PersonExperiencePersonCompanyExperience", "unknown": "#/components/schemas/PersonExperiencePersonUnknownExperience" } } }, "PersonExperiencePersonCompanyExperience": { "properties": { "type": { "enum": [ "company" ], "type": "string" }, "company": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the company", "format": "uuid" }, "name": { "maxLength": 1024, "type": "string", "description": "The name of the company", "nullable": true }, "domain": { "maxLength": 1024, "type": "string", "description": "The primary domain name of the company", "nullable": true }, "industry": { "type": "string", "description": "The main industry of the company", "nullable": true }, "logo_url": { "type": "string", "description": "The logo URL of the company", "nullable": true } }, "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "isCurrent": { "type": "boolean" }, "isMatched": { "type": "boolean" }, "position": { "type": "string", "nullable": true }, "seniority": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern", null ], "nullable": true }, "department": { "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 ], "nullable": true } } }, "PersonExperiencePersonUnknownExperience": { "properties": { "type": { "enum": [ "unknown" ], "type": "string" }, "companyName": { "type": "string", "nullable": true }, "startDate": { "type": "string", "format": "date", "nullable": true }, "endDate": { "type": "string", "format": "date", "nullable": true }, "isCurrent": { "type": "boolean" }, "isMatched": { "type": "boolean" }, "position": { "type": "string", "nullable": true }, "seniority": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern", null ], "nullable": true }, "department": { "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 ], "nullable": true } } }, "PersonInfo": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the person", "format": "int64" }, "name": { "maxLength": 1024, "type": "string", "description": "The full name of the person", "nullable": true }, "location": { "$ref": "#/components/schemas/PersonLocationInfo" }, "first_name": { "type": "string", "description": "The first name of the person", "nullable": true }, "last_name": { "type": "string", "description": "The last name of the person", "nullable": true }, "socials": { "$ref": "#/components/schemas/PersonSocialUrls" }, "experiences": { "type": "array", "items": { "$ref": "#/components/schemas/PersonExperience" }, "description": "The work experiences of the person" }, "position": { "type": "string", "description": "The job position/title of the person", "nullable": true }, "seniority": { "$ref": "#/components/schemas/NullableOfPersonSeniority" }, "department": { "$ref": "#/components/schemas/NullableOfPersonDepartment" }, "image_url": { "type": "string", "description": "The image URL of the person", "nullable": true } } }, "PersonLocationInfo": { "type": "object", "properties": { "country": { "$ref": "#/components/schemas/CountryInfo" }, "address": { "type": "string", "nullable": true } }, "description": "The location information of the person", "nullable": true }, "PersonLookupRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the person to look up" } } }, "PersonPreview": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the person", "format": "int64" }, "name": { "maxLength": 1024, "type": "string", "description": "The full name of the person", "nullable": true }, "experiences": { "type": "array", "items": { "$ref": "#/components/schemas/PersonPreviewExperience" }, "description": "The narrowed work experiences of the person" }, "position": { "type": "string", "description": "The job position/title of the person", "nullable": true }, "seniority": { "$ref": "#/components/schemas/NullableOfPersonSeniority" }, "department": { "$ref": "#/components/schemas/NullableOfPersonDepartment" }, "image_url": { "type": "string", "description": "The image URL of the person", "nullable": true } } }, "PersonPreviewExperience": { "type": "object", "properties": { "is_current": { "type": "boolean", "description": "Whether this is the person's current experience" }, "is_matched": { "type": "boolean", "description": "Whether this experience matched the search filters" }, "position": { "type": "string", "description": "The job position/title of the person for this experience", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyHandle" } } }, "PersonScrollMetadata": { "type": "object", "properties": { "totalMatching": { "type": "integer", "description": "The total number of people matching the search query, disregarding any pagination limits. This is greater or equal to totalItems, which is the actual number of items that can be paginated.", "format": "int32" } }, "description": "The additional metadata for the list", "nullable": true }, "PersonSearchInput": { "type": "object", "properties": { "companyFilter": { "$ref": "#/components/schemas/CompanyLookupInput" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "positionQuery": { "type": "array", "items": { "type": "string" }, "description": "The list of search queries to apply on the person's current job position/title", "nullable": true }, "atCurrentCompanyAfter": { "type": "string", "description": "Filter by current company join date - only include people who joined after this UTC date", "format": "date-time", "nullable": true }, "atCurrentCompanyBefore": { "type": "string", "description": "Filter by current company join date - only include people who joined before this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionAfter": { "type": "string", "description": "Filter by current position start date - only include people who started after this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionBefore": { "type": "string", "description": "Filter by current position start date - only include people who started before this UTC date", "format": "date-time", "nullable": true }, "exclude": { "$ref": "#/components/schemas/PersonExcludeFilters" }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "domains": { "type": "array", "items": { "type": "string" }, "description": "The domains to find people for. Up to 100 domains are allowed.", "nullable": true }, "seniority": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSeniority" }, "description": "The seniorities to filter by", "nullable": true }, "department": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDepartment" }, "description": "The departments to filter by", "nullable": true }, "education": { "$ref": "#/components/schemas/PersonEducationFilterInput" } } }, "PersonSearchPageInput": { "type": "object", "properties": { "page": { "maximum": 1000000, "minimum": 1, "type": "integer", "description": "The page number to return. Must be greater than 0", "format": "int32" }, "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The number of results to return in each page. Must be between 1 and 100", "format": "int32" }, "companyFilter": { "$ref": "#/components/schemas/CompanyLookupInput" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "positionQuery": { "type": "array", "items": { "type": "string" }, "description": "The list of search queries to apply on the person's current job position/title", "nullable": true }, "atCurrentCompanyAfter": { "type": "string", "description": "Filter by current company join date - only include people who joined after this UTC date", "format": "date-time", "nullable": true }, "atCurrentCompanyBefore": { "type": "string", "description": "Filter by current company join date - only include people who joined before this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionAfter": { "type": "string", "description": "Filter by current position start date - only include people who started after this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionBefore": { "type": "string", "description": "Filter by current position start date - only include people who started before this UTC date", "format": "date-time", "nullable": true }, "exclude": { "$ref": "#/components/schemas/PersonExcludeFilters" }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "domains": { "type": "array", "items": { "type": "string" }, "description": "The domains to find people for. Up to 100 domains are allowed.", "nullable": true }, "seniority": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSeniority" }, "description": "The seniorities to filter by", "nullable": true }, "department": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDepartment" }, "description": "The departments to filter by", "nullable": true }, "education": { "$ref": "#/components/schemas/PersonEducationFilterInput" } } }, "PersonSearchScrollInput": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The number of results to return in each page. Must be between 1 and 100", "format": "int32" }, "cursor": { "maxLength": 1024, "type": "string", "description": "The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.", "nullable": true }, "companyFilter": { "$ref": "#/components/schemas/CompanyLookupInput" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "positionQuery": { "type": "array", "items": { "type": "string" }, "description": "The list of search queries to apply on the person's current job position/title", "nullable": true }, "atCurrentCompanyAfter": { "type": "string", "description": "Filter by current company join date - only include people who joined after this UTC date", "format": "date-time", "nullable": true }, "atCurrentCompanyBefore": { "type": "string", "description": "Filter by current company join date - only include people who joined before this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionAfter": { "type": "string", "description": "Filter by current position start date - only include people who started after this UTC date", "format": "date-time", "nullable": true }, "atCurrentPositionBefore": { "type": "string", "description": "Filter by current position start date - only include people who started before this UTC date", "format": "date-time", "nullable": true }, "exclude": { "$ref": "#/components/schemas/PersonExcludeFilters" }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "domains": { "type": "array", "items": { "type": "string" }, "description": "The domains to find people for. Up to 100 domains are allowed.", "nullable": true }, "seniority": { "type": "array", "items": { "$ref": "#/components/schemas/PersonSeniority" }, "description": "The seniorities to filter by", "nullable": true }, "department": { "type": "array", "items": { "$ref": "#/components/schemas/PersonDepartment" }, "description": "The departments to filter by", "nullable": true }, "education": { "$ref": "#/components/schemas/PersonEducationFilterInput" } } }, "PersonSeniority": { "enum": [ "owner", "founder", "c-suite", "partner", "vp", "head", "director", "manager", "senior", "entry", "intern" ] }, "PersonSocialUrls": { "type": "object", "properties": { "linkedin_url": { "type": "string", "description": "The LinkedIn URL of the company", "format": "uri", "nullable": true } }, "description": "The social URLs of the person" }, "PersonSummary": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the person", "format": "int64" }, "name": { "maxLength": 1024, "type": "string", "description": "The full name of the person", "nullable": true }, "position": { "type": "string", "description": "The job position/title of the person", "nullable": true }, "seniority": { "$ref": "#/components/schemas/NullableOfPersonSeniority" }, "department": { "$ref": "#/components/schemas/NullableOfPersonDepartment" }, "image_url": { "type": "string", "description": "The image URL of the person", "nullable": true } }, "description": "Summary information for the resolved person." }, "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 } } }, "RegionInfo": { "type": "object", "properties": { "id": { "type": "string", "description": "The ID of the region" }, "parentId": { "type": "string", "description": "The ID of the parent region", "nullable": true }, "name": { "type": "string", "description": "The name of the region" }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The countries in the region" } } }, "ScrollMetadata": { "type": "object", "properties": { "totalMatching": { "type": "integer", "description": "The total number of companies matching the search query, disregarding any pagination limits. This is greater or equal to totalItems, which is the actual number of items that can be paginated.", "format": "int32" } }, "description": "The additional metadata for the list", "nullable": true }, "ScrollSimilarMetadata": { "required": [ "scores" ], "type": "object", "properties": { "scores": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "The match score for each company mapped by id. Score is between 0 and 1. 1 is a perfect match." }, "totalMatching": { "type": "integer", "description": "The total number of companies matching the search query, disregarding any pagination limits. This is greater or equal to totalItems, which is the actual number of items that can be paginated.", "format": "int32" } }, "description": "The additional metadata for the list", "nullable": true }, "SearchCitiesRequest": { "type": "object", "properties": { "query": { "maxLength": 30, "type": "string", "nullable": true }, "countryCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "page": { "type": "integer", "format": "int32" } } }, "SearchCountriesRequest": { "type": "object", "properties": { "query": { "maxLength": 30, "type": "string", "nullable": true }, "page": { "type": "integer", "format": "int32" } }, "nullable": true }, "SearchStatesRequest": { "type": "object", "properties": { "query": { "maxLength": 30, "type": "string", "nullable": true }, "countryCodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "page": { "type": "integer", "format": "int32" } } }, "SimilarMetadata": { "required": [ "scores" ], "type": "object", "properties": { "scores": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "The match score for each company mapped by id. Score is between 0 and 1. 1 is a perfect match." } }, "description": "The additional metadata for the list", "nullable": true }, "SimilarScrollInput": { "type": "object", "properties": { "pageSize": { "maximum": 100, "minimum": 1, "type": "integer", "description": "The number of results to return in each page. Must be between 1 and 100", "format": "int32" }, "cursor": { "maxLength": 1024, "type": "string", "description": "The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.", "nullable": true }, "domains": { "maxItems": 10, "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "The domains to find similar companies for. Up to 10 domains are allowed." }, "similarityWeight": { "maximum": 1, "minimum": -1, "type": "number", "description": "The similarity weight to apply to the results. Must be between -1 and 1. 0 is default. Larger values will prioritize more similar companies, smaller values will prioritize more established companies.", "format": "double" }, "minScore": { "maximum": 1, "minimum": 0, "type": "number", "description": "The minimum similarity score required for results. Must be between 0 and 1. When omitted, the default cutoff is used.", "format": "double", "nullable": true }, "exclude": { "$ref": "#/components/schemas/CompanyExcludeFilters" }, "query": { "maxLength": 250, "type": "string", "description": "The search query to apply on the company name and domain", "nullable": true }, "foundedYear": { "$ref": "#/components/schemas/YearRange" }, "fundingAmount": { "$ref": "#/components/schemas/CompanyFundingAmountRange" }, "fundingYear": { "$ref": "#/components/schemas/YearRange" }, "categoryOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "keywordsOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "technologiesOperator": { "$ref": "#/components/schemas/NullableOfFilterOperator" }, "workforceGrowth": { "$ref": "#/components/schemas/CompanyWorkforceGrowthInput" }, "workforceSize": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyWorkforceSizeInput" }, "description": "Filter companies by absolute workforce headcount. Multiple entries can be provided to filter on different departments simultaneously.", "nullable": true }, "require": { "type": "array", "items": { "$ref": "#/components/schemas/FeatureRequirement" }, "description": "The features that must exist for the company", "nullable": true }, "regions": { "type": "array", "items": { "type": "string" }, "description": "The region IDs to filter by", "nullable": true }, "countries": { "type": "array", "items": { "type": "string" }, "description": "The 2 letter country codes to filter by", "nullable": true }, "states": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The state IDs to filter by", "nullable": true }, "cities": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The city IDs to filter by", "nullable": true }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" }, "description": "The list of company types to filter by", "nullable": true }, "category": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCategory" }, "description": "The list of company categories to filter by", "nullable": true }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyEmployees" }, "description": "The list of employee counts to filter by", "nullable": true }, "revenue": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyRevenue" }, "description": "The list of revenue ranges to filter by", "nullable": true }, "naicsCode": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "The NAICS codes to filter by. Can be 2 to 6 digit codes. In case of a 2-5 digit code, all 6 digit codes under it will be included", "nullable": true }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "The keywords to filter by", "nullable": true }, "technologies": { "type": "array", "items": { "type": "string" }, "description": "The technologies to filter by", "nullable": true }, "fundingRounds": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyFundingRound" }, "description": "The funding rounds to filter by", "nullable": true } } }, "StateInfo": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the state", "format": "int32" }, "name": { "type": "string", "description": "The name of the state" }, "code": { "type": "string", "description": "The ISO 3166-2 code of the state", "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 } }, "description": "The state information of the company", "nullable": true }, "StateInfo2": { "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the state", "format": "int32" }, "name": { "type": "string", "description": "The name of the state" }, "code": { "type": "string", "description": "The ISO 3166-2 code of the state", "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 } } }, "UpdateListRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "YearRange": { "type": "object", "properties": { "min": { "type": "integer", "description": "The minimum year (inclusive)", "format": "int32", "nullable": true }, "max": { "type": "integer", "description": "The maximum year (inclusive)", "format": "int32", "nullable": true } }, "description": "The range of years", "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": "Company / Export", "description": "Create and manage asynchronous company search export jobs." }, { "name": "Company / Similar", "description": "Find companies similar to a given company by domain or ID." }, { "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. The realtime and bulk email enrichment endpoints are currently in beta." }, { "name": "People / Export", "description": "Create and manage asynchronous people search export jobs." }, { "name": "Jobs", "description": "Endpoints for listing and monitoring background processing jobs such as bulk enrichments and async exports." }, { "name": "Company / Lists", "description": "Endpoints for creating and managing company lists and export lists." }, { "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 used in people search filters." } ] }