Employee Data
...
Endpoints
Bulk Collect
POST Requests
23min
overview bulk collect features three post endpoints, making collecting employee data records in bulk easier before you proceed with your bulk collect requests, test them in the employee api first to avoid any unexpected costs this step is important because these requests can potentially be quite expensive by doing this, you can see how many records your query will return and understand the credits the bulk collect query will require choose the post request that fits you the best search post requests https //docs coresignal com/api/bulk collect employees post#hnabv request employee data using a search filter query elasticsearch post requests https //docs coresignal com/api/bulk collect employees post#eziyr request employee data using an elasticsearch query id post requests https //docs coresignal com/api/bulk collect employees post#munib request employee data by submitting a list of ids search post requests use the endpoint /v2/data requests/member/filter to request employee data in bulk using search filters search endpoint filters search endpoint filters { "name" "string", "title" "string", "location" "string", "industry" "string", "summary" "string", "created at gte" "string", "created at lte" "string", "last updated gte" "string", "last updated lte" "string", "deleted" true, "country" "string", "skill" "string", "certification name" "string", "experience title" "string", "experience company name" "string", "experience company exact name" "string", "experience company website url" "string", "experience company website exact url" "string", "experience company professional network url" "string", "experience company industry" "string", "experience company size" "string", "experience company employees count gte" 0, "experience company employees count lte" 0, "experience date from" "string", "experience date to" "string", "experience description" "string", "experience deleted" true, "experience company id" 0, "active experience" true, "keyword" "string", "education institution name" "string", "education institution exact name" "string", "education program name" "string", "education description" "string", "education date from" "string", "education date to" "string", "education institution professional network url" "string" } endpoint usage prepare your request using the template below \ input required filters in the "filters" {} section \ input your webhook url instead of {optional webhook url} input the required number of records instead of {optional integer} by limit parameter request body template curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/member/filter' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "webhook url" "{optional webhook url}", "limit" {optional integer}, "filters" {} }' keep in mind that parameters webhook url and limit are optional request example example request curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/member/filter' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "webhook url" "{optional webhook url}", "limit" {optional integer}, "filters" { "title" "cso", "location" "united states", "industry" "information technology" } }' insert your api key instead of {api key} import the prepared curl request to any api compatible application send the request retrieve the request id from the response body request id { "request id" "433869ec 0a98 4dcd 9b13 db4df58260f5" } use the request id in the /v2/data requests/{data request id}/files and /v2/data requests/{data request id}/files/{file name} endpoints to retrieve the employee profile data elasticsearch post requests use the endpoint /v2/data requests/member/es dsl to request employee data in bulk using our elasticsearch dsl schema elasticsearch schema elasticsearch schema "mappings" { "properties" { "id" { "type" "long" }, "name" { "type" "text" }, "first name" { "type" "text" }, "last name" { "type" "text", }, "title" { "type" "text" }, "user generated headline" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "url" { "type" "text", "fields" { "exact" { "type" "keyword", } } }, "hash" { "type" "keyword", }, "location" { "type" "text" }, "industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "summary" { "type" "text" }, "connections" { "type" "keyword", }, "recommendations count" { "type" "long", "null value" 1 }, "logo url" { "type" "keyword", }, "last response code" { "type" "long", "null value" 1, }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "outdated" { "type" "byte", }, "deleted" { "type" "byte", }, "country" { "type" "keyword", "null value" "null" }, "connections count" { "type" "long", "null value" 1 }, "experience count" { "type" "long", "null value" 1 }, "member shorthand name" { "type" "keyword" }, "member shorthand name hash" { "type" "keyword", }, "canonical url" { "type" "text", "fields" { "exact" { "type" "keyword" } } }, "canonical hash" { "type" "keyword" }, "canonical shorthand name" { "type" "keyword" }, "canonical shorthand name hash" { "type" "keyword" }, "member also viewed collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "title" { "type" "text" }, "location" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member awards collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "issuer" { "type" "text" }, "description" { "type" "text" }, "date" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member certifications collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "authority" { "type" "text" }, "url" { "type" "keyword" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss", }, "deleted" { "type" "byte" } } }, "member courses collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "position" { "type" "text" }, "courses" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member courses suggestion collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "course suggestion id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member courses suggestion list" { "properties" { "id" { "type" "long" }, "name" { "type" "keyword" }, "hash" { "type" "keyword" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member education collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text", "fields" { "raw" { "type" "keyword", "null value" "null" } } }, "subtitle" { "type" "text" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "activities and societies" { "type" "text" }, "description" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "school url" { "type" "text", "fields" { "exact" { "type" "keyword" } } } } }, "member experience collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "location" { "type" "text", }, "company name" { "type" "text", "fields" { "raw" { "type" "keyword", "null value" "null" } } }, "company url" { "type" "keyword" }, "company url shorthand name" { "type" "keyword" }, "company url canonical shorthand name" { "type" "keyword" }, "company industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company website" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" }, "domain only" { "type" "text" } } }, "company employees count" { "type" "unsigned long" }, "company size" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "duration" { "type" "text" }, "description" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "order in profile" { "type" "long" }, "company id" { "type" "long" } } }, "member groups collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "keyword" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member interests collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "interest id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member interest list" { "properties" { "id" { "type" "long" }, "interest" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member languages collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "language id" { "type" "long" }, "proficiency id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member language list" { "properties" { "id" { "type" "long" }, "language" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } }, "member language proficiency list" { "properties" { "id" { "type" "long" }, "proficiency" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member organizations collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "organization" { "type" "keyword" }, "position" { "type" "keyword" }, "description" { "type" "text" }, "date from" { "type" "keyword" }, "date to" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member patents collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "status id" { "type" "long" }, "inventors" { "type" "text" }, "date" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "url" { "type" "keyword" }, "description" { "type" "text" }, "valid area" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member patent status list" { "properties" { "id" { "type" "long" }, "status" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member posts see more urls collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member projects collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "url" { "type" "keyword" }, "description" { "type" "text" }, "date from" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "date to" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000" }, "team members" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member publications collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "title" { "type" "text" }, "publisher" { "type" "keyword" }, "date" { "type" "date", "format" "mmmm uuuu||uuuu", "null value" "1000", }, "description" { "type" "text" }, "authors" { "type" "text" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member recommendations collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "recommendation" { "type" "text" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member similar profiles collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "url" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member skills collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "skill id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member skill list" { "properties" { "id" { "type" "long" }, "skill" { "type" "text" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member test scores collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "name" { "type" "text" }, "date" { "type" "keyword" }, "description" { "type" "text" }, "score" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member volunteering cares collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "care id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering care list" { "properties" { "id" { "type" "long" }, "care" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering opportunities collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "opportunity id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering opportunity list" { "properties" { "id" { "type" "long" }, "opportunity" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering positions collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "organization" { "type" "text" }, "role" { "type" "keyword" }, "cause id" { "type" "long" }, "date from" { "type" "keyword" }, "date to" { "type" "keyword" }, "duration" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "description" { "type" "text" }, "organization url" { "type" "keyword" }, "member volunteering positions cause list" { "properties" { "id" { "type" "long" }, "cause" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member volunteering supports collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "support id" { "type" "long" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" }, "member volunteering support list" { "properties" { "id" { "type" "long" }, "support" { "type" "keyword" }, "hash" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" } } } } }, "member websites collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "website" { "type" "keyword" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } }, "member hidden status collection" { "type" "nested", "properties" { "id" { "type" "long" }, "member id" { "type" "long" }, "is hidden" { "type" "byte" }, "created" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "last updated" { "type" "date", "format" "yyyy mm dd hh\ mm\ ss" }, "deleted" { "type" "byte" } } } } } endpoint usage prepare your request using the template below \ input required es dsl filters in the "es dsl query" {} section \ input your webhook url instead of {optional webhook url} input the required number of records instead of {optional integer} by limit parameter request body template curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/member/es dsl' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "webhook url" "{optional webhook url}", "limit" {optional integer}, "es dsl query" {} }' keep in mind that parameters webhook url and limit are optional request example all company information mentioned within this context is entirely fictional and is solely intended for illustrative purposes example request curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/member/es dsl' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "webhook url" "{optional webhook url}", "limit" {optional integer}, "es dsl query" { "query" { "bool" { "must" \[ { "match" { "title" { "query" "developer", "operator" "and" } } }, { "match" { "location" { "query" "united states", "operator" "and" } } }, { "nested" { "path" "member experience collection", "query" { "bool" { "must" \[ { "query string" { "query" "example company", "default field" "member experience collection company name", "default operator" "and" } } ] } } } } ] } } } }' insert your api key instead of {api key} import the curl to any api compatible application send the request retrieve the request id from the response body request id { "request id" "433869ec 0a98 4dcd 9b13 db4df58260f5" } use the request id in the /v2/data requests/{data request id}/files and /v2/data requests/{data request id}/files/{file name} endpoints to retrieve the employee profile data id post requests use the endpoint /v2/data requests/member/id file to submit a list of ids in a csv or txt file to request employee data in bulk check the example for the id list formatting https //archbee doc uploads s3 amazonaws com/inaodshbfav9t72jx5jdm/cjdkl0wlyb3kqdqsix8fj idlistexample csv endpoint usage prepare the ids file in a csv or txt format make sure the list only contains numeric ids avoid any additional headings in the file the request will fail if non numeric data is present in the file enter your api key instead of {api key} and, optionally, webhook url in the curl request template curl request curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/member/id file' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type multipart/form data' \\ f 'ids file=@id list example csv;type=text/csv' \\ f 'data format=json' \\ f 'webhook url={optional webhook url}' import the edited curl request to postman or any other api compatible application further instructions are for the post requests using postman click body upload the ids file by clicking the select files button in the value column send the request retrieve the request id from the response body request id { "request id" "433869ec 0a98 4dcd 9b13 db4df58260f5" } use the request id in the /v2/data requests/{data request id}/files and /v2/data requests/{data request id}/files/{file name} endpoints following steps make a get request using /v2/data requests/{data request id}/files retrieve the data file name use /v2/data requests/{data request id}/files/{file name} endpoint to download the json data using the request id and file name get the file name https //docs coresignal com/api/bulk collect employees get#dm8it detailed information on how to retrieve the file name get the file https //docs coresignal com/api/bulk collect employees get#8 2j6 in depth instructions on how to download the data file