# Breezy HR

> 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.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/breezy-hr

## Actions

### Add candidate

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

**Inputs**

- Position (`position_id`, text, required): The job. Pick one, or use a position id from an earlier step.
- Name (`name`, text, required): The candidate's full name.
- Email (`email_address`, text): The candidate's email address.
- Phone (`phone_number`, text): The candidate's phone number.
- Address (`address`, text): Where the candidate lives.
- Summary (`summary`, text): A short profile of the candidate.
- Cover letter (`cover_letter`, text): The candidate's cover letter.
- Source (`source`, text): Where the candidate came from, such as LinkedIn or Career fair.
- Tags (`tags`, text): Tags separated by commas, such as referral, senior.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate` (object): The candidate

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Note (`note`, text, required): What to note.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate_id` (text): The candidate
- `note` (object): The note

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Tags (`tags`, text, required): Tags separated by commas, such as referral, senior.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate` (object): The candidate

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job. Pick one, or use a position id from an earlier step.
- Status (`state`, text, required): 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`.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `position` (object): The position

**Example output**

```json
{
  "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 title (`name`, text, required): The job's title.
- Description (`description`, text, required): What the job is, as candidates see it. Plain text or HTML.
- Country (`country`, text, required): Where the job is, as a two-letter code such as US or GB.
- City (`city`, text): The city the job is in.
- State or province (`region`, text): For the US and Canada, the two-letter code, such as TX or ON.
- Remote (`remote`, true/false): Turn on if the job can be done remotely. Default: `false`.
- Employment type (`employment_type`, text): Full-time unless you pick another. One of: `fullTime` (Full-time), `partTime` (Part-time), `contract`, `temporary`, `other`. Default: `fullTime`.
- Department (`department`, text): One of the departments set up in Breezy.
- Category (`category`, text): The kind of job, such as Sales or Software Development.
- Experience (`experience`, text): 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`.
- Education (`education`, text): 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 from (`salary_from`, number): The lowest pay offered. At least 0.
- Salary to (`salary_to`, number): The highest pay offered. At least 0.
- Salary period (`salary_period`, text): 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 currency (`salary_currency`, text): A three-letter currency code, such as EUR. Defaults to USD.
- Requisition ID (`requisition_id`, text): Your own reference number for the opening.
- Hiring pipeline (`pipeline_id`, text): The stages candidates go through. Defaults to your usual one.
- Tags (`tags`, text): Tags separated by commas, such as referral, senior.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `position` (object): The position

**Example output**

```json
{
  "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**

- Email (`email_address`, text, required): The candidate's email address.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidates` (list): The matches
- `count` (number): How many matched

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate` (object): The candidate

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job. Pick one, or use a position id from an earlier step.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `position` (object): The position

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Page (`page`, number): Which page of 50 to get. Defaults to the first. At least 1.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `activities` (list): What happened
- `count` (number): How many on this page
- `has_more` (true/false): Whether there is another page
- `page` (number): The page returned

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate_id` (text): The candidate
- `count` (number): How many fields
- `custom_fields` (list): The candidate's custom fields

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Page (`page`, number): Which page of 50 to get. Defaults to the first. At least 1.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `count` (number): How many on this page
- `has_more` (true/false): Whether there is another page
- `messages` (list): The messages
- `page` (number): The page returned

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job. Pick one, or use a position id from an earlier step.
- Stage (`stage_id`, text): Only candidates in this stage.
- Page (`page`, number): Which page of 50 to get. Defaults to the first. At least 1.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidates` (list): The candidates
- `count` (number): How many on this page
- `has_more` (true/false): Whether there is another page
- `page` (number): The page returned

**Example output**

```json
{
  "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**

- Position (`position_id`, text): Whose pipeline to list. Leave empty for your default pipeline.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `count` (number): How many stages
- `pipeline_id` (text): The pipeline's id
- `stages` (list): The stages, in order

**Example output**

```json
{
  "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**

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

**Outputs**

- `count` (number): How many positions
- `positions` (list): The positions

**Example output**

```json
{
  "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**

- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `count` (number): How many questionnaires
- `questionnaires` (list): The questionnaires

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- New position (`target_position_id`, text, required): The position to move them to.
- Stage (`target_stage_id`, text): Their stage on the new position. Defaults to Applied.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate` (object): The candidate

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Stage (`stage_id`, text, required): A stage of the position's hiring pipeline.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate` (object): The candidate

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Tags (`tags`, text, required): Tags separated by commas, such as referral, senior.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate` (object): The candidate

**Example output**

```json
{
  "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 for (`query`, text, required): Words to look for. Put a phrase in quotes; use AND, OR and NOT to combine words.
- Include archived (`include_archived`, true/false): Also search candidates who were archived. Default: `true`.
- Page (`page`, number): Which page of 50 to get. Defaults to the first. At least 1.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidates` (list): The matches
- `count` (number): How many on this page
- `has_more` (true/false): Whether there is another page
- `page` (number): The page returned
- `total` (number): How many matched in all

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Subject (`subject`, text): The email's subject.
- Message (`body`, text, required): What to say. Plain text or HTML.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate_id` (text): The candidate
- `message` (object): The message sent

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Questionnaire (`questionnaire_id`, text, required): The questionnaire to send.
- Email the candidate (`email_candidate`, true/false): Email them a link to fill it in. Turn off to only add it to their record. Default: `true`.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate_id` (text): The candidate
- `emailed` (true/false): Whether the candidate was emailed the link
- `questionnaire` (object): The questionnaire sent

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Field (`field_id`, text, required): The custom field to set.
- Value (`value`, text, required): The value. For a choice field, one of its choices; for a date, YYYY-MM-DD; for money, a number.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate_id` (text): The candidate
- `count` (number): How many fields
- `custom_fields` (list): The candidate's custom fields

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Name (`name`, text): A new full name. Leave empty to keep it.
- Headline (`headline`, text): A short line about them, such as their job title.
- Email (`email_address`, text): The candidate's email address.
- Phone (`phone_number`, text): The candidate's phone number.
- Address (`address`, text): Where the candidate lives.
- Summary (`summary`, text): A short profile of the candidate.
- Cover letter (`cover_letter`, text): The candidate's cover letter.
- Source (`source`, text): Where the candidate came from, such as LinkedIn or Career fair.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate` (object): The candidate

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job. Pick one, or use a position id from an earlier step.
- Job title (`name`, text): A new title. Leave empty to keep it.
- Description (`description`, text): A new description. Leave empty to keep it.
- Employment type (`employment_type`, text): A new employment type. Leave empty to keep it. One of: `fullTime` (Full-time), `partTime` (Part-time), `contract`, `temporary`, `other`.
- Department (`department`, text): One of the departments set up in Breezy.
- Category (`category`, text): The kind of job, such as Sales or Software Development.
- Experience (`experience`, text): 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`.
- Education (`education`, text): 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 from (`salary_from`, number): The lowest pay offered. At least 0.
- Salary to (`salary_to`, number): The highest pay offered. At least 0.
- Salary period (`salary_period`, text): 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 currency (`salary_currency`, text): A three-letter currency code, such as EUR. Defaults to USD.
- Tags (`tags`, text): Tags separated by commas. They replace the position's tags.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `position` (object): The position

**Example output**

```json
{
  "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**

- Position (`position_id`, text, required): The job the candidate is on. Pick one, or use 'position_id' from an earlier step.
- Candidate ID (`candidate_id`, text, required): The candidate's id, from 'Add candidate', 'List candidates', a trigger or another earlier step.
- Resume (`resume`, text, required): The resume: a PDF, Word document or text file.
- Company (`company_id`, text): Your company in Breezy. Leave empty if you have only one.

**Outputs**

- `candidate_id` (text): The candidate
- `file_name` (text): The file's name
- `uploaded` (true/false): Whether it was attached

**Example output**

```json
{
  "candidate_id": "c0ffee1234ab",
  "file_name": "ana-silva-resume.pdf",
  "uploaded": true
}
```
