Clean Employee API

overview this section covers the main information about clean employee api clean employee api docid\ ooiao2cqqptrfrtvl6hvu information about clean employee api endpoints clean employee api docid\ ooiao2cqqptrfrtvl6hvu information about the available request types clean employee api docid\ ooiao2cqqptrfrtvl6hvu information about the enabled api rate limits authorization docid\ tktw cgpqdgjronl09vnj information about authorization flow in the api clean employee api docid\ ooiao2cqqptrfrtvl6hvu information about api tokens and credits you can try out the clean employee api playground on coresignal's self service clean employee endpoints clean data api features one search and two collect endpoints use the endpoints with any api compatible application to retrieve clean employee data request type endpoint post /v2/employee clean/search/es dsl get /v2/employee clean/collect/{employee id} get /v2/employee clean/collect/{shorthand name} bulk collect use the following endpoints to retrieve clean employee api data in bulk request type endpoint post /v2/data requests/employee clean/id file post /v2/data requests/employee clean/es dsl get /v2/data requests/{data request id}/files get /v2/data requests/{data request id}/files/{file name} bulk collect docid nkzkaqeb0ldzmdey0yjr read more about the bulk collect feature in clean employee api webhook subscriptions webhook subscription feature allows you to set up subscriptions and be notified of work experience changes in selected employee profiles use the following endpoints to subscribe and be notified of work experience changes webhook subscriptions docid\ tgkgxfefx8v9dlg9yv4fe get all the details you need to subscribe to be notified of work experience changes subscription simulation docid\ ilrqgc7 5gxwvpo0r8r6 find all the necessary information to try out the feature subscribe to changes docid 4h5pddh aoae8oslsels7 find all the necessary information to create a webhook subscription and retrieve the data subscription management docid\ roe1urg9 di4bu59qj7bn find all the necessary information for subscription management request types a ll clean employee api requests must be made over https requests made over http will fail clean 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 clean/search/es dsl search for relevant employee profiles using elasticsearch dsl schema get /v2/employee clean/collect/{employee id} collect employee data using ids get /v2/employee clean/collect/{shorthand name} collect employee data using shorthand names 📌 full profile url example www professional network com/in/john doe shorthand name example john doe rate limits clean employee api endpoints restrict the requests allowed per second for each client's api token clean employee api search endpoints bulk collect endpoints clean employee api collection endpoints allow 18 requests per second allow 27 requests per second allow 54 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/employee clean/search/es dsl one collect credit is deducted for one successful (200) request in the collection endpoints /v2/employee clean/collect/{employee id} /v2/employee clean/collect/{shorthand name} remember that making one bulk collect request will consume more credits as you get bigger data batches data dictionaries and samples explore what data points we offer in our clean employee data data dictionary clean employee api docid\ gcduhhoqjyt6fyfx6qdyo sample clean employee api docid\ wssholm7ztokoczty7zq6