> ## Documentation Index > Fetch the complete documentation index at: https://docs.companyenrich.com/llms.txt > Use this file to discover all available pages before exploring further. # Scroll > **Cost:** 2 credits per person returned. 2 credits minimum if no results are found. Searches people based on given criteria using cursor-based pagination. You 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. In 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. This 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. ## OpenAPI ````yaml openapi/v1.json POST /people/search/scroll openapi: 3.0.4 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. ## Key Features - **Company Enrichment** — Enrich company profiles by domain, ID, or matching properties. Supports single lookups, batch requests, and bulk background jobs. - **Company Search** — Search and filter companies by industry, location, size, technology usage, keywords, and more. Supports page-based, cursor-based, and async export pagination. - **People Search** — Search for professionals by job title, company, location, and other criteria. Export results in CSV or JSON. - **Similar Companies** — Find companies similar to a given company based on shared attributes. - **Company Lists** — Create and manage saved lists of companies for organizing and exporting your data. ## Authentication All API requests require a Bearer token passed in the `Authorization` header: ``` Authorization: Bearer YOUR_API_TOKEN ``` You can generate API tokens from your [dashboard](https://companyenrich.com/dashboard). ## Credits Most 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. ## Rate Limiting The 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. Supplementary 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 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. - 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. paths: /people/search/scroll: post: tags: - People / Search summary: Scroll description: >- **Cost:** 2 credits per person returned. 2 credits minimum if no results are found. Searches people based on given criteria using cursor-based pagination. You 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. In 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. This 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. Supported values: - `education`: costs 1 credit per person and adds the `education` field to `PersonInfo`. schema: type: array items: enum: - education type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PersonSearchScrollInput' required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/CursorListWithMetadataOfPersonInfoAndPersonScrollMetadata '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' '422': description: Unprocessable Entity content: application/problem+json: schema: $ref: '#/components/schemas/HttpValidationProblemDetails' '429': description: Too Many Requests content: application/problem+json: schema: $ref: '#/components/schemas/ProblemDetails' components: schemas: 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 2,500 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' 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 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 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 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 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 2,500 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 PersonSeniority: enum: - owner - founder - c-suite - partner - vp - head - director - manager - senior - entry - intern 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 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 education: type: array items: $ref: '#/components/schemas/PersonEducationInfo' description: >- The education history of the person. This field is only returned when `expand=education` is requested. 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 updated_at: type: string description: The timestamp representing when the person's data was last updated format: date-time nullable: true 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 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 reportedEmployees: type: array items: $ref: '#/components/schemas/CompanyEmployees' description: The list of externally reported 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 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 reportedEmployees: type: array items: $ref: '#/components/schemas/CompanyEmployees' description: The list of externally reported 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 PersonLocationInfo: type: object properties: country: $ref: '#/components/schemas/CountryInfo' address: type: string nullable: true description: The location information of the person nullable: true 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 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' PersonEducationInfo: required: - institutionName type: object properties: institutionName: type: string description: The name of the educational institution institution: $ref: '#/components/schemas/CompanyHandle' socialHandle: type: string description: The social media handle of the educational institution nullable: true degree: type: array items: type: string description: The degrees or fields of study associated with this education entry nullable: true startYear: type: integer description: The year this education entry started format: int16 nullable: true endYear: type: integer description: The year this education entry ended format: int16 nullable: true NullableOfPersonSeniority: enum: - owner - founder - c-suite - partner - vp - head - director - manager - senior - entry - intern - null description: The seniority level of the person nullable: true NullableOfPersonDepartment: enum: - c-suite - c-suite/executive - c-suite/finance-executive - c-suite/founder - c-suite/human-resources-executive - c-suite/information-technology-executive - c-suite/legal-executive - c-suite/marketing-executive - c-suite/medical-health-executive - c-suite/operations-executive - c-suite/sales-executive - product-management - product-management/product-development - product-management/product-management - engineering-technical - engineering-technical/artificial-intelligence-machine-learning - engineering-technical/bioengineering - engineering-technical/biometrics - engineering-technical/business-intelligence - engineering-technical/chemical-engineering - engineering-technical/cloud-mobility - engineering-technical/data-science - engineering-technical/devops - engineering-technical/digital-transformation - engineering-technical/emerging-technology-innovation - engineering-technical/engineering-technical - engineering-technical/industrial-engineering - engineering-technical/mechanic - engineering-technical/mobile-development - engineering-technical/project-management - engineering-technical/research-development - engineering-technical/scrum-master-agile-coach - engineering-technical/software-development - engineering-technical/support-technical-services - engineering-technical/technician - engineering-technical/technology-operations - engineering-technical/test-quality-assurance - engineering-technical/ui-ux - engineering-technical/web-development - design - design/all-design - design/product-ui-ux-design - design/graphic-design - education - education/teacher - education/principal - education/superintendent - education/professor - finance - finance/accounting - finance/finance - finance/financial-planning-analysis - finance/financial-reporting - finance/financial-strategy - finance/financial-systems - finance/internal-audit-control - finance/investor-relations - finance/mergers-acquisitions - finance/real-estate-finance - finance/financial-risk - finance/shared-services - finance/sourcing-procurement - finance/tax - finance/treasury - human-resources - human-resources/compensation-benefits - human-resources/culture-diversity-inclusion - human-resources/employee-labor-relations - human-resources/health-safety - human-resources/human-resource-information-system - human-resources/human-resources - human-resources/hr-business-partner - human-resources/learning-development - human-resources/organizational-development - human-resources/recruiting-talent-acquisition - human-resources/talent-management - human-resources/workforce-management - human-resources/people-operations - information-technology - information-technology/application-development - information-technology/business-service-management-itsm - information-technology/collaboration-web-app - information-technology/data-center - information-technology/data-warehouse - information-technology/database-administration - information-technology/ecommerce-development - information-technology/enterprise-architecture - information-technology/help-desk-desktop-services - information-technology/hr-financial-erp-systems - information-technology/information-security - information-technology/information-technology - information-technology/infrastructure - information-technology/it-asset-management - information-technology/it-audit-it-compliance - information-technology/it-operations - information-technology/it-procurement - information-technology/it-strategy - information-technology/it-training - information-technology/networking - information-technology/project-program-management - information-technology/quality-assurance - information-technology/retail-store-systems - information-technology/servers - information-technology/storage-disaster-recovery - information-technology/telecommunications - information-technology/virtualization - legal - legal/acquisitions - legal/compliance - legal/contracts - legal/corporate-secretary - legal/ediscovery - legal/ethics - legal/governance - legal/governmental-affairs-regulatory-law - legal/intellectual-property-patent - legal/labor-employment - legal/lawyer-attorney - legal/legal - legal/legal-counsel - legal/legal-operations - legal/litigation - legal/privacy - marketing - marketing/advertising - marketing/brand-management - marketing/content-marketing - marketing/customer-experience - marketing/customer-marketing - marketing/demand-generation - marketing/digital-marketing - marketing/ecommerce-marketing - marketing/event-marketing - marketing/field-marketing - marketing/lead-generation - marketing/marketing - marketing/marketing-analytics-insights - marketing/marketing-communications - marketing/marketing-operations - marketing/product-marketing - marketing/public-relations - marketing/search-engine-optimization-pay-per-click - marketing/social-media-marketing - marketing/strategic-communications - marketing/technical-marketing - medical-health - medical-health/anesthesiology - medical-health/chiropractics - medical-health/clinical-systems - medical-health/dentistry - medical-health/dermatology - medical-health/doctors-physicians - medical-health/epidemiology - medical-health/first-responder - medical-health/infectious-disease - medical-health/medical-administration - medical-health/medical-education-training - medical-health/medical-research - medical-health/medicine - medical-health/neurology - medical-health/nursing - medical-health/nutrition-dietetics - medical-health/obstetrics-gynecology - medical-health/oncology - medical-health/opthalmology - medical-health/optometry - medical-health/orthopedics - medical-health/pathology - medical-health/pediatrics - medical-health/pharmacy - medical-health/physical-therapy - medical-health/psychiatry - medical-health/psychology - medical-health/public-health - medical-health/radiology - medical-health/social-work - operations - operations/call-center - operations/construction - operations/corporate-strategy - operations/customer-service-support - operations/enterprise-resource-planning - operations/facilities-management - operations/leasing - operations/logistics - operations/office-operations - operations/operations - operations/physical-security - operations/project-development - operations/quality-management - operations/real-estate - operations/safety - operations/store-operations - operations/supply-chain - sales - sales/account-management - sales/business-development - sales/channel-sales - sales/customer-retention-development - sales/customer-success - sales/field-outside-sales - sales/inside-sales - sales/partnerships - sales/revenue-operations - sales/sales - sales/sales-enablement - sales/sales-engineering - sales/sales-operations - sales/sales-training - consulting - consulting/consultant - null description: The department of the person nullable: true 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 reportedEmployees: type: array items: $ref: '#/components/schemas/CompanyEmployees' description: The list of externally reported 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 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 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 NullableOfFilterOperator: enum: - And - Or - null description: The operator to apply to the filters. Defaults to And. nullable: true 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 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 FeatureRequirement: enum: - linkedin - twitter - facebook - instagram - angellist - crunchbase - youtube - country - city - state - revenue - foundedYear - anyFunding CompanyType: enum: - private - public - self-employed - self-owned - partnership - nonprofit - educational - government CompanyCategory: enum: - b2b - b2c - b2g - e-commerce - media - service-provider - mobile - saas - local-business CompanyEmployees: enum: - 1-10 - 11-50 - 51-200 - 201-500 - 501-1K - 1K-5K - 5K-10K - over-10K CompanyRevenue: enum: - under-1m - 1m-10m - 10m-50m - 50m-100m - 100m-200m - 200m-1b - over-1b CompanyFundingRound: enum: - seed - debt_financing - angel - venture - series_a - series_b - series_c - series_d - series_e - series_f - series_g - series_h - other 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 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 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 matched educational institution nullable: true NullableOfCompanyWorkforceGrowthPeriod: enum: - m6 - y1 - y2 - null description: The period to measure workforce growth over. 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 securitySchemes: Bearer: type: apiKey description: >- API Token used for authentication. Example: "Authorization: Bearer {token}" name: Authorization in: header x-bearer-format: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.