Scroll

curl --request POST \
  --url https://api.companyenrich.com/people/search/scroll \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 50,
  "cursor": "<string>",
  "companyFilter": {
    "search": {
      "lists": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "semanticQuery": "<string>",
      "semanticWeight": 0.5,
      "exclude": {
        "domains": [
          "<string>"
        ],
        "regions": [
          "<string>"
        ],
        "countries": [
          "<string>"
        ],
        "states": [
          123
        ],
        "cities": [
          123
        ],
        "type": [],
        "category": [],
        "employees": [],
        "reportedEmployees": [],
        "revenue": [],
        "naicsCode": [
          123
        ],
        "keywords": [
          "<string>"
        ],
        "technologies": [
          "<string>"
        ],
        "fundingRounds": []
      },
      "query": "<string>",
      "foundedYear": {
        "min": 123,
        "max": 123
      },
      "fundingAmount": {
        "min": 123,
        "max": 123
      },
      "fundingYear": {
        "min": 123,
        "max": 123
      },
      "workforceGrowth": {
        "minPercent": 123,
        "maxPercent": 123
      },
      "workforceSize": [
        {
          "min": 123,
          "max": 123
        }
      ],
      "require": [],
      "regions": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "states": [
        123
      ],
      "cities": [
        123
      ],
      "type": [],
      "category": [],
      "employees": [],
      "reportedEmployees": [],
      "revenue": [],
      "naicsCode": [
        123
      ],
      "keywords": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "fundingRounds": []
    },
    "similar": {
      "domains": [
        "<string>"
      ],
      "similarityWeight": 0,
      "minScore": 0.5,
      "exclude": {
        "domains": [
          "<string>"
        ],
        "regions": [
          "<string>"
        ],
        "countries": [
          "<string>"
        ],
        "states": [
          123
        ],
        "cities": [
          123
        ],
        "type": [],
        "category": [],
        "employees": [],
        "reportedEmployees": [],
        "revenue": [],
        "naicsCode": [
          123
        ],
        "keywords": [
          "<string>"
        ],
        "technologies": [
          "<string>"
        ],
        "fundingRounds": []
      },
      "query": "<string>",
      "foundedYear": {
        "min": 123,
        "max": 123
      },
      "fundingAmount": {
        "min": 123,
        "max": 123
      },
      "fundingYear": {
        "min": 123,
        "max": 123
      },
      "workforceGrowth": {
        "minPercent": 123,
        "maxPercent": 123
      },
      "workforceSize": [
        "<unknown>"
      ],
      "require": [],
      "regions": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "states": [
        123
      ],
      "cities": [
        123
      ],
      "type": [],
      "category": [],
      "employees": [],
      "reportedEmployees": [],
      "revenue": [],
      "naicsCode": [
        123
      ],
      "keywords": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "fundingRounds": []
    }
  },
  "query": "<string>",
  "positionQuery": [
    "<string>"
  ],
  "atCurrentCompanyAfter": "2023-11-07T05:31:56Z",
  "atCurrentCompanyBefore": "2023-11-07T05:31:56Z",
  "atCurrentPositionAfter": "2023-11-07T05:31:56Z",
  "atCurrentPositionBefore": "2023-11-07T05:31:56Z",
  "exclude": {
    "positionQuery": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "domains": [
      "<string>"
    ],
    "seniority": [],
    "department": [],
    "education": {
      "institutionLinkedinHandles": [
        "<string>"
      ],
      "institutionNameQuery": [
        "<string>"
      ]
    }
  },
  "countries": [
    "<string>"
  ],
  "domains": [
    "<string>"
  ],
  "seniority": [],
  "department": [],
  "education": {
    "institutionLinkedinHandles": [
      "<string>"
    ],
    "institutionNameQuery": [
      "<string>"
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 50,
    cursor: '<string>',
    companyFilter: {
      search: {
        lists: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        semanticQuery: '<string>',
        semanticWeight: 0.5,
        exclude: {
          domains: ['<string>'],
          regions: ['<string>'],
          countries: ['<string>'],
          states: [123],
          cities: [123],
          type: [],
          category: [],
          employees: [],
          reportedEmployees: [],
          revenue: [],
          naicsCode: [123],
          keywords: ['<string>'],
          technologies: ['<string>'],
          fundingRounds: []
        },
        query: '<string>',
        foundedYear: {min: 123, max: 123},
        fundingAmount: {min: 123, max: 123},
        fundingYear: {min: 123, max: 123},
        workforceGrowth: {minPercent: 123, maxPercent: 123},
        workforceSize: [{min: 123, max: 123}],
        require: [],
        regions: ['<string>'],
        countries: ['<string>'],
        states: [123],
        cities: [123],
        type: [],
        category: [],
        employees: [],
        reportedEmployees: [],
        revenue: [],
        naicsCode: [123],
        keywords: ['<string>'],
        technologies: ['<string>'],
        fundingRounds: []
      },
      similar: {
        domains: ['<string>'],
        similarityWeight: 0,
        minScore: 0.5,
        exclude: {
          domains: ['<string>'],
          regions: ['<string>'],
          countries: ['<string>'],
          states: [123],
          cities: [123],
          type: [],
          category: [],
          employees: [],
          reportedEmployees: [],
          revenue: [],
          naicsCode: [123],
          keywords: ['<string>'],
          technologies: ['<string>'],
          fundingRounds: []
        },
        query: '<string>',
        foundedYear: {min: 123, max: 123},
        fundingAmount: {min: 123, max: 123},
        fundingYear: {min: 123, max: 123},
        workforceGrowth: {minPercent: 123, maxPercent: 123},
        workforceSize: ['<unknown>'],
        require: [],
        regions: ['<string>'],
        countries: ['<string>'],
        states: [123],
        cities: [123],
        type: [],
        category: [],
        employees: [],
        reportedEmployees: [],
        revenue: [],
        naicsCode: [123],
        keywords: ['<string>'],
        technologies: ['<string>'],
        fundingRounds: []
      }
    },
    query: '<string>',
    positionQuery: ['<string>'],
    atCurrentCompanyAfter: '2023-11-07T05:31:56Z',
    atCurrentCompanyBefore: '2023-11-07T05:31:56Z',
    atCurrentPositionAfter: '2023-11-07T05:31:56Z',
    atCurrentPositionBefore: '2023-11-07T05:31:56Z',
    exclude: {
      positionQuery: ['<string>'],
      countries: ['<string>'],
      domains: ['<string>'],
      seniority: [],
      department: [],
      education: {institutionLinkedinHandles: ['<string>'], institutionNameQuery: ['<string>']}
    },
    countries: ['<string>'],
    domains: ['<string>'],
    seniority: [],
    department: [],
    education: {institutionLinkedinHandles: ['<string>'], institutionNameQuery: ['<string>']}
  })
};

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

import requests

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

payload = {
    "pageSize": 50,
    "cursor": "<string>",
    "companyFilter": {
        "search": {
            "lists": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "semanticQuery": "<string>",
            "semanticWeight": 0.5,
            "exclude": {
                "domains": ["<string>"],
                "regions": ["<string>"],
                "countries": ["<string>"],
                "states": [123],
                "cities": [123],
                "type": [],
                "category": [],
                "employees": [],
                "reportedEmployees": [],
                "revenue": [],
                "naicsCode": [123],
                "keywords": ["<string>"],
                "technologies": ["<string>"],
                "fundingRounds": []
            },
            "query": "<string>",
            "foundedYear": {
                "min": 123,
                "max": 123
            },
            "fundingAmount": {
                "min": 123,
                "max": 123
            },
            "fundingYear": {
                "min": 123,
                "max": 123
            },
            "workforceGrowth": {
                "minPercent": 123,
                "maxPercent": 123
            },
            "workforceSize": [
                {
                    "min": 123,
                    "max": 123
                }
            ],
            "require": [],
            "regions": ["<string>"],
            "countries": ["<string>"],
            "states": [123],
            "cities": [123],
            "type": [],
            "category": [],
            "employees": [],
            "reportedEmployees": [],
            "revenue": [],
            "naicsCode": [123],
            "keywords": ["<string>"],
            "technologies": ["<string>"],
            "fundingRounds": []
        },
        "similar": {
            "domains": ["<string>"],
            "similarityWeight": 0,
            "minScore": 0.5,
            "exclude": {
                "domains": ["<string>"],
                "regions": ["<string>"],
                "countries": ["<string>"],
                "states": [123],
                "cities": [123],
                "type": [],
                "category": [],
                "employees": [],
                "reportedEmployees": [],
                "revenue": [],
                "naicsCode": [123],
                "keywords": ["<string>"],
                "technologies": ["<string>"],
                "fundingRounds": []
            },
            "query": "<string>",
            "foundedYear": {
                "min": 123,
                "max": 123
            },
            "fundingAmount": {
                "min": 123,
                "max": 123
            },
            "fundingYear": {
                "min": 123,
                "max": 123
            },
            "workforceGrowth": {
                "minPercent": 123,
                "maxPercent": 123
            },
            "workforceSize": ["<unknown>"],
            "require": [],
            "regions": ["<string>"],
            "countries": ["<string>"],
            "states": [123],
            "cities": [123],
            "type": [],
            "category": [],
            "employees": [],
            "reportedEmployees": [],
            "revenue": [],
            "naicsCode": [123],
            "keywords": ["<string>"],
            "technologies": ["<string>"],
            "fundingRounds": []
        }
    },
    "query": "<string>",
    "positionQuery": ["<string>"],
    "atCurrentCompanyAfter": "2023-11-07T05:31:56Z",
    "atCurrentCompanyBefore": "2023-11-07T05:31:56Z",
    "atCurrentPositionAfter": "2023-11-07T05:31:56Z",
    "atCurrentPositionBefore": "2023-11-07T05:31:56Z",
    "exclude": {
        "positionQuery": ["<string>"],
        "countries": ["<string>"],
        "domains": ["<string>"],
        "seniority": [],
        "department": [],
        "education": {
            "institutionLinkedinHandles": ["<string>"],
            "institutionNameQuery": ["<string>"]
        }
    },
    "countries": ["<string>"],
    "domains": ["<string>"],
    "seniority": [],
    "department": [],
    "education": {
        "institutionLinkedinHandles": ["<string>"],
        "institutionNameQuery": ["<string>"]
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "location": {
        "country": {
          "code": "<string>",
          "name": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "address": "<string>"
      },
      "first_name": "<string>",
      "last_name": "<string>",
      "socials": {
        "linkedin_url": "<string>"
      },
      "experiences": [
        {
          "type": "company",
          "company": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "domain": "<string>",
            "industry": "<string>",
            "logo_url": "<string>"
          },
          "startDate": "2023-12-25",
          "endDate": "2023-12-25",
          "isCurrent": true,
          "isMatched": true,
          "position": "<string>",
          "seniority": "owner",
          "department": "c-suite"
        }
      ],
      "education": [
        {
          "institutionName": "<string>",
          "institution": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "domain": "<string>",
            "industry": "<string>",
            "logo_url": "<string>"
          },
          "socialHandle": "<string>",
          "degree": [
            "<string>"
          ],
          "startYear": 123,
          "endYear": 123
        }
      ],
      "position": "<string>",
      "seniority": "owner",
      "department": "c-suite",
      "image_url": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "totalMatching": 123
  },
  "nextCursor": "<string>",
  "previousCursor": "<string>",
  "totalItems": 123,
  "startIndex": 123
}

{
  "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>"
}

People · Search

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.

POST

people

scroll

Scroll

curl --request POST \
  --url https://api.companyenrich.com/people/search/scroll \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 50,
  "cursor": "<string>",
  "companyFilter": {
    "search": {
      "lists": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "semanticQuery": "<string>",
      "semanticWeight": 0.5,
      "exclude": {
        "domains": [
          "<string>"
        ],
        "regions": [
          "<string>"
        ],
        "countries": [
          "<string>"
        ],
        "states": [
          123
        ],
        "cities": [
          123
        ],
        "type": [],
        "category": [],
        "employees": [],
        "reportedEmployees": [],
        "revenue": [],
        "naicsCode": [
          123
        ],
        "keywords": [
          "<string>"
        ],
        "technologies": [
          "<string>"
        ],
        "fundingRounds": []
      },
      "query": "<string>",
      "foundedYear": {
        "min": 123,
        "max": 123
      },
      "fundingAmount": {
        "min": 123,
        "max": 123
      },
      "fundingYear": {
        "min": 123,
        "max": 123
      },
      "workforceGrowth": {
        "minPercent": 123,
        "maxPercent": 123
      },
      "workforceSize": [
        {
          "min": 123,
          "max": 123
        }
      ],
      "require": [],
      "regions": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "states": [
        123
      ],
      "cities": [
        123
      ],
      "type": [],
      "category": [],
      "employees": [],
      "reportedEmployees": [],
      "revenue": [],
      "naicsCode": [
        123
      ],
      "keywords": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "fundingRounds": []
    },
    "similar": {
      "domains": [
        "<string>"
      ],
      "similarityWeight": 0,
      "minScore": 0.5,
      "exclude": {
        "domains": [
          "<string>"
        ],
        "regions": [
          "<string>"
        ],
        "countries": [
          "<string>"
        ],
        "states": [
          123
        ],
        "cities": [
          123
        ],
        "type": [],
        "category": [],
        "employees": [],
        "reportedEmployees": [],
        "revenue": [],
        "naicsCode": [
          123
        ],
        "keywords": [
          "<string>"
        ],
        "technologies": [
          "<string>"
        ],
        "fundingRounds": []
      },
      "query": "<string>",
      "foundedYear": {
        "min": 123,
        "max": 123
      },
      "fundingAmount": {
        "min": 123,
        "max": 123
      },
      "fundingYear": {
        "min": 123,
        "max": 123
      },
      "workforceGrowth": {
        "minPercent": 123,
        "maxPercent": 123
      },
      "workforceSize": [
        "<unknown>"
      ],
      "require": [],
      "regions": [
        "<string>"
      ],
      "countries": [
        "<string>"
      ],
      "states": [
        123
      ],
      "cities": [
        123
      ],
      "type": [],
      "category": [],
      "employees": [],
      "reportedEmployees": [],
      "revenue": [],
      "naicsCode": [
        123
      ],
      "keywords": [
        "<string>"
      ],
      "technologies": [
        "<string>"
      ],
      "fundingRounds": []
    }
  },
  "query": "<string>",
  "positionQuery": [
    "<string>"
  ],
  "atCurrentCompanyAfter": "2023-11-07T05:31:56Z",
  "atCurrentCompanyBefore": "2023-11-07T05:31:56Z",
  "atCurrentPositionAfter": "2023-11-07T05:31:56Z",
  "atCurrentPositionBefore": "2023-11-07T05:31:56Z",
  "exclude": {
    "positionQuery": [
      "<string>"
    ],
    "countries": [
      "<string>"
    ],
    "domains": [
      "<string>"
    ],
    "seniority": [],
    "department": [],
    "education": {
      "institutionLinkedinHandles": [
        "<string>"
      ],
      "institutionNameQuery": [
        "<string>"
      ]
    }
  },
  "countries": [
    "<string>"
  ],
  "domains": [
    "<string>"
  ],
  "seniority": [],
  "department": [],
  "education": {
    "institutionLinkedinHandles": [
      "<string>"
    ],
    "institutionNameQuery": [
      "<string>"
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 50,
    cursor: '<string>',
    companyFilter: {
      search: {
        lists: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
        semanticQuery: '<string>',
        semanticWeight: 0.5,
        exclude: {
          domains: ['<string>'],
          regions: ['<string>'],
          countries: ['<string>'],
          states: [123],
          cities: [123],
          type: [],
          category: [],
          employees: [],
          reportedEmployees: [],
          revenue: [],
          naicsCode: [123],
          keywords: ['<string>'],
          technologies: ['<string>'],
          fundingRounds: []
        },
        query: '<string>',
        foundedYear: {min: 123, max: 123},
        fundingAmount: {min: 123, max: 123},
        fundingYear: {min: 123, max: 123},
        workforceGrowth: {minPercent: 123, maxPercent: 123},
        workforceSize: [{min: 123, max: 123}],
        require: [],
        regions: ['<string>'],
        countries: ['<string>'],
        states: [123],
        cities: [123],
        type: [],
        category: [],
        employees: [],
        reportedEmployees: [],
        revenue: [],
        naicsCode: [123],
        keywords: ['<string>'],
        technologies: ['<string>'],
        fundingRounds: []
      },
      similar: {
        domains: ['<string>'],
        similarityWeight: 0,
        minScore: 0.5,
        exclude: {
          domains: ['<string>'],
          regions: ['<string>'],
          countries: ['<string>'],
          states: [123],
          cities: [123],
          type: [],
          category: [],
          employees: [],
          reportedEmployees: [],
          revenue: [],
          naicsCode: [123],
          keywords: ['<string>'],
          technologies: ['<string>'],
          fundingRounds: []
        },
        query: '<string>',
        foundedYear: {min: 123, max: 123},
        fundingAmount: {min: 123, max: 123},
        fundingYear: {min: 123, max: 123},
        workforceGrowth: {minPercent: 123, maxPercent: 123},
        workforceSize: ['<unknown>'],
        require: [],
        regions: ['<string>'],
        countries: ['<string>'],
        states: [123],
        cities: [123],
        type: [],
        category: [],
        employees: [],
        reportedEmployees: [],
        revenue: [],
        naicsCode: [123],
        keywords: ['<string>'],
        technologies: ['<string>'],
        fundingRounds: []
      }
    },
    query: '<string>',
    positionQuery: ['<string>'],
    atCurrentCompanyAfter: '2023-11-07T05:31:56Z',
    atCurrentCompanyBefore: '2023-11-07T05:31:56Z',
    atCurrentPositionAfter: '2023-11-07T05:31:56Z',
    atCurrentPositionBefore: '2023-11-07T05:31:56Z',
    exclude: {
      positionQuery: ['<string>'],
      countries: ['<string>'],
      domains: ['<string>'],
      seniority: [],
      department: [],
      education: {institutionLinkedinHandles: ['<string>'], institutionNameQuery: ['<string>']}
    },
    countries: ['<string>'],
    domains: ['<string>'],
    seniority: [],
    department: [],
    education: {institutionLinkedinHandles: ['<string>'], institutionNameQuery: ['<string>']}
  })
};

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

import requests

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

payload = {
    "pageSize": 50,
    "cursor": "<string>",
    "companyFilter": {
        "search": {
            "lists": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
            "semanticQuery": "<string>",
            "semanticWeight": 0.5,
            "exclude": {
                "domains": ["<string>"],
                "regions": ["<string>"],
                "countries": ["<string>"],
                "states": [123],
                "cities": [123],
                "type": [],
                "category": [],
                "employees": [],
                "reportedEmployees": [],
                "revenue": [],
                "naicsCode": [123],
                "keywords": ["<string>"],
                "technologies": ["<string>"],
                "fundingRounds": []
            },
            "query": "<string>",
            "foundedYear": {
                "min": 123,
                "max": 123
            },
            "fundingAmount": {
                "min": 123,
                "max": 123
            },
            "fundingYear": {
                "min": 123,
                "max": 123
            },
            "workforceGrowth": {
                "minPercent": 123,
                "maxPercent": 123
            },
            "workforceSize": [
                {
                    "min": 123,
                    "max": 123
                }
            ],
            "require": [],
            "regions": ["<string>"],
            "countries": ["<string>"],
            "states": [123],
            "cities": [123],
            "type": [],
            "category": [],
            "employees": [],
            "reportedEmployees": [],
            "revenue": [],
            "naicsCode": [123],
            "keywords": ["<string>"],
            "technologies": ["<string>"],
            "fundingRounds": []
        },
        "similar": {
            "domains": ["<string>"],
            "similarityWeight": 0,
            "minScore": 0.5,
            "exclude": {
                "domains": ["<string>"],
                "regions": ["<string>"],
                "countries": ["<string>"],
                "states": [123],
                "cities": [123],
                "type": [],
                "category": [],
                "employees": [],
                "reportedEmployees": [],
                "revenue": [],
                "naicsCode": [123],
                "keywords": ["<string>"],
                "technologies": ["<string>"],
                "fundingRounds": []
            },
            "query": "<string>",
            "foundedYear": {
                "min": 123,
                "max": 123
            },
            "fundingAmount": {
                "min": 123,
                "max": 123
            },
            "fundingYear": {
                "min": 123,
                "max": 123
            },
            "workforceGrowth": {
                "minPercent": 123,
                "maxPercent": 123
            },
            "workforceSize": ["<unknown>"],
            "require": [],
            "regions": ["<string>"],
            "countries": ["<string>"],
            "states": [123],
            "cities": [123],
            "type": [],
            "category": [],
            "employees": [],
            "reportedEmployees": [],
            "revenue": [],
            "naicsCode": [123],
            "keywords": ["<string>"],
            "technologies": ["<string>"],
            "fundingRounds": []
        }
    },
    "query": "<string>",
    "positionQuery": ["<string>"],
    "atCurrentCompanyAfter": "2023-11-07T05:31:56Z",
    "atCurrentCompanyBefore": "2023-11-07T05:31:56Z",
    "atCurrentPositionAfter": "2023-11-07T05:31:56Z",
    "atCurrentPositionBefore": "2023-11-07T05:31:56Z",
    "exclude": {
        "positionQuery": ["<string>"],
        "countries": ["<string>"],
        "domains": ["<string>"],
        "seniority": [],
        "department": [],
        "education": {
            "institutionLinkedinHandles": ["<string>"],
            "institutionNameQuery": ["<string>"]
        }
    },
    "countries": ["<string>"],
    "domains": ["<string>"],
    "seniority": [],
    "department": [],
    "education": {
        "institutionLinkedinHandles": ["<string>"],
        "institutionNameQuery": ["<string>"]
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "location": {
        "country": {
          "code": "<string>",
          "name": "<string>",
          "latitude": 123,
          "longitude": 123
        },
        "address": "<string>"
      },
      "first_name": "<string>",
      "last_name": "<string>",
      "socials": {
        "linkedin_url": "<string>"
      },
      "experiences": [
        {
          "type": "company",
          "company": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "domain": "<string>",
            "industry": "<string>",
            "logo_url": "<string>"
          },
          "startDate": "2023-12-25",
          "endDate": "2023-12-25",
          "isCurrent": true,
          "isMatched": true,
          "position": "<string>",
          "seniority": "owner",
          "department": "c-suite"
        }
      ],
      "education": [
        {
          "institutionName": "<string>",
          "institution": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "domain": "<string>",
            "industry": "<string>",
            "logo_url": "<string>"
          },
          "socialHandle": "<string>",
          "degree": [
            "<string>"
          ],
          "startYear": 123,
          "endYear": 123
        }
      ],
      "position": "<string>",
      "seniority": "owner",
      "department": "c-suite",
      "image_url": "<string>",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "totalMatching": 123
  },
  "nextCursor": "<string>",
  "previousCursor": "<string>",
  "totalItems": 123,
  "startIndex": 123
}

{
  "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>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

expand

enum<string>[]

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.

Available options:

education

Body

application/json

pageSize

integer<int32>

The number of results to return in each page. Must be between 1 and 100

Required range: 1 <= x <= 100

cursor

string | null

The cursor to use for pagination. This is used for cursor based pagination. If this is set, Page will be ignored.

Maximum string length: 1024

companyFilter

object | null

The filters to be applied on the companies to find people for

Show child attributes

query

string | null

The search query to apply on the company name and domain

Maximum string length: 250

positionQuery

string[] | null

The list of search queries to apply on the person's current job position/title

atCurrentCompanyAfter

string<date-time> | null

Filter by current company join date - only include people who joined after this UTC date

atCurrentCompanyBefore

string<date-time> | null

Filter by current company join date - only include people who joined before this UTC date

atCurrentPositionAfter

string<date-time> | null

Filter by current position start date - only include people who started after this UTC date

atCurrentPositionBefore

string<date-time> | null

Filter by current position start date - only include people who started before this UTC date

exclude

object | null

Exclusion filters to apply on the people. If a person matches any of the filters here, it will be excluded from the results.

Show child attributes

countries

string[] | null

The 2 letter country codes to filter by

domains

string[] | null

The domains to find people for. Up to 2,500 domains are allowed.

seniority

enum<string>[] | null

The seniorities to filter by

Available options:

owner,

founder,

c-suite,

partner,

vp,

head,

director,

manager,

senior,

entry,

intern

department

enum<string>[] | null

The departments to filter by

Available options:

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

education

object | null

The education history filters to apply

Show child attributes

Response

items

object[]

required

The items in the list

Show child attributes

metadata

object | null

The additional metadata for the list

Show child attributes

nextCursor

string | null

The cursor for the next page

previousCursor

string | null

The cursor for the previous page

totalItems

integer<int32>

The total number of items in the list

startIndex

integer<int32> | null

The index of the first item in the entire result set

Overview

Company · Enrichment

Company · Bulk Enrichment

Company · Search

Company · Export

Company · Similar

Industries

Keywords

Technologies

Positions

User

Jobs

Company · Lists

People · Search

People · Enrichment

People · Export

Geo

Scroll

Authorizations

Query Parameters

Body

Response