Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt

Use this file to discover all available pages before exploring further.

Server path: /unipile-linkedin | Type: Application | PCID required: Yes

Tools

ToolDescription
unipile_linkedin_add_post_reactionAdd a reaction to a post
unipile_linkedin_add_user_by_identifierSend an invitation
unipile_linkedin_cancel_invitationCancel an invitation
unipile_linkedin_close_job_postingClose a job posting
unipile_linkedin_create_job_postingCreate a job posting
unipile_linkedin_create_postCreate a post
unipile_linkedin_edit_account_owner_profileEdit own profile
unipile_linkedin_edit_job_postingEdit a job posting
unipile_linkedin_endorse_profileEndorse a user profile specific skill
unipile_linkedin_get_account_owner_profileRetrieve own profile
unipile_linkedin_get_available_contractsRetrieve contracts
unipile_linkedin_get_company_profileRetrieve a company profile
unipile_linkedin_get_followersList all followers
unipile_linkedin_get_followingList all followed accounts
unipile_linkedin_get_hiring_project_by_idRetrieve Recruiter hiring project from ID
unipile_linkedin_get_hiring_projectsRetrieve Recruiter hiring projects
unipile_linkedin_get_inmail_balanceGet inmail credit balance
unipile_linkedin_get_job_applicantGet a specific applicant to a job posting
unipile_linkedin_get_job_applicant_resumeDownload the resume of a job applicant
unipile_linkedin_get_job_applicantsList all applicants to a job posting
unipile_linkedin_get_job_postingGet job offer
unipile_linkedin_get_job_postingsList all job postings
unipile_linkedin_get_postRetrieve a post
unipile_linkedin_get_profile_by_identifierRetrieve a profile
unipile_linkedin_get_raw_dataGet raw data from any endpoint
unipile_linkedin_get_relationsList all relations
unipile_linkedin_get_search_parameters_listRetrieve LinkedIn search parameters
unipile_linkedin_handle_invitation_receivedHandle a received invitation
unipile_linkedin_list_all_postsList all posts
unipile_linkedin_list_all_user_invitations_receivedList all invitations received
unipile_linkedin_list_all_user_invitations_sentList all invitations sent
unipile_linkedin_list_post_commentsList all comments from a post
unipile_linkedin_list_post_reactionsList all reactions from a post
unipile_linkedin_list_user_commentsList all comments
unipile_linkedin_list_user_reactionsList all reactions
unipile_linkedin_perform_action_on_memberPerform an action with a user profile
unipile_linkedin_publish_job_postingPublish a job posting
unipile_linkedin_searchPerform Linkedin search
unipile_linkedin_select_contractSelect contract
unipile_linkedin_send_commentComment a post
unipile_linkedin_solve_job_checkpointSolve a job publishing checkpoint

unipile_linkedin_add_post_reaction

Add a reaction to a post Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account to perform the request from.
as_organizationstringNoLinkedin only Provide the ID of an organization over which you have control to perform the action on its behalf.
comment_idstringNoThe id of the comment to send a reaction to. Linkedin: use the comment id returned by the comments list.
post_idstringYesThe id of the post to send a reaction to. <br> Linkedin: use the social_id from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments <br> Instagram Please use the provider_id
reaction_typestringNoThe type of reaction to send. If not provided, it defaults to ‘like’. <br> Instagram: The only supported reaction type is ‘like’.

unipile_linkedin_add_user_by_identifier

Send an invitation Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account where the user will be added.
messagestringNoAn optional message to go with the invitation (max 300 chars).
provider_idstringYesThe id of the user to add. It has to be the provider’s id. <br> Instagram: You can use the provider_id or the username of the user. The provider_messaging_id dont work on this route !
user_emailstringNoThe email address of the user when it’s required (Linkedin specific).

unipile_linkedin_cancel_invitation

Cancel an invitation Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account to perform the request from.
invitation_idstringYesThe id of the invitation to cancel. <br>Instagram: Use the ‘provider_id’ retrieved in user profile (not ‘provider_messaging_id’)

unipile_linkedin_close_job_posting

Close a job posting Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the job offer.
servicestringNoThe Linkedin service the job posting depends on.
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_create_job_posting

Create a job posting Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesAn Unipile account id.
auto_rejection_templatestringNoYou can define a rejection message template to be automatically sent to applicants that don’t pass screening questions.
companyobjectYesThe company value
descriptionstringYesYou can use HTML tags to structure your description.
employment_statusstringNoEmployment Status
job_titleobjectYesJob Title
locationstringYesThe ID of the parameter. Use type LOCATION on the List search parameters route to find out the right ID.
recruiterobjectNoThe recruiter value
screening_questionsany[]NoScreening Questions
workplacestringYesThe workplace value

unipile_linkedin_create_post

Create a post Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe id of the account to perform the request from.
as_organizationstringNoLinkedin only Provide the ID of an organization over which you have control to perform the action on its behalf.
attachmentsstring[]NoOn linkedin, image file resolution is limited to 6012px x 6012px max.
external_linkstringNoLinkedin only An external link that should be displayed within a preview card. The URL must also be included in the post textual content. Otherwise, it will be automatically added at the end.
include_job_postingstringNoLinkedin only The ID of a job posting that should be displayed within a preview card.
locationstringNoInstagram only: The location to tag in the post.
mentionsobject[]NoLinkedin only
repoststringNoThe id of an existing LinkedIn post to publish as repost. For a simple repost without commentary, text should be an empty string.
textstringYesLinkedin: You can add a mention by inserting the index of the corresponding entry from the mentions array between two double braces. Example: Hey {{0}}, check this out ! <br> Instagram: To mention a user, use the @ symbol followed by their username.
video_thumbnailstringNoVideo Thumbnail

unipile_linkedin_edit_account_owner_profile

Edit own profile Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringNoAn Unipile account id.
cover_picturestringNoCover Picture
cover_picture_settingsobjectNoCover Picture Settings
custom_linkobjectNoCustom Link
educationobjectNoAdd or edit an education.
experienceobjectNoAdd or edit a professional experience.
headlinestringNoThe subtitle of your profile.
locationobjectNoThe location value
open_to_workobjectNoOpen To Work
picturestringNoThe picture value
picture_settingsobjectNoPicture Settings
skillsstring[]NoThe skills value
skills_followbooleanNoSkills Follow
summarystringNoThe ABOUT section of your profile.
typestringNoThe type value

unipile_linkedin_edit_job_posting

Edit a job posting Parameters:
ParameterTypeRequiredDefaultDescription
job_idstringYesThe id of the job to edit.
account_idstringNoAn Unipile account id.
auto_rejection_templatestringNoYou can define a rejection message template to be automatically sent to applicants that don’t pass screening questions.
companyobjectNoThe company value
descriptionstringNoYou can use HTML tags to structure your description.
employment_statusstringNoEmployment Status
job_titleobjectNoJob Title
locationstringNoThe ID of the parameter. Use type LOCATION on the List search parameters route to find out the right ID.
recruiterobjectNoThe recruiter value
screening_questionsany[]NoScreening Questions
workplacestringNoThe workplace value

unipile_linkedin_endorse_profile

Endorse a user profile specific skill Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesAn Unipile account id.
profile_idstringYesThe provider ID of the user, starting with ACo/ADo.
skill_endorsement_idnumberYesThis is the endorsement_id that can be found along with the skill details on the result of the Retrieve a profile route : https://developer.unipile.com/reference/userscontroller_getprofilebyidentifier

unipile_linkedin_get_account_owner_profile

Retrieve own profile Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_get_available_contracts

Retrieve contracts Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_get_company_profile

Retrieve a company profile Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe ID of the account to trigger the request from.
identifierstringYesThe identifier of the company: either the public identifier, the ID or the URN.

unipile_linkedin_get_followers

List all followers Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringNoInstagram The user to get the followers from (provider_id or username).<br/>Linkedin The user or company to get the followers from (provider_id only).
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response.<br/>Linkedin maximum 100<br/>Instagram maximum 200
account_idstringYesThe account to get the followers from. (if user_id is not provided)

unipile_linkedin_get_following

List all followed accounts Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesInstagram only The user to get the followed accounts from (provider_id or username).
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 1000.
account_idstringYesThe account to get the followed accounts from. (if user_id is not provided)

unipile_linkedin_get_hiring_project_by_id

Retrieve Recruiter hiring project from ID Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe ID of the account to trigger the request from.
idstringYesThe ID of the hiring project.

unipile_linkedin_get_hiring_projects

Retrieve Recruiter hiring projects Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
sort_orderstringNoThe sorting order for the hiring projects. Default is DESCENDING.
sort_bystringNoThe sorting method for the hiring projects. Default is ACCESSED_TIME.
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_get_inmail_balance

Get inmail credit balance Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_get_job_applicant

Get a specific applicant to a job posting Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesThe ID of the account to trigger the request from.
applicant_idstringYesThe ID of the applicant.

unipile_linkedin_get_job_applicant_resume

Download the resume of a job applicant Parameters:
ParameterTypeRequiredDefaultDescription
servicestringNoThe Linkedin service the applicant depends on. Default is classic.
applicant_idstringYesThe ID of the job applicant.
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_get_job_applicants

List all applicants to a job posting Parameters:
ParameterTypeRequiredDefaultDescription
max_years_in_companynumberNoLinkedin Recruiter native filter : YEARS IN CURRENT COMPANY.
min_years_in_companynumberNoLinkedin Recruiter native filter : YEARS IN CURRENT COMPANY.
max_years_in_positionnumberNoLinkedin Recruiter native filter : YEARS IN CURRENT POSITION.
min_years_in_positionnumberNoLinkedin Recruiter native filter : YEARS IN CURRENT POSITION.
max_years_of_experiencenumberNoLinkedin Recruiter native filter : YEARS OF EXPERIENCE.
min_years_of_experiencenumberNoLinkedin Recruiter native filter : YEARS OF EXPERIENCE.
exclude_degreestring[]NoLinkedin Recruiter native filter : DEGREES (excluded).
include_degreestring[]NoLinkedin Recruiter native filter : DEGREES (included).
ratingsstringNoOne or more ratings (UNRATED, GOOD_FIT, MAYBE, NOT_A_FIT) separated by commas.
keywordsstringNoFilter results with keywords.
sort_bystringNoThe sorting rule for applicants. Recruiter only.
servicestringNoThe Linkedin service the job posting depends on. Default is classic.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 250.
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
account_idstringYesThe ID of the account to trigger the request from.
idstringYesThe ID of the job offer.

unipile_linkedin_get_job_posting

Get job offer Parameters:
ParameterTypeRequiredDefaultDescription
job_idstringYesThe ID of the job offer.
servicestringYesThe Linkedin service the job posting depends on.
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_get_job_postings

List all job postings Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 250.
categorystringNoThe state of the requested job postings. Default is active.
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_get_post

Retrieve a post Parameters:
ParameterTypeRequiredDefaultDescription
post_idstringYesThe id of the post. <br> Linkedin: if the URL contains activity, use the numeric id (example: …-activity-7332661864792854528-… => 7332661864792854528). <br> If the URL contains ugcPost, use urn:li:ugcPost:ID. <br> If the URL contains share, use urn:li:share:ID. <br> Instagram: You can use the provider_id or the shortcode found in the post URL. (www.instagram.com/reel/SHORTCODE)
account_idstringYesThe id of the account to perform the request from.

unipile_linkedin_get_profile_by_identifier

Retrieve a profile Parameters:
ParameterTypeRequiredDefaultDescription
linkedin_sectionsstring[]NoA list of profile sections to retrieve detailed information on a LinkedIn profile. LinkedIn may throttle heavy use of full data section requests, so pick only the sections you truly need. Select *_preview to fetch all sections with preview data (first entries as displayed in the LinkedIn profile UI), or * to fetch all sections with full data (not recommended if you’re chaining a lot of profile calls in a short period). You can also combine selectors, for example, ["*_preview", "experience", "skills"] to get all sections in preview plus experience and skills in full. In the response, you may receive empty sections if LinkedIn is throttling your requests. In such case, the throttled_sections field lists the concerned sections. To prevent this, you should add random delay between your calls, and/or not request as many sections as you use to.
linkedin_apistringNoThe LinkedIn API that should be used to get the profile (relative features must be subscribed), if different from classic.
notifybooleanNoWhether the profile visit should be notified to the viewee or not. Default is false.
account_idstringYesThe id of the account to perform the request from.
identifierstringYesCan be the provider’s internal id OR the provider’s public id of the requested user.

unipile_linkedin_get_raw_data

Get raw data from any endpoint Parameters:
ParameterTypeRequiredDefaultDescription
account_idstringYesA unique identifier.
bodyobjectNoA body object to be passed for POST requests.
bypass_redirectbooleanNoIf true, do not follow HTTP redirects automatically.
encodingbooleanNoWhether the query params or the body (in case of x-www-form-urlencoded content) should be encoded on the go.
force_apibooleanNoSet to true if you need to use an API for which you might not have an active subscription.
headersobjectNoA headers object to be added to requests if needed.
methodstringNoThe method to be used for the request to be performed. Default is GET.
query_paramsobjectNoA query parameters object.
request_urlstringYesAn url pointing to some Linkedin API feature

unipile_linkedin_get_relations

List all relations Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
filterstringNoFilter out results by user name.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 1000.
account_idstringYesThe account to get the relations from. (if user_id is not provided)

unipile_linkedin_get_search_parameters_list

Retrieve LinkedIn search parameters Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
keywordsstringNoThe keywords to start the search from. Not applicable to the following parameters : EMPLOYMENT_TYPE.
servicestringNoSelect the LinkedIn API to be used to query common parameters. Default is CLASSIC.
typeobjectYesThe type of parameter for the requested search.
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_handle_invitation_received

Handle a received invitation Parameters:
ParameterTypeRequiredDefaultDescription
invitation_idstringYesThe invitation ID.
bodyobjectYesRequest body

unipile_linkedin_list_all_posts

List all posts Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
is_companybooleanNoLinkedin only Set it to “true” if the posts are from a company.
account_idstringYesThe id of the account to perform the request from.
identifierstringYesThe entity’s provider internal id. <br> Linkedin: starts with ACo/ADo for users, while for companies it’s a series of numbers. <br> Instagram: use the provider_id or the username of the user.

unipile_linkedin_list_all_user_invitations_received

List all invitations received Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
account_idstringYesThe id of the account to perform the request from.

unipile_linkedin_list_all_user_invitations_sent

List all invitations sent Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 250.
account_idstringYesThe id of the account to perform the request from.

unipile_linkedin_list_post_comments

List all comments from a post Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
sort_bystringNoThe sort method for the post comments. Default is MOST_RECENT.
comment_idstringNoThe id of the comment to get replies from. <br> Linkedin: use the comment id returned by the comments list.
account_idstringYesThe id of the account to perform the request from.
post_idstringYesThe ID of the associated post. <br> Linkedin: use the social_id from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments <br> Instagram: Need to use the provider_id. Short code cannot be used here (www.instagram.com/p/SHORTCODE)

unipile_linkedin_list_post_reactions

List all reactions from a post Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
comment_idstringNoThe id of the comment to get reactions from. <br> Linkedin: use the comment id returned by the comments list.
account_idstringNoThe id of the account to perform the request from.
post_idstringYesThe ID of the associated post. <br> Linkedin: use the social_id from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments

unipile_linkedin_list_user_comments

List all comments Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
account_idstringYesThe id of the account to perform the request from.
identifierstringYesThe user’s provider internal id.

unipile_linkedin_list_user_reactions

List all reactions Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. The value can be set between 1 and 100.
account_idstringYesThe id of the account to perform the request from.
identifierstringYesThe user’s provider internal id.

unipile_linkedin_perform_action_on_member

Perform an action with a user profile Parameters:
ParameterTypeRequiredDefaultDescription
user_idstringYesThe ID of the user.
bodyobjectYesRequest body

unipile_linkedin_publish_job_posting

Publish a job posting Parameters:
ParameterTypeRequiredDefaultDescription
draft_idstringYesThe id of the draft to publish.
bodyobjectYesRequest body

Perform Linkedin search Parameters:
ParameterTypeRequiredDefaultDescription
cursorstringNoA cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitintegerNoA limit for the number of items returned in the response. Can bet set up to 100 results for Sales Navigator and Recruiter, but Linkedin Classic shouldn’t exceed 50.
account_idstringYesThe ID of the account to trigger the request from.
bodyobjectYesRequest body

unipile_linkedin_select_contract

Select contract Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesThe ID of the contract.
account_idstringYesThe ID of the account to trigger the request from.

unipile_linkedin_send_comment

Comment a post Parameters:
ParameterTypeRequiredDefaultDescription
post_idstringYesThe ID of the associated post. <br> Linkedin: use the social_id from the post object (GET post or list posts). The post id visible in url will not work in all case, you can refer here for more details : https://developer.unipile.com/docs/posts-and-comments <br> Instagram Post short code dont work on this route, please use the provider_id instead.
account_idstringYesThe id of the account to perform the request from.
as_organizationstringNoLinkedin only Provide the ID of an organization over which you have control to perform the action on its behalf.
attachmentsstring[]NoOn linkedin, only one image file is accepted with a resolution limited to 6012px x 6012px max.
comment_idstringNoThe id of the comment to reply to. Linkedin: use the comment id returned by the comments list.
external_linkstringNoLinkedin only An external link that should be displayed within a preview card. The URL must also be included in the post textual content. Otherwise, it will be automatically added at the end.
mentionsobject[]NoLinkedin only
textstringYesLinkedin: You can add a mention by inserting the index of the corresponding entry from the mentions array between two double braces. Example: Hey {{0}}, check this out ! <br> Instagram: You can mention users by inserting their username in the text, like @username.

unipile_linkedin_solve_job_checkpoint

Solve a job publishing checkpoint Parameters:
ParameterTypeRequiredDefaultDescription
draft_idstringYesThe id of the draft to solve the checkpoint from.
account_idstringYesAn Unipile account id.
inputstringYesThe input value