Breezy HR

App · 25 actions

Run hiring in Breezy HR from workflows: create and publish positions, add and update candidates, move them through your pipeline, tag them, message them, send questionnaires and start workflows when candidates arrive or move.

Actions

ActionWhat it does
Add candidateAdd a candidate to a position's first stage, as sourced by your team.
Add note to candidatePost a note on a candidate for your team.
Add tags to candidateAdd tags to a candidate, keeping the ones they have.
Change position statusPublish a position so it takes applications, or close, archive or return it to draft.
Create positionCreate a job.
Find candidates by emailFind every candidate with exactly this email address, on any position, with the ids the other candidate steps take.
Get candidateGet a candidate's profile, stage, tags and resume link.
Get positionGet a position's details: title, status, location, salary.
List candidate activityList what happened to a candidate on a position: stage changes, notes, interviews and more, 50 at a time.
List candidate custom fieldsList your company's candidate custom fields with this candidate's values.
List candidate messagesList the messages between your team and a candidate, newest first, 50 at a time.
List candidatesList the candidates on a position, 50 at a time, optionally only those in one stage.
List pipeline stagesList the hiring stages of a position's pipeline, in order, with the ids 'Move candidate to stage' takes.
List positionsList your positions (jobs).
List questionnairesList the questionnaires your company has set up in Breezy.
Move candidate to another positionMove a candidate from one position to another, into its Applied stage unless you pick another.
Move candidate to stageMove a candidate to another stage of the position's pipeline, such as Interviewing or Hired.
Remove tags from candidateRemove tags from a candidate.
Search candidatesSearch all candidates by name, email, phone, tags, job history or answers, as Breezy's search box does.
Send message to candidateEmail the candidate from Breezy.
Send questionnaire to candidateSend a candidate one of your questionnaires and, unless you turn it off, email them the link.
Set candidate custom fieldSet the value of one of your custom fields on a candidate.
Update candidateChange a candidate's name, contact details, headline, summary or source.
Update positionChange a position's title, description, type, department, salary or tags.
Upload candidate resumeAttach a resume file to a candidate, replacing the one on file.

Add candidate

Add a candidate to a position's first stage, as sourced by your team. Breezy sends them nothing.

Inputs

Positionposition_idtextRequired
The job. Pick one, or use a position id from an earlier step.
NamenametextRequired
The candidate's full name.
Emailemail_addresstext
The candidate's email address.
Phonephone_numbertext
The candidate's phone number.
Addressaddresstext
Where the candidate lives.
Summarysummarytext
A short profile of the candidate.
Cover lettercover_lettertext
The candidate's cover letter.
Sourcesourcetext
Where the candidate came from, such as LinkedIn or Career fair.
Tagstagstext
Tags separated by commas, such as referral, senior.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "address": "Austin, TX",
    "company_id": "1a2b3c4d5e6f",
    "cover_letter": "",
    "created_at": "2026-09-03T10:22:05.000Z",
    "email_address": "ana.silva@example.com",
    "headline": "Account Manager at Northwind",
    "id": "c0ffee1234ab",
    "name": "Ana Silva",
    "origin": "sourced",
    "person_id": "5f6e7d8c9b0a",
    "phone_number": "+1 512 555 0142",
    "position_id": "8e3f1a2b4c5d",
    "resume_url": "",
    "source": "LinkedIn",
    "stage_id": "applied",
    "stage_name": "Applied",
    "summary": "Five years in B2B customer success.",
    "tags": [
      "referral"
    ],
    "updated_at": "2026-09-03T10:22:05.000Z"
  }
}

Add note to candidate

Post a note on a candidate for your team. The candidate doesn't see it.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
NotenotetextRequired
What to note.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidate_idtext
The candidate
noteobject
The note
Example output
{
  "candidate_id": "c0ffee1234ab",
  "note": {
    "author": "Jordan Lee",
    "body": "Strong phone screen; schedule a panel.",
    "created_at": "2026-09-04T16:00:00.000Z",
    "id": "7b6a5c4d3e2f"
  }
}

Add tags to candidate

Add tags to a candidate, keeping the ones they have.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
TagstagstextRequired
Tags separated by commas, such as referral, senior.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "address": "Austin, TX",
    "company_id": "1a2b3c4d5e6f",
    "cover_letter": "",
    "created_at": "2026-09-03T10:22:05.000Z",
    "email_address": "ana.silva@example.com",
    "headline": "Account Manager at Northwind",
    "id": "c0ffee1234ab",
    "name": "Ana Silva",
    "origin": "sourced",
    "person_id": "5f6e7d8c9b0a",
    "phone_number": "+1 512 555 0142",
    "position_id": "8e3f1a2b4c5d",
    "resume_url": "",
    "source": "LinkedIn",
    "stage_id": "applied",
    "stage_name": "Applied",
    "summary": "Five years in B2B customer success.",
    "tags": [
      "referral",
      "senior"
    ],
    "updated_at": "2026-09-03T10:22:05.000Z"
  }
}

Change position status

Publish a position so it takes applications, or close, archive or return it to draft.

Inputs

Positionposition_idtextRequired
The job. Pick one, or use a position id from an earlier step.
StatusstatetextRequired
The new status. Publishing can fail when your plan's limit of open positions is reached.One of: published (Published (open and taking applications)), draft, closed, archived.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

positionobject
The position
Example output
{
  "position": {
    "category": "Customer Service",
    "city": "Austin",
    "company_id": "1a2b3c4d5e6f",
    "country": "US",
    "created_at": "2026-09-01T15:04:11.000Z",
    "department": "Customer Success",
    "description": "<p>Help our customers get the most out of the product.</p>",
    "education": "Bachelor's Degree",
    "employment_type": "fullTime",
    "employment_type_name": "Full-Time",
    "experience": "Mid-Level",
    "friendly_id": "customer-success-manager",
    "id": "8e3f1a2b4c5d",
    "location": "Austin, TX, US",
    "name": "Customer Success Manager",
    "pipeline_id": "default",
    "region": "Texas",
    "remote": false,
    "requisition_id": "REQ-104",
    "salary_currency": "USD",
    "salary_from": 70000.0,
    "salary_period": "Yearly",
    "salary_to": 85000.0,
    "state": "closed",
    "tags": [
      "2026 hiring"
    ],
    "updated_at": "2026-09-02T09:12:40.000Z"
  }
}

Create position

Create a job. It starts as a draft; publish it with 'Change position status'.

Inputs

Job titlenametextRequired
The job's title.
DescriptiondescriptiontextRequired
What the job is, as candidates see it. Plain text or HTML.
CountrycountrytextRequired
Where the job is, as a two-letter code such as US or GB.
Citycitytext
The city the job is in.
State or provinceregiontext
For the US and Canada, the two-letter code, such as TX or ON.
Remoteremotetrue/false
Turn on if the job can be done remotely.Default: false.
Employment typeemployment_typetext
Full-time unless you pick another.One of: fullTime (Full-time), partTime (Part-time), contract, temporary, other. Default: fullTime.
Departmentdepartmenttext
One of the departments set up in Breezy.
Categorycategorytext
The kind of job, such as Sales or Software Development.
Experienceexperiencetext
The experience level the job asks for.One of: na (Not applicable), internship, entry-level (Entry level), associate, mid-level (Mid level), senior-level (Senior level), executive.
Educationeducationtext
The education the job asks for.One of: unspecified, some-high-school (Some high school), high-school (High school or equivalent), certification, vocational, vocational-diploma (Vocational diploma), vocational-degree (Vocational degree), some-college (Some college), associate-degree (Associate degree), bachelors-degree (Bachelor's degree), and 3 more.
Salary fromsalary_fromnumber
The lowest pay offered.At least 0.
Salary tosalary_tonumber
The highest pay offered.At least 0.
Salary periodsalary_periodtext
What the salary is for. Per year unless you pick another.One of: Yearly (Per year), Monthly (Per month), Biweekly (Every two weeks), Weekly (Per week), Daily (Per day), Hourly (Per hour).
Salary currencysalary_currencytext
A three-letter currency code, such as EUR. Defaults to USD.
Requisition IDrequisition_idtext
Your own reference number for the opening.
Hiring pipelinepipeline_idtext
The stages candidates go through. Defaults to your usual one.
Tagstagstext
Tags separated by commas, such as referral, senior.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

positionobject
The position
Example output
{
  "position": {
    "category": "Customer Service",
    "city": "Austin",
    "company_id": "1a2b3c4d5e6f",
    "country": "US",
    "created_at": "2026-09-01T15:04:11.000Z",
    "department": "Customer Success",
    "description": "<p>Help our customers get the most out of the product.</p>",
    "education": "Bachelor's Degree",
    "employment_type": "fullTime",
    "employment_type_name": "Full-Time",
    "experience": "Mid-Level",
    "friendly_id": "customer-success-manager",
    "id": "8e3f1a2b4c5d",
    "location": "Austin, TX, US",
    "name": "Customer Success Manager",
    "pipeline_id": "default",
    "region": "Texas",
    "remote": false,
    "requisition_id": "REQ-104",
    "salary_currency": "USD",
    "salary_from": 70000.0,
    "salary_period": "Yearly",
    "salary_to": 85000.0,
    "state": "draft",
    "tags": [
      "2026 hiring"
    ],
    "updated_at": "2026-09-02T09:12:40.000Z"
  }
}

Find candidates by email

Find every candidate with exactly this email address, on any position, with the ids the other candidate steps take.

Inputs

Emailemail_addresstextRequired
The candidate's email address.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateslist
The matches
countnumber
How many matched
Example output
{
  "candidates": [
    {
      "created_at": "2026-09-03T10:22:05.000Z",
      "id": "c0ffee1234ab",
      "name": "Ana Silva",
      "position_id": "8e3f1a2b4c5d",
      "position_name": "Customer Success Manager"
    }
  ],
  "count": 1
}

Get candidate

Get a candidate's profile, stage, tags and resume link.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "address": "Austin, TX",
    "company_id": "1a2b3c4d5e6f",
    "cover_letter": "",
    "created_at": "2026-09-03T10:22:05.000Z",
    "email_address": "ana.silva@example.com",
    "headline": "Account Manager at Northwind",
    "id": "c0ffee1234ab",
    "name": "Ana Silva",
    "origin": "sourced",
    "person_id": "5f6e7d8c9b0a",
    "phone_number": "+1 512 555 0142",
    "position_id": "8e3f1a2b4c5d",
    "resume_url": "",
    "source": "LinkedIn",
    "stage_id": "applied",
    "stage_name": "Applied",
    "summary": "Five years in B2B customer success.",
    "tags": [
      "referral"
    ],
    "updated_at": "2026-09-03T10:22:05.000Z"
  }
}

Get position

Get a position's details: title, status, location, salary.

Inputs

Positionposition_idtextRequired
The job. Pick one, or use a position id from an earlier step.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

positionobject
The position
Example output
{
  "position": {
    "category": "Customer Service",
    "city": "Austin",
    "company_id": "1a2b3c4d5e6f",
    "country": "US",
    "created_at": "2026-09-01T15:04:11.000Z",
    "department": "Customer Success",
    "description": "<p>Help our customers get the most out of the product.</p>",
    "education": "Bachelor's Degree",
    "employment_type": "fullTime",
    "employment_type_name": "Full-Time",
    "experience": "Mid-Level",
    "friendly_id": "customer-success-manager",
    "id": "8e3f1a2b4c5d",
    "location": "Austin, TX, US",
    "name": "Customer Success Manager",
    "pipeline_id": "default",
    "region": "Texas",
    "remote": false,
    "requisition_id": "REQ-104",
    "salary_currency": "USD",
    "salary_from": 70000.0,
    "salary_period": "Yearly",
    "salary_to": 85000.0,
    "state": "published",
    "tags": [
      "2026 hiring"
    ],
    "updated_at": "2026-09-02T09:12:40.000Z"
  }
}

List candidate activity

List what happened to a candidate on a position: stage changes, notes, interviews and more, 50 at a time.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Pagepagenumber
Which page of 50 to get. Defaults to the first.At least 1.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

activitieslist
What happened
countnumber
How many on this page
has_moretrue/false
Whether there is another page
pagenumber
The page returned
Example output
{
  "activities": [
    {
      "by": "Jordan Lee",
      "happened_at": "2026-09-04T15:30:00.000Z",
      "id": "6f5e4d3c2b1a",
      "note": "",
      "stage_name": "Interviewing",
      "type": "candidateStatusUpdated"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1
}

List candidate custom fields

List your company's candidate custom fields with this candidate's values.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidate_idtext
The candidate
countnumber
How many fields
custom_fieldslist
The candidate's custom fields
Example output
{
  "candidate_id": "c0ffee1234ab",
  "count": 2,
  "custom_fields": [
    {
      "choices": [],
      "data_type": "string",
      "field_id": "9a8b7c6d5e4f",
      "name": "Notice period",
      "value": "4 weeks"
    },
    {
      "choices": [
        "Citizen",
        "Visa required"
      ],
      "data_type": "dropdown",
      "field_id": "1f2e3d4c5b6a",
      "name": "Work authorization",
      "value": ""
    }
  ]
}

List candidate messages

List the messages between your team and a candidate, newest first, 50 at a time.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Pagepagenumber
Which page of 50 to get. Defaults to the first.At least 1.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

countnumber
How many on this page
has_moretrue/false
Whether there is another page
messageslist
The messages
pagenumber
The page returned
Example output
{
  "count": 1,
  "has_more": false,
  "messages": [
    {
      "body": "Thanks for applying! Are you free for a call this week?",
      "id": "2c3d4e5f6a7b",
      "sender": "Jordan Lee",
      "sent_at": "2026-09-04T16:05:00.000Z",
      "subject": "Next steps",
      "type": "candidateMessagePosted"
    }
  ],
  "page": 1
}

List candidates

List the candidates on a position, 50 at a time, optionally only those in one stage.

Inputs

Positionposition_idtextRequired
The job. Pick one, or use a position id from an earlier step.
Stagestage_idtext
Only candidates in this stage.
Pagepagenumber
Which page of 50 to get. Defaults to the first.At least 1.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateslist
The candidates
countnumber
How many on this page
has_moretrue/false
Whether there is another page
pagenumber
The page returned
Example output
{
  "candidates": [
    {
      "address": "Austin, TX",
      "company_id": "1a2b3c4d5e6f",
      "cover_letter": "",
      "created_at": "2026-09-03T10:22:05.000Z",
      "email_address": "ana.silva@example.com",
      "headline": "Account Manager at Northwind",
      "id": "c0ffee1234ab",
      "name": "Ana Silva",
      "origin": "sourced",
      "person_id": "5f6e7d8c9b0a",
      "phone_number": "+1 512 555 0142",
      "position_id": "8e3f1a2b4c5d",
      "resume_url": "",
      "source": "LinkedIn",
      "stage_id": "applied",
      "stage_name": "Applied",
      "summary": "Five years in B2B customer success.",
      "tags": [
        "referral"
      ],
      "updated_at": "2026-09-03T10:22:05.000Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1
}

List pipeline stages

List the hiring stages of a position's pipeline, in order, with the ids 'Move candidate to stage' takes.

Inputs

Positionposition_idtext
Whose pipeline to list. Leave empty for your default pipeline.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

countnumber
How many stages
pipeline_idtext
The pipeline's id
stageslist
The stages, in order
Example output
{
  "count": 5,
  "pipeline_id": "default",
  "stages": [
    {
      "id": "applied",
      "name": "Applied",
      "type": "applied"
    },
    {
      "id": "feedback",
      "name": "Feedback",
      "type": "feedback"
    },
    {
      "id": "interviewing",
      "name": "Interviewing",
      "type": "interviewing"
    },
    {
      "id": "offered",
      "name": "Offered",
      "type": "offered"
    },
    {
      "id": "hired",
      "name": "Hired",
      "type": "hired"
    }
  ]
}

List positions

List your positions (jobs). Every one but the archived, unless you pick a status.

Inputs

Statusstatetext
Only positions with this status.One of: published (Published (open and taking applications)), draft, closed, archived, pending (Waiting for approval).
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

countnumber
How many positions
positionslist
The positions
Example output
{
  "count": 1,
  "positions": [
    {
      "category": "Customer Service",
      "city": "Austin",
      "company_id": "1a2b3c4d5e6f",
      "country": "US",
      "created_at": "2026-09-01T15:04:11.000Z",
      "department": "Customer Success",
      "description": "<p>Help our customers get the most out of the product.</p>",
      "education": "Bachelor's Degree",
      "employment_type": "fullTime",
      "employment_type_name": "Full-Time",
      "experience": "Mid-Level",
      "friendly_id": "customer-success-manager",
      "id": "8e3f1a2b4c5d",
      "location": "Austin, TX, US",
      "name": "Customer Success Manager",
      "pipeline_id": "default",
      "region": "Texas",
      "remote": false,
      "requisition_id": "REQ-104",
      "salary_currency": "USD",
      "salary_from": 70000.0,
      "salary_period": "Yearly",
      "salary_to": 85000.0,
      "state": "published",
      "tags": [
        "2026 hiring"
      ],
      "updated_at": "2026-09-02T09:12:40.000Z"
    }
  ]
}

List questionnaires

List the questionnaires your company has set up in Breezy.

Inputs

Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

countnumber
How many questionnaires
questionnaireslist
The questionnaires
Example output
{
  "count": 1,
  "questionnaires": [
    {
      "id": "3e4f5a6b7c8d",
      "name": "Phone screen"
    }
  ]
}

Move candidate to another position

Move a candidate from one position to another, into its Applied stage unless you pick another.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
New positiontarget_position_idtextRequired
The position to move them to.
Stagetarget_stage_idtext
Their stage on the new position. Defaults to Applied.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "address": "Austin, TX",
    "company_id": "1a2b3c4d5e6f",
    "cover_letter": "",
    "created_at": "2026-09-03T10:22:05.000Z",
    "email_address": "ana.silva@example.com",
    "headline": "Account Manager at Northwind",
    "id": "c0ffee1234ab",
    "name": "Ana Silva",
    "origin": "sourced",
    "person_id": "5f6e7d8c9b0a",
    "phone_number": "+1 512 555 0142",
    "position_id": "4d5e6f7a8b9c",
    "resume_url": "",
    "source": "LinkedIn",
    "stage_id": "applied",
    "stage_name": "Applied",
    "summary": "Five years in B2B customer success.",
    "tags": [
      "referral"
    ],
    "updated_at": "2026-09-03T10:22:05.000Z"
  }
}

Move candidate to stage

Move a candidate to another stage of the position's pipeline, such as Interviewing or Hired.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Stagestage_idtextRequired
A stage of the position's hiring pipeline.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "address": "Austin, TX",
    "company_id": "1a2b3c4d5e6f",
    "cover_letter": "",
    "created_at": "2026-09-03T10:22:05.000Z",
    "email_address": "ana.silva@example.com",
    "headline": "Account Manager at Northwind",
    "id": "c0ffee1234ab",
    "name": "Ana Silva",
    "origin": "sourced",
    "person_id": "5f6e7d8c9b0a",
    "phone_number": "+1 512 555 0142",
    "position_id": "8e3f1a2b4c5d",
    "resume_url": "",
    "source": "LinkedIn",
    "stage_id": "interviewing",
    "stage_name": "Interviewing",
    "summary": "Five years in B2B customer success.",
    "tags": [
      "referral"
    ],
    "updated_at": "2026-09-03T10:22:05.000Z"
  }
}

Remove tags from candidate

Remove tags from a candidate. Tags they don't have are ignored.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
TagstagstextRequired
Tags separated by commas, such as referral, senior.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "address": "Austin, TX",
    "company_id": "1a2b3c4d5e6f",
    "cover_letter": "",
    "created_at": "2026-09-03T10:22:05.000Z",
    "email_address": "ana.silva@example.com",
    "headline": "Account Manager at Northwind",
    "id": "c0ffee1234ab",
    "name": "Ana Silva",
    "origin": "sourced",
    "person_id": "5f6e7d8c9b0a",
    "phone_number": "+1 512 555 0142",
    "position_id": "8e3f1a2b4c5d",
    "resume_url": "",
    "source": "LinkedIn",
    "stage_id": "applied",
    "stage_name": "Applied",
    "summary": "Five years in B2B customer success.",
    "tags": [],
    "updated_at": "2026-09-03T10:22:05.000Z"
  }
}

Search candidates

Search all candidates by name, email, phone, tags, job history or answers, as Breezy's search box does.

Inputs

Search forquerytextRequired
Words to look for. Put a phrase in quotes; use AND, OR and NOT to combine words.
Include archivedinclude_archivedtrue/false
Also search candidates who were archived.Default: true.
Pagepagenumber
Which page of 50 to get. Defaults to the first.At least 1.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateslist
The matches
countnumber
How many on this page
has_moretrue/false
Whether there is another page
pagenumber
The page returned
totalnumber
How many matched in all
Example output
{
  "candidates": [
    {
      "created_at": "2026-09-03T10:22:05.000Z",
      "email_address": "ana.silva@example.com",
      "headline": "Account Manager at Northwind",
      "id": "c0ffee1234ab",
      "name": "Ana Silva",
      "person_id": "5f6e7d8c9b0a",
      "phone_number": "+1 512 555 0142",
      "position_id": "8e3f1a2b4c5d",
      "position_name": "Customer Success Manager",
      "stage_id": "applied",
      "stage_name": "Applied",
      "tags": [
        "referral"
      ],
      "updated_at": "2026-09-03T10:22:05.000Z"
    }
  ],
  "count": 1,
  "has_more": false,
  "page": 1,
  "total": 1
}

Send message to candidate

Email the candidate from Breezy. Their reply lands in the candidate's conversation in Breezy.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Subjectsubjecttext
The email's subject.
MessagebodytextRequired
What to say. Plain text or HTML.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidate_idtext
The candidate
messageobject
The message sent
Example output
{
  "candidate_id": "c0ffee1234ab",
  "message": {
    "body": "Thanks for applying! Are you free for a call this week?",
    "id": "2c3d4e5f6a7b",
    "sender": "Jordan Lee",
    "sent_at": "2026-09-04T16:05:00.000Z",
    "subject": "Next steps",
    "type": "candidateMessagePosted"
  }
}

Send questionnaire to candidate

Send a candidate one of your questionnaires and, unless you turn it off, email them the link.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Questionnairequestionnaire_idtextRequired
The questionnaire to send.
Email the candidateemail_candidatetrue/false
Email them a link to fill it in. Turn off to only add it to their record.Default: true.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidate_idtext
The candidate
emailedtrue/false
Whether the candidate was emailed the link
questionnaireobject
The questionnaire sent
Example output
{
  "candidate_id": "c0ffee1234ab",
  "emailed": true,
  "questionnaire": {
    "id": "4a5b6c7d8e9f",
    "name": "Phone screen",
    "status": "sent"
  }
}

Set candidate custom field

Set the value of one of your custom fields on a candidate.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Fieldfield_idtextRequired
The custom field to set.
ValuevaluetextRequired
The value. For a choice field, one of its choices; for a date, YYYY-MM-DD; for money, a number.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidate_idtext
The candidate
countnumber
How many fields
custom_fieldslist
The candidate's custom fields
Example output
{
  "candidate_id": "c0ffee1234ab",
  "count": 2,
  "custom_fields": [
    {
      "choices": [],
      "data_type": "string",
      "field_id": "9a8b7c6d5e4f",
      "name": "Notice period",
      "value": "4 weeks"
    },
    {
      "choices": [
        "Citizen",
        "Visa required"
      ],
      "data_type": "dropdown",
      "field_id": "1f2e3d4c5b6a",
      "name": "Work authorization",
      "value": ""
    }
  ]
}

Update candidate

Change a candidate's name, contact details, headline, summary or source. Fields left empty stay as they are.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
Namenametext
A new full name. Leave empty to keep it.
Headlineheadlinetext
A short line about them, such as their job title.
Emailemail_addresstext
The candidate's email address.
Phonephone_numbertext
The candidate's phone number.
Addressaddresstext
Where the candidate lives.
Summarysummarytext
A short profile of the candidate.
Cover lettercover_lettertext
The candidate's cover letter.
Sourcesourcetext
Where the candidate came from, such as LinkedIn or Career fair.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidateobject
The candidate
Example output
{
  "candidate": {
    "address": "Austin, TX",
    "company_id": "1a2b3c4d5e6f",
    "cover_letter": "",
    "created_at": "2026-09-03T10:22:05.000Z",
    "email_address": "ana.silva@example.com",
    "headline": "Account Manager at Northwind",
    "id": "c0ffee1234ab",
    "name": "Ana Silva",
    "origin": "sourced",
    "person_id": "5f6e7d8c9b0a",
    "phone_number": "+1 512 555 0142",
    "position_id": "8e3f1a2b4c5d",
    "resume_url": "",
    "source": "LinkedIn",
    "stage_id": "applied",
    "stage_name": "Applied",
    "summary": "Five years in B2B customer success.",
    "tags": [
      "referral"
    ],
    "updated_at": "2026-09-03T10:22:05.000Z"
  }
}

Update position

Change a position's title, description, type, department, salary or tags. Fields left empty stay as they are.

Inputs

Positionposition_idtextRequired
The job. Pick one, or use a position id from an earlier step.
Job titlenametext
A new title. Leave empty to keep it.
Descriptiondescriptiontext
A new description. Leave empty to keep it.
Employment typeemployment_typetext
A new employment type. Leave empty to keep it.One of: fullTime (Full-time), partTime (Part-time), contract, temporary, other.
Departmentdepartmenttext
One of the departments set up in Breezy.
Categorycategorytext
The kind of job, such as Sales or Software Development.
Experienceexperiencetext
The experience level the job asks for.One of: na (Not applicable), internship, entry-level (Entry level), associate, mid-level (Mid level), senior-level (Senior level), executive.
Educationeducationtext
The education the job asks for.One of: unspecified, some-high-school (Some high school), high-school (High school or equivalent), certification, vocational, vocational-diploma (Vocational diploma), vocational-degree (Vocational degree), some-college (Some college), associate-degree (Associate degree), bachelors-degree (Bachelor's degree), and 3 more.
Salary fromsalary_fromnumber
The lowest pay offered.At least 0.
Salary tosalary_tonumber
The highest pay offered.At least 0.
Salary periodsalary_periodtext
What the salary is for. Per year unless you pick another.One of: Yearly (Per year), Monthly (Per month), Biweekly (Every two weeks), Weekly (Per week), Daily (Per day), Hourly (Per hour).
Salary currencysalary_currencytext
A three-letter currency code, such as EUR. Defaults to USD.
Tagstagstext
Tags separated by commas. They replace the position's tags.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

positionobject
The position
Example output
{
  "position": {
    "category": "Customer Service",
    "city": "Austin",
    "company_id": "1a2b3c4d5e6f",
    "country": "US",
    "created_at": "2026-09-01T15:04:11.000Z",
    "department": "Customer Success",
    "description": "<p>Help our customers get the most out of the product.</p>",
    "education": "Bachelor's Degree",
    "employment_type": "fullTime",
    "employment_type_name": "Full-Time",
    "experience": "Mid-Level",
    "friendly_id": "customer-success-manager",
    "id": "8e3f1a2b4c5d",
    "location": "Austin, TX, US",
    "name": "Customer Success Manager",
    "pipeline_id": "default",
    "region": "Texas",
    "remote": false,
    "requisition_id": "REQ-104",
    "salary_currency": "USD",
    "salary_from": 70000.0,
    "salary_period": "Yearly",
    "salary_to": 85000.0,
    "state": "published",
    "tags": [
      "2026 hiring"
    ],
    "updated_at": "2026-09-02T09:12:40.000Z"
  }
}

Upload candidate resume

Attach a resume file to a candidate, replacing the one on file.

Inputs

Positionposition_idtextRequired
The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
Candidate IDcandidate_idtextRequired
The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
ResumeresumetextRequired
The resume: a PDF, Word document or text file.
Companycompany_idtext
Your company in Breezy. Leave empty if you have only one.

Outputs

candidate_idtext
The candidate
file_nametext
The file's name
uploadedtrue/false
Whether it was attached
Example output
{
  "candidate_id": "c0ffee1234ab",
  "file_name": "ana-silva-resume.pdf",
  "uploaded": true
}

On this page