Database APIs

Company API

13min

Overview
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﻿
Find information about Company API endpoints. 
﻿Request types﻿
Review the available request types.
﻿Rate limits﻿
Explore the enabled API rate limits.
﻿Authorization﻿
Information about authorization flow in the API.
﻿Credits and tokens﻿
Learn more about API tokens and credits.
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]
Multi-source API
Use Multi-source API to retrieve Multi-source Company data using our API. 
Multi-source API features one search and two collection endpoints. 
Endpoint URL and function
/v1/multi_source/company/search/filter [POST]
/v1/multi_source/company/collect/{id} [GET]
/v1/multi_source/company/collect/{shorthand_name} [GET]
Read more on Multi-source API in the following articles:
﻿All about Multi-source API﻿
Find all the necessary details about Multi-source API usage. 
﻿Elasticsearch DSL endpoint﻿
Find ES DSL schema and tips for endpoint usage.
﻿Collection requests﻿
Find information about Multi-source API collection functionality. 
Bulk Collect
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. 

Read more about Bulk Collect in the following articles:
﻿Bulk Collect general information﻿
Read more about the function and specifications of Bulk Collect endpoints.
﻿Bulk Collect POST requests﻿
Follow the step-by-step guide to request company data in bulk.
﻿Bulk Collect GET requests﻿
Follow the step-by-step guide to collect company data in bulk.
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
﻿/v1​/professional_network/company/search​/filter ﻿
Search for relevant company profiles using search filters
POST
﻿/v1/professional_network/company/search/es_dsl﻿
Search for relevant company profiles using Elasticsearch DSL schema
GET
﻿/v1​/professional_network/company/collect​/{company_id}﻿
Collect company data using IDs
GET
﻿/v1/professional_network/company/collect/
{shorthand_name}﻿
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 27 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. 
﻿
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
-H “Authorization: Bearer {JWT}”
-H “Authorization: Bearer {JWT}”
﻿
General authorization examples
Python
Ruby
Node.js
PHP
import requests

api_endpoint = "API_ENDPOINT"
jwt_token = "JWT_TOKEN"

headers = {
    "Authorization": f"Bearer {jwt_token}"
}

response = requests.get(api_endpoint, headers=headers)

# Print the response content or handle it as needed
print(response.text)
import requests

api_endpoint = "API_ENDPOINT"
jwt_token = "JWT_TOKEN"

headers = {
    "Authorization": f"Bearer {jwt_token}"
}

response = requests.get(api_endpoint, headers=headers)

# Print the response content or handle it as needed
print(response.text)
﻿
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:
﻿Authorize using Postman ﻿
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. 
Where can I see my credit balance?
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.
﻿
Example of remaining credits header:
JSON
x-credits-remaining: 9973
x-credits-remaining: 9973
﻿
Data dictionaries and samples
Explore what data points we offer in our API company data:
﻿Company API sample﻿
﻿Company API data dictionary﻿
﻿
﻿
﻿

Updated 23 Sep 2024

Did this page help you?

Collect

Authorization

Request type	Endpoint	Function
POST	/v1/professional_network/company/search/filter	Search for relevant company profiles using search filters
POST	/v1/professional_network/company/search/es_dsl	Search for relevant company profiles using Elasticsearch DSL schema
GET	/v1/professional_network/company/collect/{company_id}	Collect company data using IDs
GET	/v1/professional_network/company/collect/ {shorthand_name}	Collect company data using shorthand names*

Company API

Overview

﻿Company API endpoints﻿

﻿Request types﻿

﻿Rate limits﻿

﻿Authorization﻿

﻿Credits and tokens﻿

Company API endpoints

Multi-source API

﻿All about Multi-source API﻿

﻿Elasticsearch DSL endpoint﻿

﻿Collection requests﻿

Bulk Collect

﻿Bulk Collect general information﻿

﻿Bulk Collect POST requests﻿

﻿Bulk Collect GET requests﻿

Request types

Rate limits

Authorization

General authorization examples

﻿Authorize using Postman ﻿

Credits and tokens

Where can I see my credit balance?

Data dictionaries and samples

﻿Company API sample﻿

﻿Company API data dictionary﻿

Company API endpoints

Request types

Rate limits

Authorization

Credits and tokens

All about Multi-source API

Elasticsearch DSL endpoint

Collection requests

Bulk Collect general information

Bulk Collect POST requests

Bulk Collect GET requests

Authorize using Postman

Company API sample

Company API data dictionary