Employee Data
...
Clean Employee API
Endpoints
Elasticsearch DSL
6min
data type clean employee api query type elasticsearch domain specific language (es dsl) url https //api coresignal com/cdapi /v2/employee clean/search/es dsl overview use the /v2/employee clean/search/es dsl endpoint to find employee ids matching your specifications elasticsearch schema allows you to use more sophisticated queries like fuzzy and wildcard queries additionally, the endpoint allows you to use the elasticsearch dsl schema that mimics our clean employee data elasticsearch dsl docid\ pkoqnjhsbflf7svuhv5au refer to the clean employee elasticsearch schema elasticsearch dsl docid\ pkoqnjhsbflf7svuhv5au information about possible sorting options elasticsearch dsl docid\ pkoqnjhsbflf7svuhv5au information about the endpoint limitations elasticsearch schema elasticsearch structure maps directly to our clean employee data clean employee data docid\ dvnz9ecfbk6jpizfrjosr endpoint schema { "mappings" { "properties" { "id" { "type" "long" }, "company id" { "type" "long" }, "full name" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "name first" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "name middle" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "name last" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "websites professional network" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "description" { "type" "text" }, "job title" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "management level" { "type" "keyword" }, "department" { "type" "keyword" }, "is decision maker" { "type" "byte" }, "is working" { "type" "byte" }, "job description" { "type" "text" }, "activity" { "type" "nested", "properties" { "activity url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "title" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "action" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "order in profile" { "type" "integer" } } }, "organizations" { "type" "nested", "properties" { "organization" { "type" "text" }, "position" { "type" "text" }, "description" { "type" "text" }, "date from" { "type" "date" }, "date from year" { "type" "short" }, "date from month" { "type" "byte" }, "date to" { "type" "date" }, "date to year" { "type" "short" }, "date to month" { "type" "byte" }, "order in profile" { "type" "long" } } }, "patents" { "type" "nested", "properties" { "title" { "type" "text" }, "status" { "type" "text" }, "inventors" { "type" "nested", "properties" { "full name" { "type" "keyword" }, "profile url" { "type" "text" }, "order in profile" { "type" "long" } } }, "date" { "type" "date" }, "date year" { "type" "short" }, "date month" { "type" "byte" }, "date day" { "type" "byte" }, "patent url" { "type" "text" }, "description" { "type" "text" }, "patent or application number" { "type" "keyword" }, "order in profile" { "type" "long" } } }, "publications" { "type" "nested", "properties" { "title" { "type" "text" }, "publisher" { "type" "text" }, "date" { "type" "date" }, "date year" { "type" "short" }, "date month" { "type" "byte" }, "date day" { "type" "byte" }, "description" { "type" "text" }, "authors" { "type" "nested", "properties" { "full name" { "type" "keyword" }, "profile url" { "type" "text" }, "order in profile" { "type" "long" } } }, "publication url" { "type" "text" }, "order in profile" { "type" "long" } } }, "awards" { "type" "nested", "properties" { "title" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "issuer" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "description" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "date" { "type" "date" }, "date year" { "type" "short" }, "date month" { "type" "byte" }, "date day" { "type" "byte" }, "order in profile" { "type" "integer" } } }, "courses" { "type" "nested", "properties" { "organizer" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "title" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "order in profile" { "type" "integer" } } }, "certifications" { "type" "nested", "properties" { "title" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "issuer" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "credential id" { "type" "keyword" }, "certificate url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "date from" { "type" "date" }, "date from year" { "type" "short" }, "date from month" { "type" "byte" }, "date to" { "type" "date" }, "date to year" { "type" "short" }, "date to month" { "type" "byte" }, "issuer url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "order in profile" { "type" "integer" } } }, "experience" { "type" "nested", "properties" { "title" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "description" { "type" "text" }, "order in profile" { "type" "integer" }, "company id" { "type" "long" }, "company name" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "date from" { "type" "date" }, "date from year" { "type" "short" }, "date from month" { "type" "byte" }, "date to" { "type" "date" }, "date to year" { "type" "short" }, "date to month" { "type" "byte" }, "duration" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "duration months" { "type" "long" }, "department" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "management level" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "location" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company type" { "type" "keyword" }, "company founded" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company followers count" { "type" "long" }, "company website" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" }, "domain only" { "type" "text" } } }, "company facebook url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company twitter url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company professional network url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company size range" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company size employees count" { "type" "long" }, "company industry" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "company location hq full address" { "type" "text" }, "company location hq country" { "type" "keyword" }, "company location hq regions" { "type" "text" }, "company location hq country iso2" { "type" "text" }, "company location hq country iso3" { "type" "text" }, "company location hq city" { "type" "text" }, "company location hq state" { "type" "text" }, "company location hq street" { "type" "text" }, "company location hq zipcode" { "type" "text" }, "company last updated" { "type" "date" }, "company categories and keywords" { "type" "text" }, "company stock ticker" { "type" "nested", "properties" { "exchange" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "ticker" { "type" "keyword" } } }, "company is b2b" { "type" "byte" }, "company annual revenue" { "type" "long" }, "company annual revenue currency" { "type" "text" }, "company employees count change yearly percentage" { "type" "double" }, "company last funding round announced date" { "type" "date" }, "company last funding round amount raised" { "type" "long" } } }, "education" { "type" "nested", "properties" { "title" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "major" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "institution url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" }, "domain only" { "type" "text" } } }, "description" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "activities and societies" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "date from" { "type" "integer" }, "date to" { "type" "integer" } } }, "languages" { "type" "nested", "properties" { "language" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "proficiency" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "order in profile" { "type" "integer" } } }, "recommendations" { "type" "nested", "properties" { "recommendation" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "referee name" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "referee url" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "order in profile" { "type" "integer" } } }, "recommendations count" { "type" "integer" }, "connections count" { "type" "integer" }, "location raw address" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "location country" { "type" "keyword" }, "location regions" { "type" "keyword" }, "last updated" { "type" "date" }, "is deleted" { "type" "byte" }, "is hidden" { "type" "byte" }, "follower count" { "type" "long" }, "skills" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "shorthand names" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "headline" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "generated headline" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "picture url" { "type" "text" }, "public profile id" { "type" "long" }, "total experience duration" { "type" "text", "fields" { "exact" { "type" "keyword", "null value" "null" } } }, "total experience duration months" { "type" "long" } } } } sorting options you can choose between two sorting options sort by id or score if you omit the sort part entirely, the sorting will be by id by default sorting by score enables you to view search results in order of relevance, with the most relevant items appearing first sorting by id arranges the list of ids in ascending order, starting from the smallest value and progressing to the largest choose the sorting type in the sort section of the endpoint payload endpoint payload { "query" {}, "sort" \[ null ] } sort by score { "query" { "match" { "full name" { "query" "john smith", "operator" "and" } } }, "sort" \[ " score" ] } sort by id { "query" { "match" { "name" { "query" "john smith", "operator" "and" } } }, "sort" \[ "id" ] } limitations we do not own the functions and syntax that this endpoint operates in for all specific elasticsearch dsl information, please refer to their official documentation the endpoint accepts the query object of a standard elasticsearch request no matter the content of the query, the search only returns record ids (like all other search endpoints) queries in this endpoint are limited to 15,000 characters the maximum number of clauses a booleanquery can contain (number of boolean operators within the query) is 1024 more information on elasticsearch dsl do your elasticsearch dsl endpoints support analytics features? no, the analytics features are not supported in our elasticsearch dsl endpoints is it possible to search for a boolean value? yes the elastic search query itself includes a parameter bool that indicates to return results if they meet the criteria is there a way to exclude results? use an elastic search boolean query with a must not clause