Teamtailor
App · 20 actions
Manage candidates, jobs, job applications, comments and to-dos in Teamtailor.
Actions
| Action | What it does |
|---|---|
| Add comment | Add a comment to a candidate, optionally about one of their job applications. |
| Create candidate | Add a candidate to Teamtailor. |
| Create job | Create a job. |
| Create job application | Add a candidate to a job. |
| Create to-do | Create a to-do for a team member, optionally about a candidate. |
| Delete candidate | Delete a candidate and all of their data, including their job applications. |
| Delete comment | Delete a comment. |
| Delete job application | Remove a candidate from a job, with their answers, interviews and comments for it. |
| Delete to-do | Delete a to-do. |
| Get candidate | Get a candidate's details. |
| Get job | Get a job's details, with its department and locations. |
| Get job application | Get a job application, with its candidate, job and stage. |
| List candidates | List candidates, newest first, optionally only those matching an email address, department or date. |
| List comments | List the comments and reviews on a candidate, a job or a job application. |
| List job applications | List job applications, newest first, with the candidate, job and stage of each. |
| List jobs | List jobs, with their department and locations. |
| List users | List the people on your Teamtailor account, optionally only one email address or department. |
| Update candidate | Change a candidate's details. |
| Update job | Change a job, or open, unlist or archive it. |
| Update job application | Move a job application to another stage, or change its cover letter. |
Add comment
Add a comment to a candidate, optionally about one of their job applications.
Inputs
- Candidate ID
candidate_idtextRequired - The candidate, by the ID that Create candidate or List candidates returns.
- Author
author_idtextRequired - The team member the comment is from.
- Comment
notetextRequired - The comment.
- Job application ID
job_application_idtext - The job application the comment is about, by the ID that List job applications returns.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"candidate-id": 1,
"created-at": "example",
"id": "example",
"note": "example",
"private-note": true,
"updated-at": "example",
"user-id": 1
}
}Create candidate
Add a candidate to Teamtailor.
Inputs
- First name
first_nametext - The candidate's first name.
- Last name
last_nametext - The candidate's last name.
- Email
emailtextRequired - The candidate's email address. Each candidate in Teamtailor has a different one.
- Phone
phonetext - The candidate's phone number.
- Pitch
pitchtext - A short introduction of the candidate, up to 140 characters.
- LinkedIn URL
linkedin_urltext - A link to the candidate's LinkedIn profile.
- Tags
tagslist - Tags to put on the candidate. These replace the candidate's tags.
- Résumé link
resume_urltext - A public link to the candidate's résumé. Teamtailor downloads and keeps a copy.
- Added by a recruiter
sourcedtrue/false - Yes if a recruiter is adding the candidate, rather than the candidate applying.
- Update if the email exists
mergetrue/false - Yes to update the candidate who already has this email address instead of failing.
- Send welcome email
send_welcome_messagetrue/false - Yes to send the candidate Teamtailor's welcome email.
- Agreed to hear about future jobs
consent_given_future_jobstrue/false - Yes if the candidate agreed to be contacted about future jobs.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"connected": true,
"created-at": "example",
"email": "example",
"first-name": "example",
"id": "example",
"last-name": "example",
"linkedin-url": "example",
"phone": "example",
"pitch": "example",
"referring-site": "example",
"sourced": true,
"tags": [
"example"
],
"unsubscribed": true,
"updated-at": "example"
}
}Create job
Create a job. It starts as a draft unless you choose another status.
Inputs
- Title
titletextRequired - The job's title, as the ad shows it.
- Ad text
bodytextRequired - The ad text. Simple HTML such as paragraphs and bold text works.
- Recruiter
recruiter_idtextRequired - The recruiter in charge of the job.
- Status
statustext - Draft keeps the job hidden; Open publishes the ad; Unlisted publishes it without listing it.One of:
draft,open,unlisted. - Pitch
pitchtext - A line shown under the title of the ad.
- Internal name
internal_nametext - A name for the job that only your team sees.
- Department
department_idtext - The department the job belongs to.
- Locations
location_idslist - Where the job is.
- Remote work
remote_statustext - Whether the job can be done remotely.One of:
none,temporary,hybrid,fully. - Employment type
employment_typetext - Full time, part time, contract and so on.One of:
fully,part,contract,temporary,apprenticeship,internship,volunteer. - Tags
tagslist - Tags to put on the job. These replace the job's tags.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"body": "example",
"careersite-job-url": "example",
"created-at": "example",
"employment-type": "example",
"human-status": "example",
"id": "example",
"internal": true,
"internal-name": "example",
"pitch": "example",
"remote-status": "example",
"status": "example",
"tags": [
"example"
],
"title": "example",
"updated-at": "example"
}
}Create job application
Add a candidate to a job. They start in the job's first stage.
Inputs
- Candidate ID
candidate_idtextRequired - The candidate, by the ID that Create candidate or List candidates returns.
- Job
job_idtextRequired - The job to add the candidate to.
- Cover letter
cover_lettertext - The candidate's cover letter.
- Added by a recruiter
sourcedtrue/false - Yes if a recruiter is adding the candidate, rather than the candidate applying.
- Notify the team
send_user_notificationstrue/false - Yes to notify your team about the new application.
- Send default reply
send_default_replytrue/false - Yes to send the candidate the job's default reply email.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"changed-stage-at": "example",
"cover-letter": "example",
"created-at": "example",
"id": "example",
"referring-site": "example",
"rejected-at": "example",
"sourced": true,
"updated-at": "example"
}
}Create to-do
Create a to-do for a team member, optionally about a candidate.
Inputs
- To-do
valuetextRequired - What needs doing.
- Assigned to
assignee_idtextRequired - The team member who should do it.
- Created by
creator_idtextRequired - The team member creating the to-do, shown as the one who assigned it.
- Candidate ID
candidate_idtext - The candidate it's about, by the ID that List candidates returns.
- Due date
duedate - When it's due.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"completed-at": "example",
"created-at": "example",
"due": "example",
"id": "example",
"value": "example"
}
}Delete candidate
Delete a candidate and all of their data, including their job applications. This can't be undone.
Inputs
- Candidate ID
candidate_idtextRequired - The candidate, by the ID that Create candidate or List candidates returns.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"deleted": true,
"id": "example"
}
}Delete comment
Delete a comment. Reviews with a rating can't be deleted.
Inputs
- Comment ID
note_idtextRequired - The comment, by the ID that Add comment or List comments returns.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"deleted": true,
"id": "example"
}
}Delete job application
Remove a candidate from a job, with their answers, interviews and comments for it. The candidate stays. This can't be undone.
Inputs
- Job application ID
job_application_idtextRequired - The job application, by the ID that Create job application or List job applications returns.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"deleted": true,
"id": "example"
}
}Delete to-do
Delete a to-do.
Inputs
- To-do ID
todo_idtextRequired - The to-do, by the ID that Create to-do returns.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"deleted": true,
"id": "example"
}
}Get candidate
Get a candidate's details.
Inputs
- Candidate ID
candidate_idtextRequired - The candidate, by the ID that Create candidate or List candidates returns.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"connected": true,
"created-at": "example",
"email": "example",
"first-name": "example",
"id": "example",
"last-name": "example",
"linkedin-url": "example",
"phone": "example",
"pitch": "example",
"referring-site": "example",
"sourced": true,
"tags": [
"example"
],
"unsubscribed": true,
"updated-at": "example"
}
}Get job
Get a job's details, with its department and locations.
Inputs
- Job
job_idtextRequired - Choose the job.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"body": "example",
"careersite-job-url": "example",
"created-at": "example",
"department": {
"id": "example",
"name": "example"
},
"employment-type": "example",
"human-status": "example",
"id": "example",
"internal": true,
"internal-name": "example",
"locations": [
{
"city": "example",
"id": "example",
"name": "example"
}
],
"pitch": "example",
"remote-status": "example",
"status": "example",
"tags": [
"example"
],
"title": "example",
"updated-at": "example"
}
}Get job application
Get a job application, with its candidate, job and stage.
Inputs
- Job application ID
job_application_idtextRequired - The job application, by the ID that Create job application or List job applications returns.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"candidate": {
"email": "example",
"first-name": "example",
"id": "example",
"last-name": "example"
},
"changed-stage-at": "example",
"cover-letter": "example",
"created-at": "example",
"id": "example",
"job": {
"id": "example",
"title": "example"
},
"referring-site": "example",
"rejected-at": "example",
"sourced": true,
"stage": {
"id": "example",
"legacy-stage-type-name": "example",
"name": "example"
},
"updated-at": "example"
}
}List candidates
List candidates, newest first, optionally only those matching an email address, department or date.
Inputs
- Email
emailtext - Only the candidate with this email address.
- Department
department_idtext - Only candidates in this department.
- Added on or after
created_afterdate - Only candidates added on or after this date.
- Changed on or after
updated_afterdate - Only candidates changed on or after this date.
- Max results
max_resultsnumber - The most records to return, up to 1,000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"records": [
{
"connected": true,
"created-at": "example",
"email": "example",
"first-name": "example",
"id": "example",
"last-name": "example",
"linkedin-url": "example",
"phone": "example",
"pitch": "example",
"referring-site": "example",
"sourced": true,
"tags": [
"example"
],
"unsubscribed": true,
"updated-at": "example"
}
],
"total": 1
}
}List comments
List the comments and reviews on a candidate, a job or a job application.
Inputs
- Candidate ID
candidate_idtext - Only comments on this candidate, by the ID that List candidates returns.
- Job
job_idtext - Only comments on this job and its candidates.
- Job application ID
job_application_idtext - Only comments on this job application, by the ID that List job applications returns.
- Max results
max_resultsnumber - The most records to return, up to 1,000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"records": [
{
"candidate-id": 1,
"created-at": "example",
"id": "example",
"note": "example",
"private-note": true,
"updated-at": "example",
"user-id": 1
}
],
"total": 1
}
}List job applications
List job applications, newest first, with the candidate, job and stage of each.
Inputs
- Made on or after
created_afterdate - Only applications made on or after this date.
- Changed on or after
updated_afterdate - Only applications changed on or after this date.
- Moved on or after
moved_afterdate - Only applications moved to their current stage on or after this date.
- Max results
max_resultsnumber - The most records to return, up to 1,000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"records": [
{
"candidate": {
"email": "example",
"first-name": "example",
"id": "example",
"last-name": "example"
},
"changed-stage-at": "example",
"cover-letter": "example",
"created-at": "example",
"id": "example",
"job": {
"id": "example",
"title": "example"
},
"referring-site": "example",
"rejected-at": "example",
"sourced": true,
"stage": {
"id": "example",
"legacy-stage-type-name": "example",
"name": "example"
},
"updated-at": "example"
}
],
"total": 1
}
}List jobs
List jobs, with their department and locations. Shows published jobs unless you choose another status.
Inputs
- Status
statustext - Which jobs to list. Published is the default.One of:
published,unlisted,draft,scheduled,archived,completed,all. - Department
department_idtext - Only jobs in this department.
- Location
location_idtext - Only jobs at this location.
- Remote work
remote_statustext - Only jobs with this kind of remote work.One of:
none,temporary,hybrid,fully. - Changed on or after
updated_afterdate - Only jobs changed on or after this date.
- Max results
max_resultsnumber - The most records to return, up to 1,000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"records": [
{
"body": "example",
"careersite-job-url": "example",
"created-at": "example",
"department": {
"id": "example",
"name": "example"
},
"employment-type": "example",
"human-status": "example",
"id": "example",
"internal": true,
"internal-name": "example",
"locations": [
{
"city": "example",
"id": "example",
"name": "example"
}
],
"pitch": "example",
"remote-status": "example",
"status": "example",
"tags": [
"example"
],
"title": "example",
"updated-at": "example"
}
],
"total": 1
}
}List users
List the people on your Teamtailor account, optionally only one email address or department.
Inputs
- Email
emailtext - Only the user with this email address.
- Department
department_idtext - Only users in this department.
- Max results
max_resultsnumber - The most records to return, up to 1,000. Leave empty for 100.From 1 to 1000.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"records": [
{
"email": "example",
"id": "example",
"name": "example",
"role": "example",
"title": "example",
"username": "example",
"visible": true
}
],
"total": 1
}
}Update candidate
Change a candidate's details. Fields left empty stay as they are.
Inputs
- Candidate ID
candidate_idtextRequired - The candidate, by the ID that Create candidate or List candidates returns.
- First name
first_nametext - The candidate's first name.
- Last name
last_nametext - The candidate's last name.
- Email
emailtext - The candidate's email address. Each candidate in Teamtailor has a different one.
- Phone
phonetext - The candidate's phone number.
- Pitch
pitchtext - A short introduction of the candidate, up to 140 characters.
- LinkedIn URL
linkedin_urltext - A link to the candidate's LinkedIn profile.
- Tags
tagslist - Tags to put on the candidate. These replace the candidate's tags.
- Unsubscribed from job emails
unsubscribedtrue/false - Yes to stop emails about new jobs to this candidate.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"connected": true,
"created-at": "example",
"email": "example",
"first-name": "example",
"id": "example",
"last-name": "example",
"linkedin-url": "example",
"phone": "example",
"pitch": "example",
"referring-site": "example",
"sourced": true,
"tags": [
"example"
],
"unsubscribed": true,
"updated-at": "example"
}
}Update job
Change a job, or open, unlist or archive it. Fields left empty stay as they are.
Inputs
- Job
job_idtextRequired - Choose the job.
- Title
titletext - The job's title, as the ad shows it.
- Ad text
bodytext - The ad text. Simple HTML such as paragraphs and bold text works.
- Recruiter
recruiter_idtext - The recruiter in charge of the job.
- Status
statustext - Open publishes the ad, Draft or Archived hides it, Unlisted publishes it without listing it.One of:
open,draft,unlisted,archived. - Pitch
pitchtext - A line shown under the title of the ad.
- Internal name
internal_nametext - A name for the job that only your team sees.
- Department
department_idtext - The department the job belongs to.
- Locations
location_idslist - Where the job is.
- Remote work
remote_statustext - Whether the job can be done remotely.One of:
none,temporary,hybrid,fully. - Employment type
employment_typetext - Full time, part time, contract and so on.One of:
fully,part,contract,temporary,apprenticeship,internship,volunteer. - Tags
tagslist - Tags to put on the job. These replace the job's tags.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"body": "example",
"careersite-job-url": "example",
"created-at": "example",
"employment-type": "example",
"human-status": "example",
"id": "example",
"internal": true,
"internal-name": "example",
"pitch": "example",
"remote-status": "example",
"status": "example",
"tags": [
"example"
],
"title": "example",
"updated-at": "example"
}
}Update job application
Move a job application to another stage, or change its cover letter.
Inputs
- Job application ID
job_application_idtextRequired - The job application, by the ID that Create job application or List job applications returns.
- Job
job_idtext - The application's job, to list its stages.
- Stage
stage_idtext - The stage to move the application to.
- Cover letter
cover_lettertext - The candidate's cover letter.
Outputs
dataobject- The response from Teamtailor.
Example output
{
"data": {
"changed-stage-at": "example",
"cover-letter": "example",
"created-at": "example",
"id": "example",
"referring-site": "example",
"rejected-at": "example",
"sourced": true,
"updated-at": "example"
}
}