Docs / Recruiter

`get_hiring_project`

Read one Recruiter hiring project.

This action only reads. It changes nothing, so it is safe to try.

What you give it

Input	What it is	Where to get it
`projectId` needed	A hiring project id. The hiring project id (from list_hiring_projects).	Run `list_hiring_projects` and use `projects[].id` from its answer. 2 more places to get it `create_job_posting` → `projectId` `get_hiring_project` → `id`
`connectionId` optional	A connection id. Which of your LinkedIn accounts to act from (its id from list_linkedin_accounts). Omit to use your first live one.	Run `list_linkedin_accounts` and use `accounts[].id` from its answer. 15 more places to get it `get_my_profile` → `accounts[].connectionId` `list_connections` → `connections[].connectionId` `list_connections` → `summary.accounts[].connectionId` `list_sent_invitations` → `pendingInvitations[].connectionId` `preview_withdraw_invitations` → `breakdown[].linkedinConnectionId` `list_conversations` → `inbox[].linkedinConnectionId` `list_inmail` → `inmail[].connectionId` `get_inmail_credits` → `accounts[].connectionId` `list_sales_navigator_contracts` → `accounts[].connectionId` `who_is_waiting_on_me` → `waitingOnYou[].connectionId` `who_went_cold` → `coldConversations[].connectionId` `connections_never_messaged` → `summary.accounts[].connectionId` `get_usage` → `connectionId` `get_conversation` → `connectionId` `get_inmail_conversation` → `connectionId`

Call it

curl -X POST https://api.heyreagent.com/v1/actions/get_hiring_project \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "content-type: application/json" \
  -d '{"projectId":"PASTE_HIRING_PROJECT_ID_HERE"}'

The same call in JavaScript

const response = await fetch("https://api.heyreagent.com/v1/actions/get_hiring_project", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_KEY",
    "content-type": "application/json",
  },
  body: JSON.stringify({
    "projectId": "PASTE_HIRING_PROJECT_ID_HERE"
  }),
});
const answer = await response.json();
console.log(answer);

The same call in Python

import requests

response = requests.post(
    "https://api.heyreagent.com/v1/actions/get_hiring_project",
    headers={"Authorization": "Bearer YOUR_KEY"},
    json={
        "projectId": "PASTE_HIRING_PROJECT_ID_HERE",
    },
)
print(response.json())

The same call in n8n

Add an HTTP Request node and fill it in like this:

Method	`POST`
URL	`https://api.heyreagent.com/v1/actions/get_hiring_project`
Send Headers	On. Name `Authorization`, Value `Bearer YOUR_KEY`
Send Body	On. Body Content Type `JSON`, Specify Body `Using JSON`, then paste the body below

{
  "projectId": "PASTE_HIRING_PROJECT_ID_HERE"
}

Put your own key where it says YOUR_KEY. Put your own value where it says PASTE_…_HERE: the table above says where each one comes from. New here? Start with your first call.

What you get back

When it worked, the answer is { "ok": true, "result": { … } }. Inside result:

`id`	A hiring project id. Other actions take it.
`name`	string
`archived`	boolean
`ownerName`	string
`ownerId`	string
`createdAt`	string
`jobPosting.id`	A job id. Other actions take it.
`jobPosting.state`	active \| draft \| review \| closed \| paused
`jobPosting.title`	string
`jobPosting.description`	string
`jobPosting.company`	string
`jobPosting.companyId`	string
`jobPosting.location`	string
`jobPosting.applicantsCounter`	number
`jobPosting.viewsCounter`	number
`jobPosting.cost`	number
`jobPosting.createdAt`	number
`jobPosting.publishedAt`	number
`jobPosting.closedAt`	number
`jobPosting.applyUrl`	string
`jobPosting.salary`	string
`jobPosting.workplace`	string
`jobPosting.seniority`	string
`jobPosting.skills`	string[]
`jobPosting.functions`	string[]
`jobPosting.industries`	string[]

A field that does not apply to an answer is left out, or is null. There are 7 more fields nested inside these.

When it did not work, the answer is { "ok": false, "error": "…", "message": "…" }. What each error means.

In Claude or ChatGPT

Once connected, ask in your own words. The assistant sees this action as a tool with the same name, get_hiring_project, and the same inputs.