Employee API
...
Endpoints
Bulk Collect
POST Requests
24min
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.
Request employee data using a search filter query.
Request employee data using an Elasticsearch query.
Request employee data by submitting a list of IDs.
See the list of possible error codes.
Use the endpoint /v1/professional_network/employee/bulk_collect/filter to request employee data in bulk using search filters:
Search endpoint filters
1{
2 "name": "string",
3 "title": "string",
4 "location": "string",
5 "industry": "string",
6 "summary": "string",
7 "created_at_gte": "string",
8 "created_at_lte": "string",
9 "last_updated_gte": "string",
10 "last_updated_lte": "string",
11 "deleted": true,
12 "country": "string",
13 "skill": "string",
14 "certification_name": "string",
15 "experience_title": "string",
16 "experience_company_name": "string",
17 "experience_company_exact_name": "string",
18 "experience_company_website_url": "string",
19 "experience_company_website_exact_url": "string",
20 "experience_company_professional_network_url": "string",
21 "experience_company_industry": "string",
22 "experience_company_size": "string",
23 "experience_company_employees_count_gte": 0,
24 "experience_company_employees_count_lte": 0,
25 "experience_date_from": "string",
26 "experience_date_to": "string",
27 "experience_description": "string",
28 "experience_deleted": true,
29 "experience_company_id": 0,
30 "active_experience": true,
31 "keyword": "string",
32 "education_institution_name": "string",
33 "education_institution_exact_name": "string",
34 "education_program_name": "string",
35 "education_description": "string",
36 "education_date_from": "string",
37 "education_date_to": "string",
38 "education_institution_professional_network_url": "string"
39}
- 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
1curl -X 'POST' \
2'https://api.coresignal.com/cdapi/v1/professional_network/employee/bulk_collect/filter' \
3 -H 'accept: application/json' \
4 -H 'Authorization: Bearer {JWT}' \
5 -H 'Content-Type: application/json' \
6 -d '{
7 "data_format": "json",
8 "webhook_url": "{optional_webhook_url}",
9 "limit": {optional_integer},
10 "filters": {}
11 }'
Keep in mind that parameters webhook_url and limit are optional.
Example request
1curl -X 'POST' \
2 'https://api.coresignal.com/cdapi/v1/professional_network/employee/bulk_collect/filter' \
3 -H 'accept: application/json' \
4 -H 'Authorization: Bearer {JWT}' \
5 -H 'Content-Type: application/json' \
6 -d '{
7 "data_format": "json",
8 "webhook_url": "{optional_webhook_url}",
9 "limit": {optional_integer},
10 "filters": {
11 "title": "CSO",
12 "location": "United States",
13 "industry": "Information Technology"
14 }
15 }'
- Insert your Employee API token instead of {JWT}.
- Import the prepared cURL request to any API-compatible application.
- Send the request.
- Retrieve the request ID from the response body:
Request ID
1{
2 "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
3}
Use the request ID in the /v1/bulk_collect/{data_request_id}/files and /v1/bulk_collect/{data_request_id}/files/{file_name} endpoints to retrieve the employee profile data.
See the list of possible error codes.
Use the endpoint /v1/professional_network/employee/bulk_collect/es_dsl to request employee data in bulk using our Elasticsearch DSL schema:
Elasticsearch schema
1"mappings": {
2 "properties": {
3 "id": {
4 "type": "long"
5 },
6 "name": {
7 "type": "text"
8 },
9 "first_name": {
10 "type": "text"
11 },
12 "last_name": {
13 "type": "text",
14 },
15 "title": {
16 "type": "text"
17 },
18 "user_generated_headline": {
19 "type": "text",
20 "fields": {
21 "exact": {
22 "type": "keyword",
23 "null_value": "NULL"
24 }
25 }
26 },
27 "url": {
28 "type": "text",
29 "fields": {
30 "exact": {
31 "type": "keyword",
32 }
33 }
34 },
35 "hash": {
36 "type": "keyword",
37
38 },
39 "location": {
40 "type": "text"
41 },
42 "industry": {
43 "type": "text",
44 "fields": {
45 "exact": {
46 "type": "keyword",
47 "null_value": "NULL"
48 }
49 }
50 },
51 "summary": {
52 "type": "text"
53 },
54 "connections": {
55 "type": "keyword",
56
57 },
58 "recommendations_count": {
59 "type": "long",
60 "null_value": -1
61 },
62 "logo_url": {
63 "type": "keyword",
64
65 },
66 "last_response_code": {
67 "type": "long",
68 "null_value": -1,
69
70 },
71 "created": {
72 "type": "date",
73 "format": "yyyy-MM-dd HH:mm:ss"
74 },
75 "last_updated": {
76 "type": "date",
77 "format": "yyyy-MM-dd HH:mm:ss"
78 },
79 "outdated": {
80 "type": "byte",
81
82 },
83 "deleted": {
84 "type": "byte",
85
86 },
87 "country": {
88 "type": "keyword",
89 "null_value": "NULL"
90 },
91 "connections_count": {
92 "type": "long",
93 "null_value": -1
94 },
95 "experience_count": {
96 "type": "long",
97 "null_value": -1
98 },
99 "member_shorthand_name": {
100 "type": "keyword"
101 },
102 "member_shorthand_name_hash": {
103 "type": "keyword",
104
105 },
106 "canonical_url": {
107 "type": "text",
108 "fields": {
109 "exact": {
110 "type": "keyword"
111 }
112 }
113 },
114 "canonical_hash": {
115 "type": "keyword"
116
117 },
118 "canonical_shorthand_name": {
119 "type": "keyword"
120 },
121 "canonical_shorthand_name_hash": {
122 "type": "keyword"
123
124 },
125 "member_also_viewed_collection": {
126 "type": "nested",
127 "properties": {
128 "id": {
129 "type": "long"
130
131 },
132 "member_id": {
133 "type": "long"
134
135 },
136 "url": {
137 "type": "keyword"
138
139 },
140 "title": {
141 "type": "text"
142
143 },
144 "location": {
145 "type": "text"
146
147 },
148 "created": {
149 "type": "date",
150 "format": "yyyy-MM-dd HH:mm:ss",
151
152 },
153 "last_updated": {
154 "type": "date",
155 "format": "yyyy-MM-dd HH:mm:ss"
156
157 },
158 "deleted": {
159 "type": "byte"
160
161 }
162 }
163 },
164 "member_awards_collection": {
165 "type": "nested",
166 "properties": {
167 "id": {
168 "type": "long"
169
170 },
171 "member_id": {
172 "type": "long"
173
174 },
175 "title": {
176 "type": "text"
177
178 },
179 "issuer": {
180 "type": "text"
181
182 },
183 "description": {
184 "type": "text"
185
186 },
187 "date": {
188 "type": "keyword"
189
190 },
191 "created": {
192 "type": "date",
193 "format": "yyyy-MM-dd HH:mm:ss"
194
195 },
196 "last_updated": {
197 "type": "date",
198 "format": "yyyy-MM-dd HH:mm:ss"
199
200 },
201 "deleted": {
202 "type": "byte"
203
204 }
205 }
206 },
207 "member_certifications_collection": {
208 "type": "nested",
209 "properties": {
210 "id": {
211 "type": "long"
212 },
213 "member_id": {
214 "type": "long"
215
216 },
217 "name": {
218 "type": "text"
219 },
220 "authority": {
221 "type": "text"
222
223 },
224 "url": {
225 "type": "keyword"
226
227 },
228 "date_from": {
229 "type": "date",
230 "format": "MMMM uuuu||uuuu",
231 "null_value": "1000"
232 },
233 "date_to": {
234 "type": "date",
235 "format": "MMMM uuuu||uuuu",
236 "null_value": "1000"
237
238 },
239 "created": {
240 "type": "date",
241 "format": "yyyy-MM-dd HH:mm:ss",
242
243 },
244 "last_updated": {
245 "type": "date",
246 "format": "yyyy-MM-dd HH:mm:ss",
247
248 },
249 "deleted": {
250 "type": "byte"
251
252 }
253 }
254 },
255 "member_courses_collection": {
256 "type": "nested",
257 "properties": {
258 "id": {
259 "type": "long"
260 },
261 "member_id": {
262 "type": "long"
263
264 },
265 "position": {
266 "type": "text"
267 },
268 "courses": {
269 "type": "text"
270 },
271 "created": {
272 "type": "date",
273 "format": "yyyy-MM-dd HH:mm:ss"
274
275 },
276 "last_updated": {
277 "type": "date",
278 "format": "yyyy-MM-dd HH:mm:ss"
279
280 },
281 "deleted": {
282 "type": "byte"
283
284 }
285 }
286 },
287 "member_courses_suggestion_collection": {
288 "type": "nested",
289 "properties": {
290 "id": {
291 "type": "long"
292
293 },
294 "member_id": {
295 "type": "long"
296
297 },
298 "course_suggestion_id": {
299 "type": "long"
300
301 },
302 "created": {
303 "type": "date",
304 "format": "yyyy-MM-dd HH:mm:ss"
305
306 },
307 "last_updated": {
308 "type": "date",
309 "format": "yyyy-MM-dd HH:mm:ss"
310 },
311 "deleted": {
312 "type": "byte"
313
314 },
315 "member_courses_suggestion_list": {
316 "properties": {
317 "id": {
318 "type": "long"
319
320 },
321 "name": {
322 "type": "keyword"
323 },
324 "hash": {
325 "type": "keyword"
326
327 },
328 "url": {
329 "type": "keyword"
330
331 },
332 "created": {
333 "type": "date",
334 "format": "yyyy-MM-dd HH:mm:ss"
335
336 },
337 "last_updated": {
338 "type": "date",
339 "format": "yyyy-MM-dd HH:mm:ss"
340
341 }
342 }
343 }
344 }
345 },
346 "member_education_collection": {
347 "type": "nested",
348 "properties": {
349 "id": {
350 "type": "long"
351 },
352 "member_id": {
353 "type": "long"
354
355 },
356 "title": {
357 "type": "text",
358 "fields": {
359 "raw": {
360 "type": "keyword",
361 "null_value": "NULL"
362 }
363 }
364 },
365 "subtitle": {
366 "type": "text"
367 },
368 "date_from": {
369 "type": "date",
370 "format": "MMMM uuuu||uuuu",
371 "null_value": "1000"
372 },
373 "date_to": {
374 "type": "date",
375 "format": "MMMM uuuu||uuuu",
376 "null_value": "1000"
377 },
378 "activities_and_societies": {
379 "type": "text"
380 },
381 "description": {
382 "type": "text"
383 },
384 "created": {
385 "type": "date",
386 "format": "yyyy-MM-dd HH:mm:ss"
387
388 },
389 "last_updated": {
390 "type": "date",
391 "format": "yyyy-MM-dd HH:mm:ss"
392
393 },
394 "deleted": {
395 "type": "byte"
396
397 },
398 "school_url": {
399 "type": "text",
400 "fields": {
401 "exact": {
402 "type": "keyword"
403 }
404 }
405 }
406 }
407 },
408 "member_experience_collection": {
409 "type": "nested",
410 "properties": {
411 "id": {
412 "type": "long"
413 },
414 "member_id": {
415 "type": "long"
416
417 },
418 "title": {
419 "type": "text"
420 },
421 "location": {
422 "type": "text",
423
424 },
425 "company_name": {
426 "type": "text",
427 "fields": {
428 "raw": {
429 "type": "keyword",
430 "null_value": "NULL"
431 }
432 }
433 },
434 "company_url": {
435 "type": "keyword"
436 },
437 "company_url_shorthand_name": {
438 "type": "keyword"
439 },
440 "company_url_canonical_shorthand_name": {
441 "type": "keyword"
442 },
443 "company_industry": {
444 "type": "text",
445 "fields": {
446 "exact": {
447 "type": "keyword",
448 "null_value": "NULL"
449 }
450 }
451 },
452 "company_website": {
453 "type": "text",
454 "fields": {
455 "exact": {
456 "type": "keyword",
457 "null_value": "NULL"
458 },
459 "domain_only": {
460 "type": "text"
461 }
462 }
463 },
464 "company_employees_count": {
465 "type": "unsigned_long"
466 },
467 "company_size": {
468 "type": "text",
469 "fields": {
470 "exact": {
471 "type": "keyword",
472 "null_value": "NULL"
473 }
474 }
475 },
476 "date_from": {
477 "type": "date",
478 "format": "MMMM uuuu||uuuu",
479 "null_value": "1000"
480 },
481 "date_to": {
482 "type": "date",
483 "format": "MMMM uuuu||uuuu",
484 "null_value": "1000"
485 },
486 "duration": {
487 "type": "text"
488
489 },
490 "description": {
491 "type": "text"
492 },
493 "created": {
494 "type": "date",
495 "format": "yyyy-MM-dd HH:mm:ss"
496 },
497 "last_updated": {
498 "type": "date",
499 "format": "yyyy-MM-dd HH:mm:ss"
500
501 },
502 "deleted": {
503 "type": "byte"
504 },
505 "order_in_profile": {
506 "type": "long"
507 },
508 "company_id": {
509 "type": "long"
510 }
511 }
512 },
513 "member_groups_collection": {
514 "type": "nested",
515 "properties": {
516 "id": {
517 "type": "long"
518
519 },
520 "member_id": {
521 "type": "long"
522
523 },
524 "name": {
525 "type": "keyword"
526
527 },
528 "url": {
529 "type": "keyword"
530
531 },
532 "created": {
533 "type": "date",
534 "format": "yyyy-MM-dd HH:mm:ss"
535
536 },
537 "last_updated": {
538 "type": "date",
539 "format": "yyyy-MM-dd HH:mm:ss"
540
541 },
542 "deleted": {
543 "type": "byte"
544
545 }
546 }
547 },
548 "member_interests_collection": {
549 "type": "nested",
550 "properties": {
551 "id": {
552 "type": "long"
553
554 },
555 "member_id": {
556 "type": "long"
557
558 },
559 "interest_id": {
560 "type": "long"
561
562 },
563 "created": {
564 "type": "date",
565 "format": "yyyy-MM-dd HH:mm:ss"
566
567 },
568 "last_updated": {
569 "type": "date",
570 "format": "yyyy-MM-dd HH:mm:ss"
571
572 },
573 "deleted": {
574 "type": "byte"
575
576 },
577 "member_interest_list": {
578 "properties": {
579 "id": {
580 "type": "long"
581
582 },
583 "interest": {
584 "type": "keyword"
585
586 },
587 "hash": {
588 "type": "keyword"
589
590 },
591 "created": {
592 "type": "date",
593 "format": "yyyy-MM-dd HH:mm:ss"
594
595 },
596 "last_updated": {
597 "type": "date",
598 "format": "yyyy-MM-dd HH:mm:ss"
599
600 }
601 }
602 }
603 }
604 },
605 "member_languages_collection": {
606 "type": "nested",
607 "properties": {
608 "id": {
609 "type": "long"
610
611 },
612 "member_id": {
613 "type": "long"
614
615 },
616 "language_id": {
617 "type": "long"
618
619 },
620 "proficiency_id": {
621 "type": "long"
622
623 },
624 "created": {
625 "type": "date",
626 "format": "yyyy-MM-dd HH:mm:ss"
627
628 },
629 "last_updated": {
630 "type": "date",
631 "format": "yyyy-MM-dd HH:mm:ss"
632
633 },
634 "deleted": {
635 "type": "byte"
636
637 },
638 "member_language_list": {
639 "properties": {
640 "id": {
641 "type": "long"
642
643 },
644 "language": {
645 "type": "keyword"
646
647 },
648 "hash": {
649 "type": "keyword"
650
651 },
652 "created": {
653 "type": "date",
654 "format": "yyyy-MM-dd HH:mm:ss"
655
656 },
657 "last_updated": {
658 "type": "date",
659 "format": "yyyy-MM-dd HH:mm:ss"
660
661 }
662 }
663 },
664 "member_language_proficiency_list": {
665 "properties": {
666 "id": {
667 "type": "long"
668
669 },
670 "proficiency": {
671 "type": "keyword"
672
673 },
674 "hash": {
675 "type": "keyword"
676
677 },
678 "created": {
679 "type": "date",
680 "format": "yyyy-MM-dd HH:mm:ss"
681
682 },
683 "last_updated": {
684 "type": "date",
685 "format": "yyyy-MM-dd HH:mm:ss"
686 }
687 }
688 }
689 }
690 },
691 "member_organizations_collection": {
692 "type": "nested",
693 "properties": {
694 "id": {
695 "type": "long"
696
697 },
698 "member_id": {
699 "type": "long"
700
701 },
702 "organization": {
703 "type": "keyword"
704
705 },
706 "position": {
707 "type": "keyword"
708 },
709 "description": {
710 "type": "text"
711
712 },
713 "date_from": {
714 "type": "keyword"
715
716 },
717 "date_to": {
718 "type": "keyword"
719
720 },
721 "created": {
722 "type": "date",
723 "format": "yyyy-MM-dd HH:mm:ss"
724
725 },
726 "last_updated": {
727 "type": "date",
728 "format": "yyyy-MM-dd HH:mm:ss"
729 },
730 "deleted": {
731 "type": "byte"
732
733 }
734 }
735 },
736 "member_patents_collection": {
737 "type": "nested",
738 "properties": {
739 "id": {
740 "type": "long"
741 },
742 "member_id": {
743 "type": "long"
744 },
745 "title": {
746 "type": "text"
747 },
748 "status_id": {
749 "type": "long"
750 },
751 "inventors": {
752 "type": "text"
753 },
754 "date": {
755 "type": "date",
756 "format": "MMMM uuuu||uuuu",
757 "null_value": "1000"
758 },
759 "url": {
760 "type": "keyword"
761 },
762 "description": {
763 "type": "text"
764 },
765 "valid_area": {
766 "type": "text"
767 },
768 "created": {
769 "type": "date",
770 "format": "yyyy-MM-dd HH:mm:ss"
771 },
772 "last_updated": {
773 "type": "date",
774 "format": "yyyy-MM-dd HH:mm:ss"
775 },
776 "deleted": {
777 "type": "byte"
778 },
779 "member_patent_status_list": {
780 "properties": {
781 "id": {
782 "type": "long"
783 },
784 "status": {
785 "type": "keyword"
786 },
787 "hash": {
788 "type": "keyword"
789 },
790 "created": {
791 "type": "date",
792 "format": "yyyy-MM-dd HH:mm:ss"
793 },
794 "last_updated": {
795 "type": "date",
796 "format": "yyyy-MM-dd HH:mm:ss"
797 }
798 }
799 }
800 }
801 },
802 "member_posts_see_more_urls_collection": {
803 "type": "nested",
804 "properties": {
805 "id": {
806 "type": "long"
807 },
808 "member_id": {
809 "type": "long"
810 },
811 "url": {
812 "type": "keyword"
813 },
814 "created": {
815 "type": "date",
816 "format": "yyyy-MM-dd HH:mm:ss"
817 },
818 "last_updated": {
819 "type": "date",
820 "format": "yyyy-MM-dd HH:mm:ss"
821 },
822 "deleted": {
823 "type": "byte"
824 }
825 }
826 },
827 "member_projects_collection": {
828 "type": "nested",
829 "properties": {
830 "id": {
831 "type": "long"
832 },
833 "member_id": {
834 "type": "long"
835 },
836 "name": {
837 "type": "text"
838 },
839 "url": {
840 "type": "keyword"
841 },
842 "description": {
843 "type": "text"
844 },
845 "date_from": {
846 "type": "date",
847 "format": "MMMM uuuu||uuuu",
848 "null_value": "1000"
849 },
850 "date_to": {
851 "type": "date",
852 "format": "MMMM uuuu||uuuu",
853 "null_value": "1000"
854 },
855 "team_members": {
856 "type": "text"
857 },
858 "created": {
859 "type": "date",
860 "format": "yyyy-MM-dd HH:mm:ss"
861 },
862 "last_updated": {
863 "type": "date",
864 "format": "yyyy-MM-dd HH:mm:ss"
865 },
866 "deleted": {
867 "type": "byte"
868 }
869 }
870 },
871 "member_publications_collection": {
872 "type": "nested",
873 "properties": {
874 "id": {
875 "type": "long"
876 },
877 "member_id": {
878 "type": "long"
879 },
880 "title": {
881 "type": "text"
882 },
883 "publisher": {
884 "type": "keyword"
885 },
886 "date": {
887 "type": "date",
888 "format": "MMMM uuuu||uuuu",
889 "null_value": "1000",
890 },
891 "description": {
892 "type": "text"
893 },
894 "authors": {
895 "type": "text"
896 },
897 "url": {
898 "type": "keyword"
899 },
900 "created": {
901 "type": "date",
902 "format": "yyyy-MM-dd HH:mm:ss"
903 },
904 "last_updated": {
905 "type": "date",
906 "format": "yyyy-MM-dd HH:mm:ss"
907 },
908 "deleted": {
909 "type": "byte"
910 }
911 }
912 },
913 "member_recommendations_collection": {
914 "type": "nested",
915 "properties": {
916 "id": {
917 "type": "long"
918 },
919 "member_id": {
920 "type": "long"
921 },
922 "recommendation": {
923 "type": "text"
924 },
925 "created": {
926 "type": "date",
927 "format": "yyyy-MM-dd HH:mm:ss"
928 },
929 "last_updated": {
930 "type": "date",
931 "format": "yyyy-MM-dd HH:mm:ss"
932 },
933 "deleted": {
934 "type": "byte"
935 }
936 }
937 },
938 "member_similar_profiles_collection": {
939 "type": "nested",
940 "properties": {
941 "id": {
942 "type": "long"
943 },
944 "member_id": {
945 "type": "long"
946 },
947 "url": {
948 "type": "keyword"
949 },
950 "created": {
951 "type": "date",
952 "format": "yyyy-MM-dd HH:mm:ss"
953 },
954 "last_updated": {
955 "type": "date",
956 "format": "yyyy-MM-dd HH:mm:ss"
957 },
958 "deleted": {
959 "type": "byte"
960 }
961 }
962 },
963 "member_skills_collection": {
964 "type": "nested",
965 "properties": {
966 "id": {
967 "type": "long"
968 },
969 "member_id": {
970 "type": "long"
971 },
972 "skill_id": {
973 "type": "long"
974 },
975 "created": {
976 "type": "date",
977 "format": "yyyy-MM-dd HH:mm:ss"
978 },
979 "last_updated": {
980 "type": "date",
981 "format": "yyyy-MM-dd HH:mm:ss"
982 },
983 "deleted": {
984 "type": "byte"
985 },
986 "member_skill_list": {
987 "properties": {
988 "id": {
989 "type": "long"
990 },
991 "skill": {
992 "type": "text"
993 },
994 "hash": {
995 "type": "keyword"
996 },
997 "created": {
998 "type": "date",
999 "format": "yyyy-MM-dd HH:mm:ss"
1000 },
1001 "last_updated": {
1002 "type": "date",
1003 "format": "yyyy-MM-dd HH:mm:ss"
1004 }
1005 }
1006 }
1007 }
1008 },
1009 "member_test_scores_collection": {
1010 "type": "nested",
1011 "properties": {
1012 "id": {
1013 "type": "long"
1014 },
1015 "member_id": {
1016 "type": "long"
1017 },
1018 "name": {
1019 "type": "text"
1020 },
1021 "date": {
1022 "type": "keyword"
1023 },
1024 "description": {
1025 "type": "text"
1026 },
1027 "score": {
1028 "type": "keyword"
1029 },
1030 "created": {
1031 "type": "date",
1032 "format": "yyyy-MM-dd HH:mm:ss"
1033 },
1034 "last_updated": {
1035 "type": "date",
1036 "format": "yyyy-MM-dd HH:mm:ss"
1037 },
1038 "deleted": {
1039 "type": "byte"
1040 }
1041 }
1042 },
1043 "member_volunteering_cares_collection": {
1044 "type": "nested",
1045 "properties": {
1046 "id": {
1047 "type": "long"
1048 },
1049 "member_id": {
1050 "type": "long"
1051 },
1052 "care_id": {
1053 "type": "long"
1054 },
1055 "created": {
1056 "type": "date",
1057 "format": "yyyy-MM-dd HH:mm:ss"
1058 },
1059 "last_updated": {
1060 "type": "date",
1061 "format": "yyyy-MM-dd HH:mm:ss"
1062 },
1063 "deleted": {
1064 "type": "byte"
1065 },
1066 "member_volunteering_care_list": {
1067 "properties": {
1068 "id": {
1069 "type": "long"
1070 },
1071 "care": {
1072 "type": "keyword"
1073 },
1074 "hash": {
1075 "type": "keyword"
1076 },
1077 "created": {
1078 "type": "date",
1079 "format": "yyyy-MM-dd HH:mm:ss"
1080 },
1081 "last_updated": {
1082 "type": "date",
1083 "format": "yyyy-MM-dd HH:mm:ss"
1084 }
1085 }
1086 }
1087 }
1088 },
1089 "member_volunteering_opportunities_collection": {
1090 "type": "nested",
1091 "properties": {
1092 "id": {
1093 "type": "long"
1094 },
1095 "member_id": {
1096 "type": "long"
1097 },
1098 "opportunity_id": {
1099 "type": "long"
1100 },
1101 "created": {
1102 "type": "date",
1103 "format": "yyyy-MM-dd HH:mm:ss"
1104 },
1105 "last_updated": {
1106 "type": "date",
1107 "format": "yyyy-MM-dd HH:mm:ss"
1108 },
1109 "deleted": {
1110 "type": "byte"
1111 },
1112 "member_volunteering_opportunity_list": {
1113 "properties": {
1114 "id": {
1115 "type": "long"
1116 },
1117 "opportunity": {
1118 "type": "keyword"
1119 },
1120 "hash": {
1121 "type": "keyword"
1122 },
1123 "created": {
1124 "type": "date",
1125 "format": "yyyy-MM-dd HH:mm:ss"
1126 },
1127 "last_updated": {
1128 "type": "date",
1129 "format": "yyyy-MM-dd HH:mm:ss"
1130 }
1131 }
1132 }
1133 }
1134 },
1135 "member_volunteering_positions_collection": {
1136 "type": "nested",
1137 "properties": {
1138 "id": {
1139 "type": "long"
1140 },
1141 "member_id": {
1142 "type": "long"
1143 },
1144 "organization": {
1145 "type": "text"
1146 },
1147 "role": {
1148 "type": "keyword"
1149 },
1150 "cause_id": {
1151 "type": "long"
1152 },
1153 "date_from": {
1154 "type": "keyword"
1155 },
1156 "date_to": {
1157 "type": "keyword"
1158 },
1159 "duration": {
1160 "type": "keyword"
1161 },
1162 "created": {
1163 "type": "date",
1164 "format": "yyyy-MM-dd HH:mm:ss"
1165 },
1166 "last_updated": {
1167 "type": "date",
1168 "format": "yyyy-MM-dd HH:mm:ss"
1169 },
1170 "deleted": {
1171 "type": "byte"
1172 },
1173 "description": {
1174 "type": "text"
1175 },
1176 "organization_url": {
1177 "type": "keyword"
1178 },
1179 "member_volunteering_positions_cause_list": {
1180 "properties": {
1181 "id": {
1182 "type": "long"
1183 },
1184 "cause": {
1185 "type": "keyword"
1186 },
1187 "hash": {
1188 "type": "keyword"
1189 },
1190 "created": {
1191 "type": "date",
1192 "format": "yyyy-MM-dd HH:mm:ss"
1193 },
1194 "last_updated": {
1195 "type": "date",
1196 "format": "yyyy-MM-dd HH:mm:ss"
1197 }
1198 }
1199 }
1200 }
1201 },
1202 "member_volunteering_supports_collection": {
1203 "type": "nested",
1204 "properties": {
1205 "id": {
1206 "type": "long"
1207 },
1208 "member_id": {
1209 "type": "long"
1210 },
1211 "support_id": {
1212 "type": "long"
1213 },
1214 "created": {
1215 "type": "date",
1216 "format": "yyyy-MM-dd HH:mm:ss"
1217 },
1218 "last_updated": {
1219 "type": "date",
1220 "format": "yyyy-MM-dd HH:mm:ss"
1221 },
1222 "deleted": {
1223 "type": "byte"
1224 },
1225 "member_volunteering_support_list": {
1226 "properties": {
1227 "id": {
1228 "type": "long"
1229 },
1230 "support": {
1231 "type": "keyword"
1232 },
1233 "hash": {
1234 "type": "keyword"
1235 },
1236 "created": {
1237 "type": "date",
1238 "format": "yyyy-MM-dd HH:mm:ss"
1239 },
1240 "last_updated": {
1241 "type": "date",
1242 "format": "yyyy-MM-dd HH:mm:ss"
1243 }
1244 }
1245 }
1246 }
1247 },
1248 "member_websites_collection": {
1249 "type": "nested",
1250 "properties": {
1251 "id": {
1252 "type": "long"
1253 },
1254 "member_id": {
1255 "type": "long"
1256 },
1257 "website": {
1258 "type": "keyword"
1259 },
1260 "created": {
1261 "type": "date",
1262 "format": "yyyy-MM-dd HH:mm:ss"
1263 },
1264 "last_updated": {
1265 "type": "date",
1266 "format": "yyyy-MM-dd HH:mm:ss"
1267 },
1268 "deleted": {
1269 "type": "byte"
1270 }
1271 }
1272 },
1273 "member_hidden_status_collection": {
1274 "type": "nested",
1275 "properties": {
1276 "id": {
1277 "type": "long"
1278 },
1279 "member_id": {
1280 "type": "long"
1281 },
1282 "is_hidden": {
1283 "type": "byte"
1284 },
1285 "created": {
1286 "type": "date",
1287 "format": "yyyy-MM-dd HH:mm:ss"
1288 },
1289 "last_updated": {
1290 "type": "date",
1291 "format": "yyyy-MM-dd HH:mm:ss"
1292 },
1293 "deleted": {
1294 "type": "byte"
1295 }
1296 }
1297 }
1298 }
1299}
- 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
1curl -X 'POST' \
2'https://api.coresignal.com/cdapi/v1/professional_network/employee/bulk_collect/es_dsl' \
3 -H 'accept: application/json' \
4 -H 'Authorization: Bearer {JWT}' \
5 -H 'Content-Type: application/json' \
6 -d '{
7 "data_format": "json",
8 "webhook_url": "{optional_webhook_url}",
9 "limit": {optional_integer},
10 "es_dsl_query": {}
11 }'
Keep in mind that parameters webhook_url and limit are optional.
All company information mentioned within this context is entirely fictional and is solely intended for illustrative purposes.
Example request
1curl -X 'POST' \
2'https://api.coresignal.com/cdapi/v1/professional_network/employee/bulk_collect/es_dsl' \
3 -H 'accept: application/json' \
4 -H 'Authorization: Bearer {JWT}' \
5 -H 'Content-Type: application/json' \
6 -d '{
7 "data_format": "json",
8 "webhook_url": "{optional_webhook_url}",
9 "limit": {optional_integer},
10 "es_dsl_query": {
11 "query":{
12 "bool":{
13 "must":[
14 {
15 "match":{
16 "title":{
17 "query":"Developer",
18 "operator":"and"
19 }
20 }
21 },
22 {
23 "match":{
24 "location":{
25 "query":"United States",
26 "operator":"and"
27 }
28 }
29 },
30 {
31 "nested":{
32 "path":"member_experience_collection",
33 "query":{
34 "bool":{
35 "must":[
36 {
37 "query_string":{
38 "query":"Example Company",
39 "default_field":"member_experience_collection.company_name",
40 "default_operator":"and"
41 }
42 }
43 ]
44 }
45 }
46 }
47 }
48 ]
49 }
50 }
51}
52}'
- Insert your Employee API token instead of {JWT}.
- Import the cURL to any API-compatible application.
- Send the request.
- Retrieve the request ID from the response body:
Request ID
1{
2 "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
3}
Use the request ID in the /v1/bulk_collect/{data_request_id}/files and /v1/bulk_collect/{data_request_id}/files/{file_name} endpoints to retrieve the employee profile data.
See the list of possible error codes.
Use the endpoint /v1/professional_network/employee/bulk_collect/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:
- 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.
- Paste in your JWT token instead of {JWT} and, optionally, webhook URL in the cURL request template:
cURL request
1curl -X 'POST' \
2 'https://api.coresignal.com/cdapi/v1/professional_network/employee/bulk_collect/id_file' \
3 -H 'accept: application/json' \
4 -H 'Authorization: Bearer {JWT}' \
5 -H 'Content-Type: multipart/form-data' \
6 -F 'ids_file=@id_list_example.csv;type=text/csv' \
7 -F 'data_format=json' \
8 -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
1{
2 "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
3}
Use the request ID in the /v1/bulk_collect/{data_request_id}/files and /v1/bulk_collect/{data_request_id}/files/{file_name} endpoints.
- Make a GET request using v1/bulk_collect/{data_request_id}/files. Retrieve the data file name.
- Use /v1/bulk_collect/{data_request_id}/files/{file_name} endpoint to download the JSON data using the request ID and file name.
Detailed information on how to retrieve the file name.
In-depth instructions on how to download the data file.
Updated 28 Nov 2024
Did this page help you?