Base Employee API

new feature base employee api replaces employee api impacted api and entity employee api and base employee api important dates april 9th – base employee api released start of migration period may 9th (30 days after release) – subscriptions (webhooks) will no longer be accepted for employee api entity august 6th (4 months after release) – employee api endpoints will be fully deprecated; clients will have to be fully migrated to base employee api onwards the transition period is 4 months , during which employee api and base employee api will be available after august 6th , employee api will no longer be supported, and base employee api will intercept furthermore, you will not be able to create new subscriptions using employee api after 30 days from base employee api release date this means that after may 9th, the following employee api webhooks will no longer be supported /v1/subscriptions/professional network/member/id file /v1/subscriptions/ professional network /member/filter /v1/subscriptions/ professional network /member/es dsl api changes regarding this change, you will have to switch from employee api to renewed base employee api the following points remark what is changing new elasticsearch schema and data structure with changed/removed/renamed fields search filter endpoint filter naming changes endpoint changes new id mapping endpoint to resolve id changes between two structures changed bulk collect and subscriptions behaviour key improvements several key improvements regarding this change new data fields follower count, checked at, services new collections historical employee identifier values (historical ids, shorthand names), activity fewer employee duplicates the new api introduces a systematic approach to how clients can handle duplicates using our historical data enhanced qa improved quality assurance for more reliable data streamlined data removed unnecessary fields and renewed updating logic for all collections webhook subscriptions update new webhooks will be sent daily elasticsearch schema changes elasticsearch schema changes include new structure with removed, added, or renamed fields this is important for /v1/ professional network /employee base/search/es dsl endpoint users to compare the improvements, please refer to the imported table below https //archbee doc uploads s3 amazonaws com/aohzqyiaodrifcp3u9eju rru5sknedvjgffg0mkykj 20250416 140139 xlsx the important part to mark is that this table includes "index" columns this notes that a specific field is searchable if there is an index (y) if there is no index (n) in the base employee api, it will not be searchable, whereas in employee api, every field is searchable, even with no index base employee api elasticsearch schema is available here https //archbee doc uploads s3 amazonaws com/aohzqyiaodrifcp3u9eju 9opbgnbe2egnx bxaj91f 20250403 071043 json for comparison, find employee api elasticsearch schema below https //archbee doc uploads s3 amazonaws com/aohzqyiaodrifcp3u9eju pd4m3z9u9wh06wfgjistl 20250408 064207 json search filter changes several search filter aspects are also pointed out all filters are the same, but some of them have different names this is important for /v1/ professional network /employee base/search/filter endpoint users study the following table for comparison https //archbee doc uploads s3 amazonaws com/aohzqyiaodrifcp3u9eju pmg4ibehxlsouvbhkm7we 20250416 135648 xlsx endpoints' changes the table below compares both apis' endpoints request type employee api base employee api post /v1/ professional network /member/search/filter /v1/ professional network /employee base/search/filter post /v1/ professional network /member/search/es dsl /v1/ professional network /employee base/search/es dsl post – /v1/ professional network /employee base/map/ids get /v1/ professional network /member/collect/{member id} /v1/ professional network /employee base/collect/{employee id} get /v1/ professional network /member/collect/{shorthand name} /v1/ professional network /employee base/collect/{shorthand name} mapping endpoint since the ids of employee api will not be the same as base employee api, we've prepared a mapping endpoint for mapping purposes this means that the valid, non duplicate data you already have can be used in the base employee api the mapping endpoint is listed below /v1/ professional network /employee base/map/ids information on how to use the endpoint is available in the mapping endpoint docid\ r24mw4b7sfs858qid0hpo topic dictionary changes dictionary, or data output, also has some alterations the table below marks all changes – new data points, renamed, or deleted fields https //archbee doc uploads s3 amazonaws com/aohzqyiaodrifcp3u9eju mnpeilqziet aqhsycwts 20250402 140936 xlsx bulk collect and webhook subscription changes in base employee api, id file will no longer be supported instead, ids will have to be passed as a list note search filter / es dsl query matching up to 10,000 ids when creating a bulk collect data request or a new subscription based on es dsl query to the new base employee endpoints, we strongly advise including the following clause in your query "term" { "is parent" 1 } this ensures that you are getting the most out of our new systematic approach to exclude duplicate records, which we’re able to resolve to the same profile bulk collect endpoints' changes the table below compares both apis' bulk collect endpoints request type employee api base employee api post /v1/ professional network /member/bulk collect/id file ❗ /v1/ professional network /employee base/bulk collect/ids post /v1/ professional network /member/bulk collect/es dsl /v1/ professional network /employee base/bulk collect/es dsl post /v1/ professional network /member/bulk collect/filter /v1/ professional network /employee base/bulk collect/filter bulk collect exceptions currently, several data point collections will not be included in the results this is relevant only for bulk collect requests see the categories and data points below action category data point excluded data dictionary base employee api docid 9rmqssm16xnbsvs wjbqu authors excluded data dictionary base employee api docid 9rmqssm16xnbsvs wjbqu inventors excluded data dictionary base employee api docid 9rmqssm16xnbsvs wjbqu team members webhook subscriptions endpoints' changes the table below compares both apis' webhook endpoints request type employee api base employee api post /v1/subscriptions/ professional network /member/id file ❗ /v1/subscriptions/ professional network /employee base/ids post /v1/subscriptions/ professional network /member/es dsl /v1/subscriptions/ professional network /employee base/es dsl post /v1/subscriptions/ professional network /member/filter /v1/subscriptions/ professional network /employee base/filter