In Unipile v1, all LinkedIn-specific routes, whether related to Classic, Recruiter, or Sales navigator products, were grouped under the URL prefix linkedin. Now, each product (excluding Classic) has its own prefix to improve API organization.

For example, the search functionality previously had a single endpoint, linkedin/search. With the new endpoints structure, the endpoint linkedin/search is reserved for Classic, linkedin/recruiter/search for Recruiter, and linkedin/sales_navigator/search for Sales Navigator.

---

Methods changes

For each endpoint in the v1 API, here are the corresponding endpoints in the v2 API, along with the necessary modifications to achieve the same results.

❗️

Specifying the target account

The account_id param, previously available either in the query params or in the body, is removed from all methods. The account_id must now be consistently included in the path params.

Retrieve Recruiter hiring projects

GET /v1/linkedin/projects

• Use GET /v2/:account_id/linkedin/recruiter/projects List Projects.
• Query param sort_by have changed.
  • The param's enum values more closely reflect LinkedIn's application.
• Query param sort_order is removed as it is now integrated in sort_by.
• Query param cursor is removed. User offset instead.
• The response schema has changed (see RecruiterHiringProjectList changes).

Retrieve Recruiter hiring project from ID

GET /v1/linkedin/projects/:id

• Use GET /v2/:account_id/linkedin/recruiter/projects/:project_id Get a Project.
• Path param id is renamed to project_id.
• The response schema has changed (see RecruiterHiringProject changes).

Perform an action with a user profile

POST /v1/linkedin/user/:user_id

This endpoint is removed.

👍

Recommendation

Here's how the actions allowed by this endpoint should now be performed :

• Add candidate or applicant to pipeline (Recruiter) : Use POST /v2/:account_id/linkedin/recruiter/projects/:project_id/pipeline/candidate/save Save a Candidate.
• Save lead (Sales Navigator) : Use POST /v2/:account_id/linkedin/sales-navigator/lead-lists/:list_id/save Save a Lead To a List.

Retrieve a company profile

GET /v1/linkedin/company/:identifier

• Use GET /v2/:account_id/linkedin/company/:company_id Get a Company Profile.
• Path param identifier is renamed to company_id.
• The response schema has changed (see CompanyProfile changes).

Get raw data from any endpoint

POST /v1/linkedin

• Use POST /v2/:account_id/linkedin Perform a Request to any LinkedIn API Endpoint.
• Body param request_url is renamed to url.
• Body param force_api is removed.
  • You need to ensure that the account you are using is subscribed to the API you are requesting.
• Body param encoding is renamed to bypass_url_encoding.
  • It no longer specifies that the body and query should be natively encoded, but rather that encoding should by bypassed.

Get inmail credit balance

GET /v1/linkedin/inmail_balance

• Use GET /v2/:account_id/linkedin/inmail-credits Get InMail Credits.
• The response schema has changed (see InmailCredits changes).

Retrieve LinkedIn search parameters

GET /v1/linkedin/search/parameters

• Use one of these 3 variations of the endpoint depending on the product :

  • Classic : GET /v2/:account_id/linkedin/search/parameters List Search Parameters.
  • Recruiter : GET /v2/:account_id/linkedin/recruiter/search/parameters List Search Parameters.
  • Sales Navigator : GET /v2/:account_id/linkedin/sales-navigator/search/parameters List Search Parameters.

• Query param service is removed as it is no longer relevant.

• Query param type has changed. Refer to the mappings in the following table :

Perform Linkedin search

POST /v1/linkedin/search

• Multiple search endpoints are now available, depending on the product and the resource being requested.
• Query param cursor is removed. Use offset instead.
• Body params api and category are removed as they are no longer relevant.

Classic

• Search From URL: Use POST /v2/:account_id/linkedin/search Perform Search from URL.

• People search : Use POST /v2/:account_id/linkedin/search/people Perform People Search.

  • Body param company is renamed to current_company.
  • Body param open_to is removed.
    • Use open_to_volunteering instead.

• Companies search : Use POST /v2/:account_id/linkedin/search/companies Perform Companies Search.

  • Body param has_job_offers is renamed to has_job_postings.
  • Body param network_distance is removed as it is not suitable for the intended filter.
    • Use is_employing_relations to filter companies that employ people from your close network.

• Posts search : Use POST /v2/:account_id/linkedin/search/posts Perform Posts Search.

  • Enum values for body params sort_by, date_posted and content_type are now uppercase.
  • Body param first_connections within posted_by is renamed to relations.

• Jobs search : Use POST /v2/:account_id/linkedin/search/jobs Perform Jobs Search.

  • Enum values for body param sort_by are now uppercase.
  • Body param date_posted has changed.
    • Expected value is now PAST_DAY, PAST_WEEK or PAST_MONTH.
  • Body param region is renamed to primary_location.
  • Body param location_within_area is renamed to location_radius.
  • Body param seniority has changed. Refer to the mappings in the following table :

  v1 seniority	v2 seniority
  executive	EXECUTIVE
  director	DIRECTOR
  mid_senior	MID_SENIOR_LEVEL
  associate	ASSOCIATE
  entry	ENTRY_LEVEL
  intern	INTERNSHIP

  • Body param role is renamed to job_title.
  • Body param job_type is renamed to employment_status and its enum values are now uppercase.
  • Body param presence is renamed to workplace_type and its enum values are now uppercase.
  • Enum values for body params benefits and commitments are now uppercase.
  • Body param minimum_salary is renamed to salary and has changed.
    • Param minimum_salary[value] is renamed to salary[starting_from].

Recruiter

• Search From URL: Use POST /v2/:account_id/linkedin/recruiter/search Perform Search from URL.
• People search : Use POST /v2/:account_id/linkedin/recruiter/search/people Perform People Search.
  • Body param locale is removed as account locale is now applied by default.
  • Body param saved_filter is now an object with the id property.
  • Body param saved_search is removed from the general search endpoint.
    • Use POST /v2/:account_id/linkedin/recruiter/projects/:project_id/talent-pool/search Perform People Search From Talent Pool instead, where you can specify a saved_search ID in the body (saved_search[id] param).
  • Body param location has changed.
    • Param location[scope] is renamed to location[preferences].
    • Param location[title] is removed as it is no longer relevant.
  • Body param location_within_area is renamed to postal_code_radius.
    • This param must be used in conjunction with the new postal_code param.
  • Body param role is renamed to job_title and has changed.
    • Param job_title[keywords] is removed.
    • Param job_title[is_selection] is removed. Use body param occupation instead.
    • In all cases, the name of the job must be provided in job_title[name]. Subsequently, if the job was found via the List Search Parameters endpoint, the corresponding ID must be placed in the job_title[id] field.
    • Param role[scope] is renamed to job_title[preferences].
  • Body param skills has changed.
    • Param skills[keywords] is removed.
    • In all cases, the name of the skill must be provided in skills[name]. Subsequently, if the skill was found via the List Search Parameters endpoint, the corresponding ID must be placed in the skills[id] field.
  • Body param company has changed.
    • Param company[keywords] is removed.
    • In all cases, the name of the company must be provided in company[name]. Subsequently, if the company was found via the List Search Parameters endpoint, the corresponding ID must be placed in the company[id] field.
    • Param company[scope] is renamed to job_title[preferences].
  • Body param company_headcount is renamed to company_size.
  • Body param groups is renamed to group.
  • Body param tenure is renamed to years_of_experience.
  • Body param tenure_in_company is renamed to years_in_company.
  • Body param tenure_in_position is renamed to years_in_position.
  • Body param seniority has changed.
    • Since seniority values can only be included, the expected value here is the equivalent of seniority[include] in uppercase characters.
  • Body param spoken_languages is renamed to spoken_language and has changed.
    • Param spoken_languages[scope] is renamed to spoken_language[preferences].
  • Body param hide_previously_viewed has changed.
    • Param hide_previously_viewed[timespan] is no longer a number but a string enum of durations. See API Reference for details.
  • Body param profile_language has changed.
    • You must now use the List Search Parameters endpoint with the PROFILE_LANGUAGE type to retrieve reference IDs to be used here.
  • Body param has_military_background is renamed to is_military_veteran.
  • Body param past_applicants is renamed to is_past_applicant.
  • Body param hiring_projects is renamed to project.
  • Body param recruiting_activity has changed.
    • Param recruiting_activity[timespan] is renamed to recruiting_activity[preferences] and is no longer a number, but a string enum of durations. See API Reference for details.

Sales Navigator

• Search From URL: Use POST /v2/:account_id/linkedin/sales-navigator/search Perform Search from URL.
• People Search: Use POST /v2/:account_id/linkedin/sales-navigator/search/people Perform People Search.
  • Body param saved_search_id is removed.
    • Use param saved_search which is an object that contains an id property.
  • Body param last_viewed_at is moved in saved_search.
  • Body param recent_search_id is removed.
    • Use param recent_search which is an object that contains an id property.
  • Body param location_by_postal_code is renamed to postal_code.
  • Body params first_name and last_name are now string arrays.
  • Body param tenure is renamed to years_of_experience.
  • Body param groups is renamed to group and is now an object with include and exclude properties to include or exclude groups from the search results.
  • Body param profile_language has changed.
    • You must now use the List Search Parameters endpoint with the PROFILE_LANGUAGE type to retrieve reference IDs to be used here.
  • Body param company is renamed to current_company.
  • Enum values for body param company_type are now uppercase.
  • Body param tenure_at_company is renamed to years_in_company.
  • Body param tenure_at_role is renamed to years_in_position.
  • Body param role is renamed to current_job_title.
  • Body param past_role is renamed to past_job_title.
  • Enum values for body param seniority are now uppercase.
  • Body param mentionned_in_news is removed as it is deprecated.
  • Body param account_lists is renamed to account_list.
  • Body param lead_lists is renamed to lead_list.
  • Body param viewed_profile_recently is moved within recent_interaction and renamed to viewed_profile.
  • Body param messaged_recently is moved within recent_interaction and renamed to messaged.
  • Body param include_saved_leads is moved within saved_resources and renamed to saved_leads.
  • Body param include_saved_accounts is moved within saved_resources and renamed to saved_accounts.
  • Body param save_search is removed.
    • Use search_name directly in the body.
• Companies Search: Use POST /v2/:account_id/linkedin/sales-navigator/search/companies Perform Companies Search.
  • Body param saved_search_id is removed.
    • Use param saved_search which is an object that contains an id property.
  • Body param last_viewed_at is moved in saved_search.
  • Body param recent_search_id is removed.
    • Use param recent_search which is an object that contains an id property.
  • Body param location_by_postal_code is renamed to postal_code.
  • Body param has_job_offers is removed.
    • Use body param spotlights with value HIRING_ON_LINKEDIN.
  • Body param network_distance is removed.
    • Use body param spotlights with value FIRST_DEGREE_CONNECTIONS.
  • Body params department_headcount and department_headcount_growth have changed.
    • Param department is now a string since only one department can be specified.
  • Body param followers_count is renamed to followers.
  • Body param technologies is removed as it is deprecated.
  • Body param recent_activities is removed.
    • Use body param spotlights with value RECENT_LEADERSHIP_CHANGE or/and RECENT_FUNDING_EVENTS.
  • Body param saved_accounts has changed.
    • It now expects a boolean since you can only choose if you want to include all your saved accounts or not.
  • Body param account_lists is renamed to account_list.
  • Body param save_search is removed.
    • Use search_name directly in the body.

List all job postings

GET /v1/linkedin/jobs

• On Classic, use GET /v2/:account_id/linkedin/jobs List User Job Postings.
• On Recruiter, use GET /v2/:account_id/linkedin/recruiter/jobs List User Job Postings.
• Common changes :
  • Query param cursor is removed. User offset instead.
  • Query param category is renamed to state and has changed. Refer to the the following mapping table :

Create a job posting

POST /v1/linkedin/jobs

• On Classic, use POST /v2/:account_id/linkedin/jobs Create a Job Posting Draft.
  • Params text within job_title and company are renamed to name.
  • Body param workplace is renamed to workplace_type.
  • Body param auto_rejection_template is moved into rejection_settings and renamed to rejection_template.
  • Body param screening_questions has changed.
    • Param must_match is renamed to qualification_required.
    • Param position is removed as it is not relevant.
  • Body param recruiter is removed as it is not relevant in Classic job posting.
• On Recruiter, use POST /v2/:account_id/linkedin/recruiter/jobs Create a Job Posting Draft in a New Project.
  • The base body params have undergone the same changes as those applied on Classic.
  • Body param recruiter is removed. Its content is merged with the other params.
    • Param project is removed.
      • If no project is associated with the job posting, use project_name param to define the name of a new project.
      • To create a job posting in an existing project, use POST /v2/:account_id/linkedin/recruiter/projects/:project_id/jobs Create a Job Posting Draft in an Existing Project.
    • Param functions is renamed to job_function.
    • Param industries is renamed to industry.
    • Param seniority is renamed to seniority_level.
    • Param apply_method has changed.
      • Param type is renamed to method.
      • Param url is renamed to website_url.
    • Param auto_archive_applicants is removed.
      • Param screening_questions is moved to rejection_settings and renamed to reject_unqualified_applicants.
      • Param outside_of_country is moved to rejection_settings and renamed to reject_out_of_country_applicants.
    • Param send_rejection_notification is moved to rejection_settings.

Get job offer

GET /v1/linkedin/jobs/:job_id

• On Classic, use GET /v2/:account_id/linkedin/jobs/:job_id Get a Job Posting.
• On Recruiter, use GET /v2/:account_id/linkedin/recruiter/jobs/:job_id Get a Job Posting.
  • To retrieve a job posting by project, use GET /v2/:account_id/linkedin/recruiter/projects/:project_id/jobs Get a Job Posting by Project.
• Common changes :
  • Query param service is removed as it is no longer relevant.

Edit a job posting

PATCH /v1/linkedin/jobs/:job_id

• On Classic, use PATCH /v2/:account_id/linkedin/jobs/:job_id Edit an existing Job Posting.
  • Changes are the same as in Create a Job Posting.
• On Recruiter, use PATCH /v2/:account_id/linkedin/recruiter/projects/:project_id/jobs/:job_id Edit an existing Job Posting.
  • Param project_id in body param recruiter is removed as the project ID must now be specified in the path params.
  • Other changes are the same as in Create a Job Posting.

Publish a job posting

POST /v1/linkedin/jobs/:draft_id/publish

• On Classic, use POST /v2/:account_id/linkedin/jobs/:job_id/publish Publish a Job Posting.
  • Body param hiring_photo_frame is renamed to set_hiring_frame.
  • Param monthly in body param budget is renamed to total.
• On Recruiter, use POST /v2/:account_id/linkedin/recruiter/projects/:project_id/jobs/:job_id/publish Publish a Job Posting.
  • Body param mode can only be FREE or PROMOTED as PROMOTED_PLUS is specific to Classic.
  • Body param hiring_photo_frame is removed as it doesn't apply to Recruiter.
  • Param monthly in body param budget is renamed to total.
• Common changes :
  • Path param draft_id is renamed to job_id.
  • Body param service is removed as it is no longer relevant.

Solve a job publishing checkpoint

POST /v1/linkedin/jobs/:draft_id/checkpoint

This endpoint is removed as member privilegies verification is no longer considered a checkpoint.

👍

Recommendations

If you encounter an insufficient_permissions error after calling the job posting publish endpoint, you may need to verify your identity with the company on behalf of which you are posting the job offer. Use the following endpoints depending on the product :

• On Classic, use POST /v2/:account_id/linkedin/company/:company_id/member/verify-email Verify Company Member Identity.
  • Then use POST /v2/:account_id/linkedin/company/:company_id/member/submit-otp Submit Otp Verification Code to submit your verification code.
• On Recruiter, use POST /v2/:account_id/linkedin/recruiter/company/:company_id/member/verify-email Verify Company Member Identity.
  • Then use POST /v2/:account_id/linkedin/recruiter/company/:company_id/member/submit-otp Submit Otp Verification Code to submit your verification code.

Close a job posting

POST /v1/linkedin/jobs/:id/close

• On Classic, use POST /v2/:account_id/linkedin/jobs/:job_id/close Close a Job Posting.
• On Recruiter, use POST /v2/:account_id/linkedin/recruiter/projects/:project_id/jobs/:job_id/close Close a Job Posting.
• Common changes :
  • Path param id is renamed to job_id.
  • Query param service is removed as it is no longer relevant.

List all applicants to a job posting

GET /v1/linkedin/jobs/:id/applicants

• On Classic, use POST /v2/:account_id/linkedin/jobs/:job_id/applicants List Job Posting Applicants.
  • Query param ratings is no longer a string containing multiple values, but a string array.
  • Query param sort_by has changed.
    • Accepted enum values are now : APPLIED_DATE, FIRST_NAME or LAST_NAME.
  • Query params max_years_in_company, min_years_in_company, max_years_in_position, min_years_in_position, exclude_degree and include_degree are removed as they are specific to Recruiter.
• On Recruiter, use POST /v2/:account_id/linkedin/recruiter/projects/:project_id/talent-pool/applicants List Job Posting Applicants.
  • Query param ratings is removed as it is specific to Classic.
  • Enum values for query param sort_by are now uppercase.
  • Query params min_years_in_company and max_years_in_company are combined under the body param years_in_current_company (min and max properties).
  • Query params min_years_in_position and max_years_in_position are combined under the body param years_in_current_position (min and max properties).
  • Query params include_degree and exclude_degree are combined under the body param degree (include and exclude properties).
• Common changes :
  • Http method is now POST instead of GET, and query params are integrated in the body.
  • Path param id is renamed to job_id.
  • Query param cursor is removed. Use body param offset instead.
  • Query param service is removed as it is no longer relevant.
  • Query params min_years_of_experience and max_years_of_experience are combined under the body param years_of_experience (min and max properties).

Get a specific applicant to a job posting

GET /v1/linkedin/jobs/applicants/:applicant_id

• On Classic, use GET /v2/:account_id/linkedin/jobs/:job_id/applicants/:applicant_id Get an Applicant.
• On Recruiter, use GET /v2/:account_id/linkedin/recruiter/projects/:project_id/talent-pool/applicants/:applicant_id Get an Applicant.

Download the resume of a job applicant

GET v1/linkedin/jobs/applicants/:applicant_id/resume

• On Classic, use GET /v2/:account_id/linkedin/jobs/:job_id/applicants/:applicant_id/resume Get an Applicant's Resume.
• On Recruiter, use GET /v2/:account_id/linkedin/recruiter/projects/:project_id/talent-pool/applicants/:applicant_id/resume Get an Applicant's Resume.

Endorse a user profile specific skill

POST /v1/linkedin/profile/endorse

• Use POST /v2/:account_id/linkedin/users/:user_id/endorse Get an Applicant's Resume.
  • Body param profile_id is renamed to user_id and moved to path params.
  
  

---

Response objects changes

CompanyProfile

---

SearchResult

People

Common changes

Classic changes

Recruiter changes

LinkedinSearch

---

LinkedinRawData

---

LinkedinSearchParameter

LinkedinSearchParametersList

---

LinkedinJobPosting

LinkedinJobPostingList

---

LinkedinJobApplicant

LinkedinJobApplicantList

---

RecruiterHiringProject

RecruiterHiringProjectList

---

InmailCredits