Collect

Introduction to Collect requests

A collect request is an API call that asks a server for data.

This type of request is commonly used with two kinds of endpoints:

• Collect Endpoint: Used to get a set of data using IDs or shorthand names.

• Enrich Endpoint: Used to get a set of data using websites or social media profile URLs as input.

Supported URL formats for Enrich endpoints

Enrich endpoints should handle a variety of URL formats and match them with the companies in the used dataset.

Examples of different valid inputs include, but are not limited to:

• Full profile URL (e.g., https://www.apple.com/home)

• Variations with/without trailing slashes or subdirectories

• Variations with/without www

• URLs with/without subdomains (e.g., https://careers.amazon.com)

• Variations with/without HTTP/HTTPS URL part.

Collect all data

This is a simple request that collects a pre-defined set of information and is used to get a large set of data. See available templates below:

Collect

curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v2/{entity}/collect/{profile_id/shorthand_name}' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}'

Enrich

curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v2/{entity}/enrich?website={URL}' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}'

Collect selected data

Field Selection feature for Collect and Enrich APIs enables choosing what fields are required in the output from the available fields in the documentation.

Use a query string parameter fields and specify the field you want to collect according to the applied entity. For multiple fields collection, separate each parameter with & symbol.

See available templates below:

Collect

curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v2/{entity}/collect/{profile_id/shorthand_name}?fields={field_name}&fields={field_name}' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}'

Enrich

curl -X 'GET' \
  'https://api.coresignal.com/cdapi/v2/{entity}/enrich?website={URL}&fields={field_name}&fields={field_name}' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}'