Collect
Employee API will be deprecated on August 6th. Until then, you must transfer to a Base Employee API . Read all about the benefits and changes here. Webhooks will stop working on May 9th.
All personal information mentioned within this context is entirely fictional and is solely intended for illustrative purposes.
Find instructions for collection endpoint usage and data collection. Use the collection endpoints to collect employee data using IDs or shorthand names.
Learn how to obtain employee data using IDs.
Learn how to obtain employee data using shorthand names.
Key | Collect endpoint |
|---|---|
Employee ID | /v1/professional_network/employee/collect/{employee_id} |
Shorthand name | /v1/professional_network/employee/collect/{shorthand_name} |
Employee ID
Retrieved using search endpoints.
Employee shorthand name
Taken directly from profile URL (e.g., john-doe from www.professional-network.com/john-doe).
Examples in this article are prepared using Postman.
However, you can use the most convenient tool: terminal, Postman, or any API-compatible application.
See the list of possible error codes.
Remember to replace {JWT} with the personal token that was generated for you.
- Paste in the numeric profile ID instead of {employee_id} and your JWT token instead of {JWT} in the request template:
- Copy the edited request.
- Import the request in Postman by clicking the Import button and pasting the request in:
- Click Authorization:
- Select Bearer token and paste your token in:
- Make sure your token has been imported to Postman:
- Send the request:
- Collect employee data from Body:
Remember to replace {JWT} with the personal token generated for you.
- Paste in the selected shorthand name instead of {shorthand_name} and your JWT token instead of {JWT} in the request template:
- Copy the edited request.
- Import the request in Postman by clicking on the Import button and pasting the request in:
- Go to Authorization:
- Select the Bearer token from the selection menu:
- Make sure your token has been imported to Postman:
- Send the request:
- Collect employee data from Body.