# Collect

{% hint style="info" %}
All company information mentioned within this context is entirely fictional and is solely intended for illustrative purposes.
{% endhint %}

Find instructions for collection endpoint usage and data collection.\
Use the collection endpoints to collect company data using IDs or shorthand names.\
::::LinkArray\
:::LinkArrayItem{headerImage headerColor}

### [Data collection using IDs](https://docs.coresignal.com/api/company-api-requests-collect#WOQb_)

Learn how to obtain company data using IDs.\
:::

:::LinkArrayItem{headerImage headerColor}

### [Data collection using shorthand names](https://docs.coresignal.com/api/company-api-requests-collect#XWfpG)

Learn how to obtain company data using shorthand names.\
:::\
::::

| Key            | Collect endpoint                              |
| -------------- | --------------------------------------------- |
| Company ID     | */v2/company\_base/collect/{company\_id}*     |
| Shorthand name | */v2/company\_base/collect/{shorthand\_name}* |

| Key                    | Value                                                                                                                                                                                     |
| ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Company ID             | Retrieved using search endpoints.                                                                                                                                                         |
| Company shorthand name | Taken directly from profile URL (e.g., example-company from\* [www.professional-network.com/company/example-company\\](http://www.professional-network.com/company/example-company\\)\*). |

***

***

::

<details>

<summary>Additional information</summary>

Other tutorials/helpful information for you to check before using the Company API collection endpoints:

</details>

:LinkArray\
:::LinkArrayItem{headerImage headerColor}\
\### \[Search filters endpoint]\(<https://docs.coresignal.com/api/company-api-search-filters-endpoint)\\>
:::

:::LinkArrayItem{headerImage headerColor}

### [Search requests in Postman](https://docs.coresignal.com/api/company-api-search-postman)

:::

:::LinkArrayItem{headerImage headerColor}

### [Elasticsearch schema](https://docs.coresignal.com/api/company-api-esdsl-endpoint#D5EfQ)

:::

:::LinkArrayItem{headerImage headerColor}

### [Elasticsearch requests in Postman](https://docs.coresignal.com/api/company-api-esdsl-postman)

:::\
::::\
:::::

{% hint style="info" %}
Examples in this article are prepared using Postman.

However, you can use the tool that is most convenient for you: terminal, Postman, or any API-compatible application.
{% endhint %}

:

<details>

<summary>Collection using IDs</summary>

* Paste in the numeric profile ID instead of `{company_id}` and your API Key instead of `{API Key}` in the request template:

</details>

CodeblockTabs\
cURL request

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

:::

* Copy the edited request.
* Import the request in Postman by clicking the *Import* button and pasting the request in:

![](https://archbee-image-uploads.s3.amazonaws.com/iNaodsHbfav9t72Jx5JdM/rSVPHIol_xvsw94Gh3nhs_image.png)

* Click *Authorization*
* Select \*API Key. \*Enter the correct values\
  \- Key – enter `apikey`\
  \- Value – enter your unique API Key
* Send the request
* Collect company data from *Body.*\
  ::::

:

<details>

<summary>Collection using shorthand names</summary>

* Paste in the selected shorthand name instead of `{shorthand_name}` and your API Key instead of `{API Key}` in the request template:

</details>

CodeblockTabs\
cURL request example

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

:::

* Copy the edited request.
* Import the request in Postman by clicking on the Import button and pasting the request in:

![](https://archbee-image-uploads.s3.amazonaws.com/iNaodsHbfav9t72Jx5JdM/rSVPHIol_xvsw94Gh3nhs_image.png)

* Click\* Authorization\*
* Select the\* API Key. \*Enter the correct values\
  \- Key – enter `apikey`\
  \- Value – enter your unique API Key
* Send the request
* Collect company data from *Body.*\
  ::::
