Base Employee API

overview this section covers basic information about base employee api to learn more about the api and its endpoints, follow the links below base employee api /#base employee api endpoints find information about base employee api endpoints base employee api /#request types i nformation about available request types base employee api /#rate limits i nformation about available rate limits authorization docid\ tktw cgpqdgjronl09vnj authorization flow in the api base employee api docid\ gobtmn jebqrtgr8akb1w information about api credits and tokens base employee api endpoints our api is a data retrieval tool the endpoints do not support analytic features base employee api features three search and two collect endpoints for searching and collecting relevant base employee data request type endpoint post /v2/employee base/search/filter post /v2/employee base/search/es dsl post /v2/employee base/map/ids get /v2/employee base/collect/{employee id} get /v2/employee base/collect/{shorthand name} bulk collect bulk api (bulk collect) expands upon base employee api's functionality, featuring five post and two get endpoints request type endoint post /v2/data requests/employee base/ids post /v2/data requests/employee base/es dsl post /v2/data requests/employee base/filter post /v2/data requests/employee base/shorthand names post /v2/data requests/employee base/urls get /v2/data requests/{data request id}/files get /v2/data requests/{data request id}/files/{file name} bulk collect allows you to search and collect base employee data in bulk using employee ids, search filters, or es dsl queries read more on bulk collect in the following articles bulk collect docid\ zdtahjzhpw06i8fulkeon read more about the function and specifications of bulk collect endpoints post requests docid\ hvajncbflry6xoff 548c follow the step by step guide to request base employee data in bulk get requests docid\ sxlwwtymx9hieydap5wso follow the step by step guide to collect base employee data in bulk webhook subscriptions base employee api's subscription feature allows you to track updates in selected profiles by setting up a callback url to receive notifications about changes use the following endpoints to subscribe to changes in employee data request type endpoint post /v2/subscriptions/employee base/ids post /v2/subscriptions/employee base/es dsl post /v2/subscriptions/employee base/filter webhook subscriptions docid\ ut xggm ibmtusznmsqsc get all the details you need to subscribe to be notified of employee profile changes subscription simulation docid\ ubtjtkuptye9iz0xsgiii find all the necessary information to try out the feature subscribe to changes docid\ cp99d8xsk0zim4xwtfwyi find all the necessary information to create a webhook subscription and retrieve the data subscription management docid\ uucjk2eqgjjgy1vlpvkov find all the necessary information for subscription management request types a ll base employee api requests must be made over https requests made over http will fail base employee api supports two types of requests search endpoints support post requests only collect endpoints support the get r equests only request type endpoint function post /v2/employee base/search/filter search for relevant employee profiles using search filters post /v2/employee base/search/es dsl search for relevant employee profiles using elasticsearch dsl schema post /v2/employee base/map/ids ids mapping endpoint between employee and base employee apis get /v2/employee base/collect/{employee id} collect base employee data using ids get /v2/employee base/collect/{shorthand name} collect base employee data using shorthand names 📌 full profile url example www professional network com/in/ john doe shorthand name example john doe rate limits base employee api endpoints restrict the number of requests allowed per second for each client's api token base employee api search endpoints base employee 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 credits and tokens the token issued for you has a set amount of search and collect credits one search credits are deducted for one successful (200) request in the search endpoint /v2/employee base/search/filter /v2/employee base/search/es dsl /v2/employee base/map/ids one collection credits are deducted for one successful (200) request in the collection endpoints /v2/employee base/collect/{employee id} /v2/employee base/collect/{shorthand name} data dictionary and samples explore data points in api base employee data data dictionary base employee api docid 9rmqssm16xnbsvs wjbqu sample base employee api docid 0cde3nsybzq1gvuntygez