Employee API

employee api will be deprecated on august 6th until then, you must transfer to a base employee api docid\ gobtmn jebqrtgr8akb1w read all about the benefits and changes base employee api docid\ zhyxkcw5ssxx1p94ejuwl this section covers general details about employee api follow the links inside the topics to learn more about the api and its endpoints start now all new users can test data quality with free api search and collect credits after the trial, users can select an api subscription plan based on their business needs subscription plans start at just $49/month no credit card required employee api endpoints https //docs coresignal com/api/employee api overview page#lsbn information about employee api endpoints request types https //docs coresignal com/api/employee api overview page#3ucm4 review the available request types rate limits https //docs coresignal com/api/employee api overview page#wzvb9 explore the enabled api rate limits authorization docid\ tktw cgpqdgjronl09vnj information on authorization flow in the api credits and tokens https //docs coresignal com/api/employee api overview page#x4k n learn more about api tokens and credits employee api endpoints our api is a data retrieval tool the endpoints do not support analytic features employee api features two search and two collect endpoints use the endpoints with any api compatible application to retrieve professional network employee data request type endpoint post /v2/member/search/filter post /v2/member/search/es dsl get /v2/member/collect/{member id} get /v2/member/collect/{shorthand name} bulk collect bulk api (bulk collect) expands upon employee api's functionality, featuring three post and two get endpoints request type endpoint post /v2/data requests/member/id file post /v2/data requests/member/filter post /v2/data requests/member/es dsl 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 employee data in bulk using employee ids, search filters, or es dsl queries available formats coresignal provides json and csv formats in self service and api the csv format is only available while using bulk collect endpoints read more on bulk collect in the following articles bulk collect general information https //docs coresignal com/api/bulk collect employees read more about the function and specifications of bulk collect endpoints bulk collect post requests https //docs coresignal com/api/bulk collect employees post follow the step by step guide to request employee data in bulk bulk collect get requests https //docs coresignal com/api/bulk collect employees get follow the step by step guide to collect employee data in bulk webhooks employee api's webhook 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 and function post /v2/subscriptions/member/es dsl post /v2/subscriptions/member/filter post /v2/subscriptions/member/id file webhook subscriptions docid 9ct5gwom6xlqfuyg9ti get all the details you need to subscribe to profile updates subscription simulation docid\ vwgwc6a7qrkatm8wplvbv find all the necessary information to try out the feature subscribe to changes docid\ mz1khqqe2pfktpx6m04ir find all the necessary information to create a webhook subscription and retrieve the data subscription management docid\ fa51h9ikjv4gcd zclbzm find all the necessary information for subscription management request types a ll employee api requests must be made over https requests made over http will fail 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/member/search/filter search for relevant employee profiles using search filters post /v2/member/search/es dsl search for relevant employee profiles using elasticsearch dsl schema get /v2/member/collect/{member id} collect employee data using ids get /v2/member/collect/{shorthand name} collect employee data using shorthand names 📌 full profile url example www professional network com/john doe shorthand name example john doe all personal information mentioned within this context is entirely fictional and is solely intended for illustrative purposes rate limits employee api endpoints restrict the number of requests allowed per second for each client's api token employee api search endpoints 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 credit is deducted for one successful (200) request in the search endpoints /v2/member/search/filter /v2/member/search/es dsl one collect credit is deducted for one successful (200) request in the collection endpoints /v2/member/collect/{member id} /v1/professional network/employee/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 data dictionaries and samples explore what data points we offer in our api employee data employee api sample https //docs coresignal com/api/employee api data samples employee api data dictionary https //docs coresignal com/api/employee api data