Company API

13min

This section covers general details about Company API. Follow the links inside the topics to learn more about the API and its endpoints.

Company API endpoints

Our API is a data retrieval tool. The endpoints do not support analytic features.

Company API features two search and two collect endpoints. Use the endpoints with any API-compatible application to retrieve Professional Network Company data.

Endpoint URL/function

/v1/professional_network/company/search/filter [POST]

/v1/professional_network/company/search/es_dsl [POST]

/v1/professional_network/company/collect/{company_id} [GET]

/v1/professional_network/company/collect/{shorthand_name} [GET]

Bulk API (Bulk Collect) expands upon Company API's functionality, featuring three POST and two GET endpoints.

Endpoint URL/function

/v1/professional_network/company/bulk_collect/id_file [POST]

/v1/professional_network/company/bulk_collect/filter [POST]

/v1/professional_network/company/bulk_collect/es_dsl [POST]

/v1/bulk_collect/{data_request_id}/files [GET]

/v1/bulk_collect/{data_request_id}/files/{file_name} [GET]

Bulk Collect allows you to search and collect company data in bulk using company IDs, search filters, or ES DSL queries.

Available formats

Coresignal provides JSON and CSV formats in Self-service and API (Swagger UI). The CSV format is only available while using Bulk Collect endpoints.

Read more about Bulk Collect in the following articles:

Request types

All Company API requests must be made over HTTPS. Requests made over HTTP will fail.

Company API supports two types of requests:

  • Search endpoints support POST HTTP requests only.
  • Collect endpoints support the GET HTTP requests only.

Request type

Endpoint

Function

POST

Search for relevant company profiles using search filters

POST

Search for relevant company profiles using Elasticsearch DSL schema

GET

Collect company data using IDs

GET

Collect company data using shorthand names*

*📌 Full profile URL example: www.professional-network.com/example-company. Shorthand name example: example-company.

All personal information mentioned within this context is entirely fictional and is solely intended for illustrative purposes.

Rate limits

Company API endpoints restrict the number of requests allowed per second for each client's API token.

Company API search endpoints

Company API collection endpoints

Bulk API POST endpoints

Bulk API GET endpoints

Allow 18 requests per second.

Allow 54 requests per second.

Allow 27 requests per second.

Allow 27 requests per second.

Authorization

To start using our API, you need a (JWT) token. Your account manager or sales will generate the token for you upon your request for the API plan. You can also get the token from Coresignal's self-service platform.

  1. Get a JWT token from your account manager, sales representative, or Coresignal's self-service platform.


All requests to the Employee API must contain an Authorization header that consists of a Bearer authentication string and the JSON Web Token (JWT).

Authorization header
Authorization header

Python
Ruby
Node.js
PHP


Use any API-compatible tool to authorize and start querying in the API. If you're unsure where to begin, check out the cURL authorization tutorial:

Credits and tokens

The token issued for you has a set amount of search and collect credits.

One search credit is deducted for one successful (200) request in the search endpoints:

  • /v1​/professional_network/company/search​/filter
  • /v1/professional_network/company/search/es_dsl


One collect credit is deducted for one successful (200) request in the collection endpoints:

  • /v1/professional_network/company/collect/{company_id}
  • /v1/professional_network/company/collect/{shorthand_name}

Remember that making one Bulk Collect request will consume more credits as you get bigger data batches.

Discuss your credit needs with your account manager.

Every search and collect response contains an X-Credits-Remaining header that shows the number of credits left in your account.

You can find the credit balance by clicking Headers in Postman.

Document image


Example of remaining credits header:

JSON


Data dictionaries and samples

Explore what data points we offer in our API company data:







Updated 09 Dec 2024
Did this page help you?