Export a people search asynchronously

curl --request POST \
  --url https://api.companyenrich.com/v2/people/search/export \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 500000,
  "expand": [],
  "filter": {
    "query": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain": "<string>",
    "companyLinkedinHandle": "<string>",
    "country": "<string>",
    "position": "<string>",
    "currentCompanyStartDate": {
      "after": "2023-11-07T05:31:56Z",
      "before": "2023-11-07T05:31:56Z"
    },
    "currentPositionStartDate": {
      "after": "2023-11-07T05:31:56Z",
      "before": "2023-11-07T05:31:56Z"
    },
    "education": {
      "institutionLinkedinHandle": "<string>",
      "institutionName": "<string>"
    },
    "pastExperience": {
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "companyLinkedinHandle": "<string>",
      "position": "<string>",
      "startDate": {
        "after": "2023-11-07T05:31:56Z",
        "before": "2023-11-07T05:31:56Z"
      },
      "endDate": {
        "after": "2023-11-07T05:31:56Z",
        "before": "2023-11-07T05:31:56Z"
      }
    }
  },
  "semantic": {
    "query": "<string>"
  },
  "company": {
    "filter": {
      "query": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "keywords": "<string>",
      "technologies": "<string>",
      "region": "<string>",
      "country": "<string>",
      "state": 123,
      "city": 123,
      "workforceGrowth": {
        "min": 123,
        "max": 123
      },
      "workforceSize": [
        {
          "min": 123,
          "max": 123
        }
      ],
      "naicsCodes": "<string>",
      "foundedYear": {
        "min": 123,
        "max": 123
      },
      "fundingAmount": {
        "min": 123,
        "max": 123
      },
      "fundingYear": {
        "min": 123,
        "max": 123
      }
    },
    "semantic": {
      "query": "<string>",
      "weight": 0.5,
      "autoFilter": true
    },
    "lookalike": {
      "domains": [
        "<string>"
      ],
      "weight": 0,
      "minScore": 0.5
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    limit: 500000,
    expand: [],
    filter: {
      query: '<string>',
      companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      domain: '<string>',
      companyLinkedinHandle: '<string>',
      country: '<string>',
      position: '<string>',
      currentCompanyStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
      currentPositionStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
      education: {institutionLinkedinHandle: '<string>', institutionName: '<string>'},
      pastExperience: {
        companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        domain: '<string>',
        companyLinkedinHandle: '<string>',
        position: '<string>',
        startDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
        endDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'}
      }
    },
    semantic: {query: '<string>'},
    company: {
      filter: {
        query: '<string>',
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        domain: '<string>',
        keywords: '<string>',
        technologies: '<string>',
        region: '<string>',
        country: '<string>',
        state: 123,
        city: 123,
        workforceGrowth: {min: 123, max: 123},
        workforceSize: [{min: 123, max: 123}],
        naicsCodes: '<string>',
        foundedYear: {min: 123, max: 123},
        fundingAmount: {min: 123, max: 123},
        fundingYear: {min: 123, max: 123}
      },
      semantic: {query: '<string>', weight: 0.5, autoFilter: true},
      lookalike: {domains: ['<string>'], weight: 0, minScore: 0.5}
    }
  })
};

fetch('https://api.companyenrich.com/v2/people/search/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.companyenrich.com/v2/people/search/export"

payload = {
    "limit": 500000,
    "expand": [],
    "filter": {
        "query": "<string>",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "domain": "<string>",
        "companyLinkedinHandle": "<string>",
        "country": "<string>",
        "position": "<string>",
        "currentCompanyStartDate": {
            "after": "2023-11-07T05:31:56Z",
            "before": "2023-11-07T05:31:56Z"
        },
        "currentPositionStartDate": {
            "after": "2023-11-07T05:31:56Z",
            "before": "2023-11-07T05:31:56Z"
        },
        "education": {
            "institutionLinkedinHandle": "<string>",
            "institutionName": "<string>"
        },
        "pastExperience": {
            "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "domain": "<string>",
            "companyLinkedinHandle": "<string>",
            "position": "<string>",
            "startDate": {
                "after": "2023-11-07T05:31:56Z",
                "before": "2023-11-07T05:31:56Z"
            },
            "endDate": {
                "after": "2023-11-07T05:31:56Z",
                "before": "2023-11-07T05:31:56Z"
            }
        }
    },
    "semantic": { "query": "<string>" },
    "company": {
        "filter": {
            "query": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "domain": "<string>",
            "keywords": "<string>",
            "technologies": "<string>",
            "region": "<string>",
            "country": "<string>",
            "state": 123,
            "city": 123,
            "workforceGrowth": {
                "min": 123,
                "max": 123
            },
            "workforceSize": [
                {
                    "min": 123,
                    "max": 123
                }
            ],
            "naicsCodes": "<string>",
            "foundedYear": {
                "min": 123,
                "max": 123
            },
            "fundingAmount": {
                "min": 123,
                "max": 123
            },
            "fundingYear": {
                "min": 123,
                "max": 123
            }
        },
        "semantic": {
            "query": "<string>",
            "weight": 0.5,
            "autoFilter": True
        },
        "lookalike": {
            "domains": ["<string>"],
            "weight": 0,
            "minScore": 0.5
        }
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "<string>",
  "status": "pending",
  "progress": {
    "total": 123,
    "pending": 123,
    "running": 123,
    "succeeded": 123,
    "failed": 123,
    "unknown": 123,
    "cancelled": 123
  },
  "creditsCharged": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "statusUrl": "<string>",
  "resultsUrl": "<string>",
  "rawResultsUrl": "<string>",
  "recordCount": 123,
  "recordLimit": 123,
  "completedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

People · Search Export

Export a people search asynchronously

Pages through a people search in the background, up to limit results, and stores the records for download. The query is the same as POST /v2/people/search, without pageSize and cursor. Requires an API key. Each page is an ordinary search request at the normal per-record price, with the requested expansions; the last page asks only for the results still missing, and results whose record is unavailable are skipped. There is no upfront balance check: a failed page, such as a 402 once credits run out, stops the export, and the records already exported stay downloadable. limit cannot exceed your plan’s search limit. GET /v2/batches/{id} reports progress with recordCount and recordLimit, and resultsUrl downloads the records. Exports that expand company request 25 people per page, since a page can expand at most 500 unique companies.

POST

people

export

curl --request POST \
  --url https://api.companyenrich.com/v2/people/search/export \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 500000,
  "expand": [],
  "filter": {
    "query": "<string>",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "domain": "<string>",
    "companyLinkedinHandle": "<string>",
    "country": "<string>",
    "position": "<string>",
    "currentCompanyStartDate": {
      "after": "2023-11-07T05:31:56Z",
      "before": "2023-11-07T05:31:56Z"
    },
    "currentPositionStartDate": {
      "after": "2023-11-07T05:31:56Z",
      "before": "2023-11-07T05:31:56Z"
    },
    "education": {
      "institutionLinkedinHandle": "<string>",
      "institutionName": "<string>"
    },
    "pastExperience": {
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "companyLinkedinHandle": "<string>",
      "position": "<string>",
      "startDate": {
        "after": "2023-11-07T05:31:56Z",
        "before": "2023-11-07T05:31:56Z"
      },
      "endDate": {
        "after": "2023-11-07T05:31:56Z",
        "before": "2023-11-07T05:31:56Z"
      }
    }
  },
  "semantic": {
    "query": "<string>"
  },
  "company": {
    "filter": {
      "query": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "keywords": "<string>",
      "technologies": "<string>",
      "region": "<string>",
      "country": "<string>",
      "state": 123,
      "city": 123,
      "workforceGrowth": {
        "min": 123,
        "max": 123
      },
      "workforceSize": [
        {
          "min": 123,
          "max": 123
        }
      ],
      "naicsCodes": "<string>",
      "foundedYear": {
        "min": 123,
        "max": 123
      },
      "fundingAmount": {
        "min": 123,
        "max": 123
      },
      "fundingYear": {
        "min": 123,
        "max": 123
      }
    },
    "semantic": {
      "query": "<string>",
      "weight": 0.5,
      "autoFilter": true
    },
    "lookalike": {
      "domains": [
        "<string>"
      ],
      "weight": 0,
      "minScore": 0.5
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    limit: 500000,
    expand: [],
    filter: {
      query: '<string>',
      companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      domain: '<string>',
      companyLinkedinHandle: '<string>',
      country: '<string>',
      position: '<string>',
      currentCompanyStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
      currentPositionStartDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
      education: {institutionLinkedinHandle: '<string>', institutionName: '<string>'},
      pastExperience: {
        companyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        domain: '<string>',
        companyLinkedinHandle: '<string>',
        position: '<string>',
        startDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'},
        endDate: {after: '2023-11-07T05:31:56Z', before: '2023-11-07T05:31:56Z'}
      }
    },
    semantic: {query: '<string>'},
    company: {
      filter: {
        query: '<string>',
        id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        domain: '<string>',
        keywords: '<string>',
        technologies: '<string>',
        region: '<string>',
        country: '<string>',
        state: 123,
        city: 123,
        workforceGrowth: {min: 123, max: 123},
        workforceSize: [{min: 123, max: 123}],
        naicsCodes: '<string>',
        foundedYear: {min: 123, max: 123},
        fundingAmount: {min: 123, max: 123},
        fundingYear: {min: 123, max: 123}
      },
      semantic: {query: '<string>', weight: 0.5, autoFilter: true},
      lookalike: {domains: ['<string>'], weight: 0, minScore: 0.5}
    }
  })
};

fetch('https://api.companyenrich.com/v2/people/search/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.companyenrich.com/v2/people/search/export"

payload = {
    "limit": 500000,
    "expand": [],
    "filter": {
        "query": "<string>",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "domain": "<string>",
        "companyLinkedinHandle": "<string>",
        "country": "<string>",
        "position": "<string>",
        "currentCompanyStartDate": {
            "after": "2023-11-07T05:31:56Z",
            "before": "2023-11-07T05:31:56Z"
        },
        "currentPositionStartDate": {
            "after": "2023-11-07T05:31:56Z",
            "before": "2023-11-07T05:31:56Z"
        },
        "education": {
            "institutionLinkedinHandle": "<string>",
            "institutionName": "<string>"
        },
        "pastExperience": {
            "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "domain": "<string>",
            "companyLinkedinHandle": "<string>",
            "position": "<string>",
            "startDate": {
                "after": "2023-11-07T05:31:56Z",
                "before": "2023-11-07T05:31:56Z"
            },
            "endDate": {
                "after": "2023-11-07T05:31:56Z",
                "before": "2023-11-07T05:31:56Z"
            }
        }
    },
    "semantic": { "query": "<string>" },
    "company": {
        "filter": {
            "query": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "domain": "<string>",
            "keywords": "<string>",
            "technologies": "<string>",
            "region": "<string>",
            "country": "<string>",
            "state": 123,
            "city": 123,
            "workforceGrowth": {
                "min": 123,
                "max": 123
            },
            "workforceSize": [
                {
                    "min": 123,
                    "max": 123
                }
            ],
            "naicsCodes": "<string>",
            "foundedYear": {
                "min": 123,
                "max": 123
            },
            "fundingAmount": {
                "min": 123,
                "max": 123
            },
            "fundingYear": {
                "min": 123,
                "max": 123
            }
        },
        "semantic": {
            "query": "<string>",
            "weight": 0.5,
            "autoFilter": True
        },
        "lookalike": {
            "domains": ["<string>"],
            "weight": 0,
            "minScore": 0.5
        }
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "kind": "<string>",
  "status": "pending",
  "progress": {
    "total": 123,
    "pending": 123,
    "running": 123,
    "succeeded": 123,
    "failed": 123,
    "unknown": 123,
    "cancelled": 123
  },
  "creditsCharged": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "statusUrl": "<string>",
  "resultsUrl": "<string>",
  "rawResultsUrl": "<string>",
  "recordCount": 123,
  "recordLimit": 123,
  "completedAt": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>",
  "errors": {}
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

API Token used for authentication. Example: "Authorization: Bearer {token}"

Body

application/json

limit

integer<int32> | null

required

The maximum number of search results to export. Results whose person is no longer available are skipped, so an export can return fewer people. Your plan's search limit also applies.

Required range: 1 <= x <= 1000000

expand

enum<string>[] | null

Additional person data to include, charged on top of the base cost. Repeating an expansion does not multiply its cost:

education: 1 credit per returned person.
company: 1 credit per unique company successfully expanded across the returned current and past experiences. Includes the standard company profile; separately priced company expansions are not included. Unavailable companies retain their summary without an expansion charge. Search charges each company once per response page. Limited to 500 unique available companies per request; exceeding the limit returns 400 without charging credits. Reduce pageSize for searches or remove company from expand.

Available options:

education,

company

filter

object | null

The filters to apply to the people search

Show child attributes

semantic

object | null

The natural-language query used to infer person filters and the current companies

Show child attributes

company

object | null

The company query used to find people whose current companies match

Show child attributes

Response

Accepted

string<uuid>

required

The batch ID.

kind

string

required

The task represented by the batch.

status

enum<string>

required

The current batch state.

Available options:

pending,

running,

completed,

cancelling,

cancelled

progress

object

required

The number of requests in each state.

Show child attributes

creditsCharged

number<double>

required

The credits charged so far, in user-visible credits.

createdAt

string<date-time>

required

When the batch was created.

statusUrl

string

required

The authenticated URL for checking batch status and progress.

resultsUrl

string

required

The download URL for the task's projected results. It is signed, so it works without credentials for one hour; after that, use the owner's credentials or a URL from a new status response.

rawResultsUrl

string

required

The download URL for raw HTTP outcomes in NDJSON format, signed like resultsUrl.

recordCount

integer<int32> | null

For a search export, the number of records its settled pages returned.

recordLimit

integer<int32> | null

For a search export, the most search results it requests. Results whose record is unavailable are skipped, so recordCount can end below it.

completedAt

string<date-time> | null

When the batch completed or was cancelled, if terminal.

Overview

Company · Enrichment

Company · Bulk Enrichment

Company · Search Export

People · Search Export

Company · Search

People · Search

Industries

Keywords

Technologies

Positions

User

Batches

People · Enrichment

Geo

Export a people search asynchronously

Authorizations

Body

Response