Employee API
Endpoints
Webhooks
POST Requests

28min
Overview
Subscribe to employee profile changes by:
Submitting a list of employee IDs
Querying employee profiles using search filters
Querying employee profiles using the ES DSL schema.
Choose the subscription method that fits you best
﻿Subscriptions using Elasticsearch DSL schema﻿
Use Elasticsearch schema to specify the changes you want to be notified about.
﻿Subscriptions using search filters﻿
Use search filters to specify the changes you want to be notified about.
﻿Subscriptions using IDs﻿
Submit profile IDs to be notified of changes in that specific range. 
POST requests using Elasticsearch schema
﻿Response codes﻿
See the list of possible error codes. 
Use endpoint /v1/subscriptions/professional_network/employee/es_dsl to specify a range of profiles from which you want to see the updates.
The following filters are not available in webhook ES DSL requests:
created
last_updated
date_from from member_education and member_experience collections
and date_to from member_education and member_experience collections
Elasticsearch schema
"mappings": {
    "properties": {
        "id": {
            "type": "long"
        },
        "name": {
            "type": "text"
        },
        "title": {
            "type": "text"
        },
        "url": {
            "type": "text",
            "fields": {
                "exact": {
                    "type": "keyword"
                }
            }
        },
        "location": {
            "type": "text"
        },
        "industry": {
            "type": "text",
            "fields": {
                "exact": {
                    "type": "keyword",
                    "null_value": "NULL"
                }
            }
        },
        "summary": {
            "type": "text"
        },
        "recommendations_count": {
            "type": "long",
            "null_value": -1
        },
    },
    "country": {
        "type": "keyword",
        "null_value": "NULL"
    },
    "connections_count": {
        "type": "long",
        "null_value": -1
    },
    "experience_count": {
        "type": "long",
        "null_value": -1
    },
    "shorthand_name": {
        "type": "keyword"
    },
    "canonical_url": {
        "type": "text",
        "fields": {
            "exact": {
                "type": "keyword"
            }
        }
    },
    "canonical_shorthand_name": {
        "type": "keyword"
    },
    "member_certifications_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "name": {
                "type": "text"
            }
        }
    },
    "member_courses_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "courses": {
                "type": "text"
            }
        }
    },
    "member_education_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "title": {
                "type": "text",
                "fields": {
                    "raw": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "subtitle": {
                "type": "text"
            },
            "description": {
                "type": "text"
            },
            "school_url": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "activities_and_societies": {
                "type": "text"
            }
        }
    },
    "member_experience_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "title": {
                "type": "text"
            },
            "company_name": {
                "type": "text",
                "fields": {
                    "raw": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "company_industry": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "company_url_canonical_shorthand_name": {
                "type": "keyword"
            },
            "company_url_shorthand_name": {
                "type": "keyword"
            },
            "company_website": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword",
                        "null_value": "NULL",
                    }
                }
            },
            "company_employees_count": {
                "type": "unsigned_long"
            },
            "company_size": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "description": {
                "type": "text"
            },
            "created": {
                "type": "date",
                "format": "yyyy-MM-dd HH:mm:ss"
            },
            "deleted": {
                "type": "byte"
            },
            "company_id": {
                "type": "long"
            }
        }
    },
    "member_skills_collection": {
        "type": "nested",
        "properties": {
            "member_skill_list": {
                "properties": {
                    "id": {
                        "type": "long"
                    },
                    "skill": {
                        "type": "text"
                    }
                }
            }
        }
    },
    "deleted": {
        "type": "byte"
    }
}
"mappings": {
    "properties": {
        "id": {
            "type": "long"
        },
        "name": {
            "type": "text"
        },
        "title": {
            "type": "text"
        },
        "url": {
            "type": "text",
            "fields": {
                "exact": {
                    "type": "keyword"
                }
            }
        },
        "location": {
            "type": "text"
        },
        "industry": {
            "type": "text",
            "fields": {
                "exact": {
                    "type": "keyword",
                    "null_value": "NULL"
                }
            }
        },
        "summary": {
            "type": "text"
        },
        "recommendations_count": {
            "type": "long",
            "null_value": -1
        },
    },
    "country": {
        "type": "keyword",
        "null_value": "NULL"
    },
    "connections_count": {
        "type": "long",
        "null_value": -1
    },
    "experience_count": {
        "type": "long",
        "null_value": -1
    },
    "shorthand_name": {
        "type": "keyword"
    },
    "canonical_url": {
        "type": "text",
        "fields": {
            "exact": {
                "type": "keyword"
            }
        }
    },
    "canonical_shorthand_name": {
        "type": "keyword"
    },
    "member_certifications_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "name": {
                "type": "text"
            }
        }
    },
    "member_courses_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "courses": {
                "type": "text"
            }
        }
    },
    "member_education_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "title": {
                "type": "text",
                "fields": {
                    "raw": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "subtitle": {
                "type": "text"
            },
            "description": {
                "type": "text"
            },
            "school_url": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword"
                    }
                }
            },
            "activities_and_societies": {
                "type": "text"
            }
        }
    },
    "member_experience_collection": {
        "type": "nested",
        "properties": {
            "id": {
                "type": "long"
            },
            "title": {
                "type": "text"
            },
            "company_name": {
                "type": "text",
                "fields": {
                    "raw": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "company_industry": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "company_url_canonical_shorthand_name": {
                "type": "keyword"
            },
            "company_url_shorthand_name": {
                "type": "keyword"
            },
            "company_website": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword",
                        "null_value": "NULL",
                    }
                }
            },
            "company_employees_count": {
                "type": "unsigned_long"
            },
            "company_size": {
                "type": "text",
                "fields": {
                    "exact": {
                        "type": "keyword",
                        "null_value": "NULL"
                    }
                }
            },
            "description": {
                "type": "text"
            },
            "created": {
                "type": "date",
                "format": "yyyy-MM-dd HH:mm:ss"
            },
            "deleted": {
                "type": "byte"
            },
            "company_id": {
                "type": "long"
            }
        }
    },
    "member_skills_collection": {
        "type": "nested",
        "properties": {
            "member_skill_list": {
                "properties": {
                    "id": {
                        "type": "long"
                    },
                    "skill": {
                        "type": "text"
                    }
                }
            }
        }
    },
    "deleted": {
        "type": "byte"
    }
}
﻿
You can find more information on the Employee API Elasticschema and its usage in the Elasticsearch DSL﻿ article. 
Endpoint usage 
Prepare your request using the following request by adding select filters and your webhook URL to the template:
Request body template
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
   "webhook_url": "{your_webhook_url}",
   "es_dsl_query": {}
}'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
   "webhook_url": "{your_webhook_url}",
   "es_dsl_query": {}
}'
﻿
All personal 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/v1/subscriptions/professional_network/employee/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
   "webhook_url": "{your_webhook_url}",
   "es_dsl_query": {
      "query": {
         "match": {
            "name": {
               "query": "John Doe",
               "operator": "and"
            }
         }
      }
   }
}'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
   "webhook_url": "{your_webhook_url}",
   "es_dsl_query": {
      "query": {
         "match": {
            "name": {
               "query": "John Doe",
               "operator": "and"
            }
         }
      }
   }
}'
﻿
Insert your Employee API token instead of {JWT}.
Insert your Elasticsearch query in the"es_dsl_query": {} section.
Import the cURL to any API-compatible application.
Send the request.
You will start getting updates on select profiles after two days. 
You will see a subscription ID as an output for your POST request. 

However, you can ignore this ID since the necessary data will be provided in the webhook updates. You can retrieve employee data using the IDs visible in the webhook text.
POST requests using search filters
﻿Response codes﻿
See the list of possible error codes. 
Use endpoint /v1/subscriptions/professional_network/employee/filter to specify a range of profiles you want to see the updates from:
The following filters are not available in webhook search filter requests:
Note that the following filters are not available in search filter requests:
created_at_gte and created_at_lte
last_updated_gte and last_updated_at_lte
experience_date_from and experience_date_to
education_date_from and education_date_to
Search endpoint filters
{
  "name": "string",
  "title": "string",
  "location": "string",
  "industry": "string",
  "summary": "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_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_institution_professional_network_url": "string"
}
{
  "name": "string",
  "title": "string",
  "location": "string",
  "industry": "string",
  "summary": "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_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_institution_professional_network_url": "string"
}
﻿
You can find more information on the Employee API filters in the Search Filters﻿ article.
Endpoint usage 
Prepare your request using the following request by adding select filters and your webhook URL to the template:
Request body template
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "filters": {}
}'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "filters": {}
}'
﻿
Example request
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "filters": {"experience_title": "Product Owner"}
}'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
  "webhook_url": "{your_webhook_url}",
  "filters": {"experience_title": "Product Owner"}
}'
﻿
Insert your Employee API token instead of {JWT}.
Add the selected filters in the "filters": {} section.
Import the prepared cURL request to any API-compatible application.
Send the request.
You will start getting updates on select profiles after two days. 
You will see a subscription ID as an output for your POST request. 

However, you can ignore this ID since the necessary data will be provided in the webhook updates. You can retrieve employee data using the employee IDs visible in the webhook text.
﻿
POST requests using IDs 
﻿Response codes﻿
See the list of possible error codes. 
Use the endpoint /v1/subscriptions/professional_network/employee/id_file to submit a list of IDs in a CSV or Txt file to subscribe to changes in a range of profiles.

Check the example for the ID list formatting:
id_list_example.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. 
Paste in your JWT token instead of {JWT} and your webhook URL in the cURL request template:
cURL request
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/id_file' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'upload_file=@id_list_example.csv;type=text/csv' \
  -F 'webhook_url={your_webhook_url}'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/subscriptions/professional_network/employee/id_file' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'upload_file=@id_list_example.csv;type=text/csv' \
  -F 'webhook_url={your_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.
You will start getting updates on select profiles after two days. 
You will see a subscription ID as an output for your POST request. 

However, you can ignore this ID since the necessary data will be provided in the webhook updates. You can retrieve employee data using the employee IDs visible in the webhook text.
﻿
Following steps
Keep in mind that to view specific changes to an employee profile, you will need to access the profile data using either the Employee API collection endpoints or the Bulk Collect Employee endpoints. 
Single profile update
You have received a webhook notification about an update in one employee profile:
Webhook 
{
  "employee_id": 123,
  "status": "added"
}
{
  "employee_id": 123,
  "status": "added"
}
﻿
To see the exact changes in the profile, you will have to use the profile ID in the following endpoint:
Function
Endpoint
GET
/v1/professional_network/employee/collect/{employee_id}
﻿Collection endpoints﻿
﻿
Multiple profile updates
You have received a webhook notification about updates in several employee profiles:
Webhook 
{
  "employee_id": 123,
  "status": "added"
},
{
  "employee_id": 124,
  "status": "removed"
},
{
  "employee_id": 125,
  "status": "changed"
}
{
  "employee_id": 123,
  "status": "added"
},
{
  "employee_id": 124,
  "status": "removed"
},
{
  "employee_id": 125,
  "status": "changed"
}
﻿
To identify the changes in these profiles, you need to export the IDs in a CSV or TXT file and use them with the following Bulk Collect endpoints:
Function
Endpoint
POST
/v1/professional_network/employee/bulk_collect/id_file
GET
/v1/bulk_collect/{data_request_id}/files
GET
/v1/bulk_collect/{data_request_id}/files/{file_name}
Follow the instructions here to successfully collect the employee data (from left to right): 
﻿GET the file name﻿
﻿GET the file﻿
﻿
Function	Endpoint
GET	/v1/professional_network/employee/collect/{employee_id}
Function	Endpoint
POST	/v1/professional_network/employee/bulk_collect/id_file
GET	/v1/bulk_collect/{data_request_id}/files
GET	/v1/bulk_collect/{data_request_id}/files/{file_name}
Updated 21 Aug 2024
Did this page help you?
Subscription Management
Collect
POST Requests

Overview

Choose the subscription method that fits you best

Subscriptions using Elasticsearch DSL schema

Subscriptions using search filters

Subscriptions using IDs

POST requests using Elasticsearch schema

Response codes

Elasticsearch schema

Endpoint usage

Request example

POST requests using search filters

Response codes

Search endpoint filters

Endpoint usage

Request example

POST requests using IDs

Response codes

Endpoint usage

Following steps

Single profile update

Collection endpoints

Multiple profile updates

GET the file name

GET the file

POST Requests

Overview

Choose the subscription method that fits you best

﻿Subscriptions using Elasticsearch DSL schema﻿

﻿Subscriptions using search filters﻿

﻿Subscriptions using IDs﻿

POST requests using Elasticsearch schema

﻿Response codes﻿

Elasticsearch schema

Endpoint usage

Request example

POST requests using search filters

﻿Response codes﻿

Search endpoint filters

Endpoint usage

Request example

POST requests using IDs

﻿Response codes﻿

Endpoint usage

Following steps

Single profile update

﻿Collection endpoints﻿

Multiple profile updates

﻿GET the file name﻿

﻿GET the file﻿

Subscriptions using Elasticsearch DSL schema

Subscriptions using search filters

Subscriptions using IDs

Response codes

Response codes

Response codes

Collection endpoints

GET the file name

GET the file
