Projects

Projects

curl --request POST \
  --url https://api.linkupapi.com/v2/recruiter \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "action": "<string>",
  "params": {}
}
'

import requests

url = "https://api.linkupapi.com/v2/recruiter"

payload = {
    "account_id": "<string>",
    "action": "<string>",
    "params": {}
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '<string>', action: '<string>', params: {}})
};

fetch('https://api.linkupapi.com/v2/recruiter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linkupapi.com/v2/recruiter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'action' => '<string>',
    'params' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linkupapi.com/v2/recruiter"

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linkupapi.com/v2/recruiter")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linkupapi.com/v2/recruiter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "total_results": 1,
    "offset": 0,
    "projects": [
      {
        "project_id": "2159702274",
        "project_urn": "urn:li:ts_hiring_project:(urn:li:ts_contract:123,2159702274)",
        "name": "Growth Marketer — Paris",
        "state": "ACTIVE",
        "candidate_counts": { "uncontacted": 2, "contacted": 1, "replied": 0 },
        "hiring_states": [
          { "name": "contacted", "status_type": "CONTACTED", "urn": "urn:li:ts_hiring_state:…" }
        ]
      }
    ]
  },
  "metadata": { "action": "list_projects", "account_id": "your-seat-account-id", "credits_consumed": 1, "timestamp": "2026-10-07T12:00:00Z" }
}

{
  "success": true,
  "data": {
    "status": "success",
    "message": "Candidate moved",
    "project_urn": "urn:li:ts_hiring_project:(urn:li:ts_contract:123,2159702274)",
    "candidate_urn": "urn:li:ts_hire_identity:1670586754",
    "hiring_state_urn": "urn:li:ts_hiring_state:…"
  },
  "metadata": { "action": "move_candidate", "account_id": "your-seat-account-id", "credits_consumed": 1, "timestamp": "2026-10-07T12:00:00Z" }
}

POST

recruiter

Projects

curl --request POST \
  --url https://api.linkupapi.com/v2/recruiter \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "account_id": "<string>",
  "action": "<string>",
  "params": {}
}
'

import requests

url = "https://api.linkupapi.com/v2/recruiter"

payload = {
    "account_id": "<string>",
    "action": "<string>",
    "params": {}
}
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '<string>', action: '<string>', params: {}})
};

fetch('https://api.linkupapi.com/v2/recruiter', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.linkupapi.com/v2/recruiter",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'account_id' => '<string>',
    'action' => '<string>',
    'params' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.linkupapi.com/v2/recruiter"

	payload := strings.NewReader("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<x-api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.linkupapi.com/v2/recruiter")
  .header("x-api-key", "<x-api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.linkupapi.com/v2/recruiter")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<x-api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"account_id\": \"<string>\",\n  \"action\": \"<string>\",\n  \"params\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "total_results": 1,
    "offset": 0,
    "projects": [
      {
        "project_id": "2159702274",
        "project_urn": "urn:li:ts_hiring_project:(urn:li:ts_contract:123,2159702274)",
        "name": "Growth Marketer — Paris",
        "state": "ACTIVE",
        "candidate_counts": { "uncontacted": 2, "contacted": 1, "replied": 0 },
        "hiring_states": [
          { "name": "contacted", "status_type": "CONTACTED", "urn": "urn:li:ts_hiring_state:…" }
        ]
      }
    ]
  },
  "metadata": { "action": "list_projects", "account_id": "your-seat-account-id", "credits_consumed": 1, "timestamp": "2026-10-07T12:00:00Z" }
}

{
  "success": true,
  "data": {
    "status": "success",
    "message": "Candidate moved",
    "project_urn": "urn:li:ts_hiring_project:(urn:li:ts_contract:123,2159702274)",
    "candidate_urn": "urn:li:ts_hire_identity:1670586754",
    "hiring_state_urn": "urn:li:ts_hiring_state:…"
  },
  "metadata": { "action": "move_candidate", "account_id": "your-seat-account-id", "credits_consumed": 1, "timestamp": "2026-10-07T12:00:00Z" }
}

Overview

Manage the seat’s hiring projects — the Recruiter equivalent of a lead list — and the candidates inside them. One endpoint, the action picks the operation. Uses the account’s Recruiter seat — see Connect Account. Pass the seat’s account_id. Candidates come from Search People Recruiter.

Each action consumes 1 credit, list_project_candidates 1 credit per 10 results. Ignore this if you’re on per-seat pricing: usage is unlimited.

Request

string

required

Your API key for authentication.

string

required

The Recruiter seat’s account id.

string

required

One of the actions below.

object

Depends on the action — see each one below.

Actions

Action	Params	Does
`list_projects`	`count`, `offset`, `state` (`ACTIVE` default, `CLOSED`, `DRAFT`)	The seat’s projects, each with its `hiring_states` (stages) and `candidate_counts` per stage.
`create_project`	`name`, `description`, `private` (default `true`)	Creates a project. Returns its `project_urn`.
`add_to_project`	`project_urn`, `candidate_urn`	Files a candidate into a project.
`list_project_candidates`	`project_urn`, `count`, `offset`, `states`	The pipeline: everyone in the project, in the search result shape, each with their `hiring_state`. `states` filters on stages.
`get_project_candidate`	`project_urn`, `candidate_urn`	Where one candidate stands: stage, how they were sourced, when they were added.
`move_candidate`	`project_urn`, `candidate_urn`, `state`	Moves a candidate to another stage.
`add_note`	`candidate_urn`, `text`	Leaves a note on a candidate, visible to the whole contract.
`get_candidate_notes`	`profile_urn`	The notes and tags held on a candidate.
`recommended_candidates`	`project_urn`, `count`, `offset`	LinkedIn’s recommended matches for the project.

candidate_urn is the candidate’s hire_identity_urn from the search; profile_urn is their profile_urn.
project_urn is the urn from list_projects / create_project (a project_id works too).
state takes the stage name as the project shows it ("contacted", "uncontacted"), its status type (CONTACTED…) or its urn from hiring_states. The stage shown as “uncontacted” has the status type SHORTLISTED.

{
  "success": true,
  "data": {
    "total_results": 1,
    "offset": 0,
    "projects": [
      {
        "project_id": "2159702274",
        "project_urn": "urn:li:ts_hiring_project:(urn:li:ts_contract:123,2159702274)",
        "name": "Growth Marketer — Paris",
        "state": "ACTIVE",
        "candidate_counts": { "uncontacted": 2, "contacted": 1, "replied": 0 },
        "hiring_states": [
          { "name": "contacted", "status_type": "CONTACTED", "urn": "urn:li:ts_hiring_state:…" }
        ]
      }
    ]
  },
  "metadata": { "action": "list_projects", "account_id": "your-seat-account-id", "credits_consumed": 1, "timestamp": "2026-10-07T12:00:00Z" }
}

{
  "success": true,
  "data": {
    "status": "success",
    "message": "Candidate moved",
    "project_urn": "urn:li:ts_hiring_project:(urn:li:ts_contract:123,2159702274)",
    "candidate_urn": "urn:li:ts_hire_identity:1670586754",
    "hiring_state_urn": "urn:li:ts_hiring_state:…"
  },
  "metadata": { "action": "move_candidate", "account_id": "your-seat-account-id", "credits_consumed": 1, "timestamp": "2026-10-07T12:00:00Z" }
}

Example

{
  "account_id": "your-seat-account-id",
  "action": "move_candidate",
  "params": {
    "project_urn": "urn:li:ts_hiring_project:(urn:li:ts_contract:123,2159702274)",
    "candidate_urn": "urn:li:ts_hire_identity:1670586754",
    "state": "contacted"
  }
}

Getting Started

Accounts

Profiles

Messaging

Network

Content

Recruiting

Credits

Logs

Email Enrichment

Webhooks (Real-Time)

Overview

Request

Actions

Example

​Overview

​Request

​Actions

​Example

Overview

Request

Actions

Example