Teamleader Focus

App · 33 actions

Work with your Teamleader Focus CRM: find, create, update and delete contacts and companies, run deals through your pipeline, and manage tasks and calendar events.

Actions

ActionWhat it does
Add tags to contactPut tags on a contact, creating any that do not exist.
Cancel calendar eventCancel a calendar event for all attendees.
Complete taskMark a task as done.
Create calendar eventCreate a calendar event with a start and end, linked to a company, contact or deal, optionally with attendees.
Create companyAdd a company.
Create contactAdd a contact.
Create dealCreate a deal for a company or contact, optionally in a given phase, with a value, probability and closing date.
Create taskCreate a task with a due date and a work type, optionally assigned to a user and linked to a deal or customer.
Delete companyDelete a company.
Delete contactDelete a contact.
Delete dealDelete a deal.
Delete taskDelete a task.
Get companyGet one company with its e-mail addresses, phone numbers, addresses, tags and responsible user.
Get contactGet one contact with their e-mail addresses, phone numbers, addresses, tags and linked companies.
Get current userGet the Teamleader Focus user the connection acts as: name, e-mail, function, language and time zone.
Get dealGet one deal with its customer, value, phase, owner and source.
Link contact to companyLink a contact to a company, with their position there.
List activity typesList the activity types set up in Teamleader, such as meeting or call.
List calendar eventsList calendar events, filtering by attendee, activity type or time.
List companiesList companies, searching by name, VAT number, e-mail or phone, or filtering by tags, status or last update.
List contactsList contacts, searching by name, e-mail or phone, or filtering by company, tags, status or last update.
List deal phasesList the phases deals go through, in order, optionally only those of one pipeline.
List dealsList deals, searching by title or customer, or filtering by state, pipeline, phase, owner, closing date or last activity.
List tasksList tasks, filtering by assignee, done or open, due date or customer.
List work typesList the work types set up in Teamleader.
Mark deal as lostMark a deal as lost, with the reason.
Mark deal as wonMark a deal as won.
Move deal to phaseMove a deal to another phase of its pipeline.
Remove tags from contactTake tags off a contact.
Update companyChange a company's details.
Update contactChange a contact's details.
Update dealChange a deal's title, summary, value, probability, closing date, owner, department or source.
Update taskChange a task's title, due date, work type, assignee or links.

Add tags to contact

Put tags on a contact, creating any that do not exist. Tags it already has stay.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
TagstagslistRequired
The tags.

Outputs

contactobject
The contact with its tags
Example output
{
  "contact": {
    "added_at": "example",
    "birthdate": "example",
    "companies": [],
    "emails": [],
    "first_name": "example",
    "gender": "example",
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "last_name": "example",
    "marketing_mails_consent": true,
    "primary_address": {},
    "remarks": "example",
    "salutation": "example",
    "status": "example",
    "tags": [],
    "telephones": [],
    "updated_at": "example",
    "web_url": "example",
    "website": "example"
  }
}

Cancel calendar event

Cancel a calendar event for all attendees.

Inputs

Event IDevent_idtextRequired
The event's id, from 'List events' or an earlier step.

Outputs

cancelledtrue/false
Always true once cancelled
idtext
The id of the event cancelled
Example output
{
  "cancelled": true,
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74"
}

Complete task

Mark a task as done.

Inputs

Task IDtask_idtextRequired
The task's id, from 'List tasks' or an earlier step.

Outputs

taskobject
The task, now done
Example output
{
  "task": {
    "assignee": {},
    "completed": true,
    "completed_at": "example",
    "customer": {},
    "deal": {},
    "description": "example",
    "due_on": "example",
    "estimated_duration": {},
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "priority": "example",
    "title": "example",
    "work_type": {}
  }
}

Create calendar event

Create a calendar event with a start and end, linked to a company, contact or deal, optionally with attendees.

Inputs

TitletitletextRequired
The event's title.
Activity typeactivity_type_idtextRequired
The kind of event, as set up in Teamleader.
Startstarts_atdate and timeRequired
When the event starts.
Endends_atdate and timeRequired
When the event ends.
Descriptiondescriptiontext
Details about the event.
Locationlocationtext
Where the event takes place. Teamleader only accepts it when the activity type is a meeting.
Work typework_type_idtext
The kind of work, as set up in Teamleader. Teamleader only accepts it, and needs it, when the activity type is a task.
Attendeesattendee_user_idslist
The Teamleader users who attend.
Link tolink_typetextRequired
Whether the event is linked to a company, a contact or a deal. Teamleader needs the event to be linked to one.One of: company, contact, deal.
Linked record IDlink_idtextRequired
The id of the company, contact or deal to link, from a list step.

Outputs

idtext
The id of the new record
typetext
The kind of record, such as contact
Example output
{
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
  "type": "event"
}

Create company

Add a company. Only the name is needed.

Inputs

NamenametextRequired
The company's name.
VAT numbervat_numbertext
The company's VAT number.
E-mailemailtext
The primary e-mail address. It replaces the company's e-mail addresses.
Phonephonetext
A phone number. It replaces the company's phone numbers.
Websitewebsitetext
The company's website.
Languagelanguagetext
The language to write to them in.One of: nl (Dutch), en (English), fr (French), de (German), da (Danish), es (Spanish), fi (Finnish), it (Italian), nb (Norwegian), pl (Polish), and 3 more.
Responsible userresponsible_user_idtext
The Teamleader user who looks after the company.
Preferred currencypreferred_currencytext
The currency to use for the company.One of: EUR (Euro (EUR)), USD (US dollar (USD)), GBP (Pound sterling (GBP)), CHF (Swiss franc (CHF)), DKK (Danish krone (DKK)), SEK (Swedish krona (SEK)), NOK (Norwegian krone (NOK)), PLN (Polish zloty (PLN)), CZK (Czech koruna (CZK)), RON (Romanian leu (RON)), and 13 more.
Remarksremarkstext
Background information, as Markdown.
Allow marketing e-mailsmarketing_mails_consenttrue/false
Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
Street and numberaddress_line_1text
The primary address, first line. An address needs this, the postal code, the city and the country; it replaces the current primary address.
Postal codepostal_codetext
The primary address' postal code.
Citycitytext
The primary address' city.
Country codecountrytext
The two-letter country code, such as BE or NL.
Tagstagslist
Tags to put on the company.

Outputs

idtext
The id of the new record
typetext
The kind of record, such as contact
Example output
{
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
  "type": "company"
}

Create contact

Add a contact. Only the last name is needed; link them to a company afterwards with 'Link contact to company'.

Inputs

Last namelast_nametextRequired
The contact's last name.
First namefirst_nametext
The contact's first name.
E-mailemailtext
The primary e-mail address. It replaces the contact's e-mail addresses.
Phonephonetext
A phone number. Setting a phone or mobile number replaces the contact's phone numbers.
Mobilemobiletext
A mobile number. Setting a phone or mobile number replaces the contact's phone numbers.
Websitewebsitetext
The contact's website.
Salutationsalutationtext
How to address them, such as Mr or Ms.
Gendergendertext
The contact's gender.One of: female, male, non_binary (Non-binary), prefers_not_to_say (Prefers not to say), unknown.
Languagelanguagetext
The language to write to them in.One of: nl (Dutch), en (English), fr (French), de (German), da (Danish), es (Spanish), fi (Finnish), it (Italian), nb (Norwegian), pl (Polish), and 3 more.
Birthdatebirthdatedate
Their date of birth.
Remarksremarkstext
Background information, as Markdown.
Allow marketing e-mailsmarketing_mails_consenttrue/false
Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
Street and numberaddress_line_1text
The primary address, first line. An address needs this, the postal code, the city and the country; it replaces the current primary address.
Postal codepostal_codetext
The primary address' postal code.
Citycitytext
The primary address' city.
Country codecountrytext
The two-letter country code, such as BE or NL.
Tagstagslist
Tags to put on the contact.

Outputs

idtext
The id of the new record
typetext
The kind of record, such as contact
Example output
{
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
  "type": "contact"
}

Create deal

Create a deal for a company or contact, optionally in a given phase, with a value, probability and closing date.

Inputs

TitletitletextRequired
The deal's title.
Customer typecustomer_typetextRequired
Whether the customer is a company or a contact.One of: company, contact.
Customer IDcustomer_idtextRequired
The customer's id, from 'List companies', 'List contacts' or an earlier step.
Contact person IDcontact_person_idtext
The contact at the customer to deal with, from 'List contacts' or an earlier step.
Phasephase_idtext
The phase to start in. Defaults to the first phase of the default pipeline.
Summarysummarytext
Remarks about the deal.
Sourcesource_idtext
Where the deal came from.
Departmentdepartment_idtext
The department the deal belongs to.
Responsible userresponsible_user_idtext
The Teamleader user who owns the deal.
Estimated valueestimated_valuenumber
The expected amount of the deal.
Currencycurrencytext
The currency of the estimated value. Defaults to EUR.One of: EUR (Euro (EUR)), USD (US dollar (USD)), GBP (Pound sterling (GBP)), CHF (Swiss franc (CHF)), DKK (Danish krone (DKK)), SEK (Swedish krona (SEK)), NOK (Norwegian krone (NOK)), PLN (Polish zloty (PLN)), CZK (Czech koruna (CZK)), RON (Romanian leu (RON)), and 13 more.
Probability (%)probabilitynumber
The chance of winning, from 0 to 100.From 0 to 100.
Expected closing dateclosing_datedate
When the deal is expected to close.
Purchase order numberpurchase_order_numbertext
The customer's purchase order number.

Outputs

idtext
The id of the new record
typetext
The kind of record, such as contact
Example output
{
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
  "type": "deal"
}

Create task

Create a task with a due date and a work type, optionally assigned to a user and linked to a deal or customer.

Inputs

TitletitletextRequired
The task's title.
Due datedue_ondateRequired
When the task is due.
Work typework_type_idtextRequired
The kind of work, as set up in Teamleader.
Descriptiondescriptiontext
Details about the task.
Assign toassignee_idtext
The Teamleader user to give the task to. Leave empty to leave it unassigned.
Estimated minutesestimated_minutesnumber
How long the task should take, in minutes.At least 1.
Deal IDdeal_idtext
The deal the task belongs to, from 'List deals' or an earlier step.
Customer typecustomer_typetext
Whether the customer is a company or a contact.One of: company, contact.
Customer IDcustomer_idtext
The customer's id, from 'List companies', 'List contacts' or an earlier step.

Outputs

idtext
The id of the new record
typetext
The kind of record, such as contact
Example output
{
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
  "type": "todo"
}

Delete company

Delete a company. This cannot be undone.

Inputs

Company IDcompany_idtextRequired
The company's id, from 'List companies' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
idtext
The id of the record deleted
Example output
{
  "deleted": true,
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74"
}

Delete contact

Delete a contact. This cannot be undone.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
idtext
The id of the record deleted
Example output
{
  "deleted": true,
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74"
}

Delete deal

Delete a deal. This cannot be undone.

Inputs

Deal IDdeal_idtextRequired
The deal's id, from 'List deals' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
idtext
The id of the record deleted
Example output
{
  "deleted": true,
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74"
}

Delete task

Delete a task. This cannot be undone.

Inputs

Task IDtask_idtextRequired
The task's id, from 'List tasks' or an earlier step.

Outputs

deletedtrue/false
Always true once deleted
idtext
The id of the record deleted
Example output
{
  "deleted": true,
  "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74"
}

Get company

Get one company with its e-mail addresses, phone numbers, addresses, tags and responsible user.

Inputs

Company IDcompany_idtextRequired
The company's id, from 'List companies' or an earlier step.

Outputs

companyobject
The company
Example output
{
  "company": {
    "added_at": "example",
    "emails": [],
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "marketing_mails_consent": true,
    "name": "example",
    "preferred_currency": "example",
    "primary_address": {},
    "responsible_user": {},
    "status": "example",
    "tags": [],
    "telephones": [],
    "updated_at": "example",
    "vat_number": "example",
    "web_url": "example",
    "website": "example"
  }
}

Get contact

Get one contact with their e-mail addresses, phone numbers, addresses, tags and linked companies.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.

Outputs

contactobject
The contact
Example output
{
  "contact": {
    "added_at": "example",
    "birthdate": "example",
    "companies": [],
    "emails": [],
    "first_name": "example",
    "gender": "example",
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "last_name": "example",
    "marketing_mails_consent": true,
    "primary_address": {},
    "remarks": "example",
    "salutation": "example",
    "status": "example",
    "tags": [],
    "telephones": [],
    "updated_at": "example",
    "web_url": "example",
    "website": "example"
  }
}

Get current user

Get the Teamleader Focus user the connection acts as: name, e-mail, function, language and time zone.

Inputs

None.

Outputs

userobject
The connected user
Example output
{
  "user": {
    "account": {},
    "email": "example",
    "first_name": "example",
    "function": "example",
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "last_name": "example",
    "teams": [],
    "telephones": [],
    "time_zone": "example"
  }
}

Get deal

Get one deal with its customer, value, phase, owner and source.

Inputs

Deal IDdeal_idtextRequired
The deal's id, from 'List deals' or an earlier step.

Outputs

dealobject
The deal
Example output
{
  "deal": {
    "closed_at": "example",
    "created_at": "example",
    "current_phase": {},
    "department": {},
    "estimated_closing_date": "example",
    "estimated_probability": 1,
    "estimated_value": {},
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "lead": {},
    "lost_reason": {},
    "pipeline": {},
    "purchase_order_number": "example",
    "reference": "example",
    "responsible_user": {},
    "source": {},
    "status": "example",
    "summary": "example",
    "title": "example",
    "updated_at": "example",
    "web_url": "example",
    "weighted_value": {}
  }
}

Link a contact to a company, with their position there.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
Company IDcompany_idtextRequired
The company's id, from 'List companies' or an earlier step.
Positionpositiontext
Their job title at the company.
Decision makerdecision_makertrue/false
Whether they decide on purchases at the company.

Outputs

contactobject
The contact with its linked companies
Example output
{
  "contact": {
    "added_at": "example",
    "birthdate": "example",
    "companies": [],
    "emails": [],
    "first_name": "example",
    "gender": "example",
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "last_name": "example",
    "marketing_mails_consent": true,
    "primary_address": {},
    "remarks": "example",
    "salutation": "example",
    "status": "example",
    "tags": [],
    "telephones": [],
    "updated_at": "example",
    "web_url": "example",
    "website": "example"
  }
}

List activity types

List the activity types set up in Teamleader, such as meeting or call. An activity type's id is what 'Create calendar event' takes.

Inputs

None.

Outputs

activity_typeslist
The activity types
countnumber
How many activity types
Example output
{
  "activity_types": [
    {
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "name": "example"
    }
  ],
  "count": 1
}

List calendar events

List calendar events, filtering by attendee, activity type or time. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchtermtext
Matches the title and description.
Attendeeattendee_user_idtext
Only events this user is part of.
Activity typeactivity_type_idtext
Only events of this type.
Fromstarts_fromdate and time
Only events that end after this date and time.
Untilstarts_untildate and time
Only events that start before this date and time.
Ordersort_ordertext
Order by start time. Defaults to Teamleader's own order.One of: asc (Ascending), desc (Descending).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Page numberpage_numbernumber
Which page to return, starting at 1. Use it with 'Has more' to read on.At least 1.

Outputs

countnumber
How many came back on this page
eventslist
The events
has_moretrue/false
Whether a next page exists; raise the page number to get it
page_numbernumber
The page number returned
page_sizenumber
The page size used
totalnumber
How many match in all (a lower bound if Teamleader does not say)
Example output
{
  "count": 1,
  "events": [
    {
      "activity_type": {},
      "attendees": [],
      "creator": {},
      "description": "example",
      "ends_at": "example",
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "links": [],
      "location": "example",
      "starts_at": "example",
      "title": "example"
    }
  ],
  "has_more": false,
  "page_number": 1,
  "page_size": 20,
  "total": 1
}

List companies

List companies, searching by name, VAT number, e-mail or phone, or filtering by tags, status or last update. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchtermtext
Matches name, VAT number, e-mail and phone number.
E-mailemailtext
Only the company with this primary e-mail address.
VAT numbervat_numbertext
Only the company with this VAT number.
Tagstagslist
Only those that have all of these tags.
Statusstatustext
Only active or only deactivated ones.One of: active, deactivated.
Updated sinceupdated_sincedate and time
Only those changed on or after this date and time.
Sort bysort_bytext
What to order the results by.One of: added_at (Date added), updated_at (Last updated), name.
Ordersort_ordertext
Ascending or descending. Defaults to ascending when 'Sort by' is set.One of: asc (Ascending), desc (Descending).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Page numberpage_numbernumber
Which page to return, starting at 1. Use it with 'Has more' to read on.At least 1.

Outputs

companieslist
The companies
countnumber
How many came back on this page
has_moretrue/false
Whether a next page exists; raise the page number to get it
page_numbernumber
The page number returned
page_sizenumber
The page size used
totalnumber
How many match in all (a lower bound if Teamleader does not say)
Example output
{
  "companies": [
    {
      "added_at": "example",
      "emails": [],
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "language": "example",
      "marketing_mails_consent": true,
      "name": "example",
      "preferred_currency": "example",
      "primary_address": {},
      "responsible_user": {},
      "status": "example",
      "tags": [],
      "telephones": [],
      "updated_at": "example",
      "vat_number": "example",
      "web_url": "example",
      "website": "example"
    }
  ],
  "count": 1,
  "has_more": false,
  "page_number": 1,
  "page_size": 20,
  "total": 1
}

List contacts

List contacts, searching by name, e-mail or phone, or filtering by company, tags, status or last update. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchtermtext
Matches first name, last name, e-mail and phone number.
E-mailemailtext
Only the contact with this primary e-mail address.
Company IDcompany_idtext
Only contacts linked to this company, from 'List companies' or an earlier step.
Tagstagslist
Only those that have all of these tags.
Statusstatustext
Only active or only deactivated ones.One of: active, deactivated.
Updated sinceupdated_sincedate and time
Only those changed on or after this date and time.
Sort bysort_bytext
What to order the results by.One of: added_at (Date added), updated_at (Last updated), name.
Ordersort_ordertext
Ascending or descending. Defaults to ascending when 'Sort by' is set.One of: asc (Ascending), desc (Descending).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Page numberpage_numbernumber
Which page to return, starting at 1. Use it with 'Has more' to read on.At least 1.

Outputs

contactslist
The contacts
countnumber
How many came back on this page
has_moretrue/false
Whether a next page exists; raise the page number to get it
page_numbernumber
The page number returned
page_sizenumber
The page size used
totalnumber
How many match in all (a lower bound if Teamleader does not say)
Example output
{
  "contacts": [
    {
      "added_at": "example",
      "birthdate": "example",
      "companies": [],
      "emails": [],
      "first_name": "example",
      "gender": "example",
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "language": "example",
      "last_name": "example",
      "marketing_mails_consent": true,
      "primary_address": {},
      "remarks": "example",
      "salutation": "example",
      "status": "example",
      "tags": [],
      "telephones": [],
      "updated_at": "example",
      "web_url": "example",
      "website": "example"
    }
  ],
  "count": 1,
  "has_more": false,
  "page_number": 1,
  "page_size": 20,
  "total": 1
}

List deal phases

List the phases deals go through, in order, optionally only those of one pipeline. A phase's id is what 'Create deal' and 'Move deal to phase' take.

Inputs

Pipelinepipeline_idtext
Only the phases of this pipeline.

Outputs

countnumber
How many phases
phaseslist
The phases, in order
Example output
{
  "count": 1,
  "phases": [
    {
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "name": "example",
      "probability": 1
    }
  ]
}

List deals

List deals, searching by title or customer, or filtering by state, pipeline, phase, owner, closing date or last activity. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchtermtext
Matches the title, reference and the customer's name.
Statusstatuseslist
Only deals in these states.One or more of: open, won, lost.
Pipelinepipeline_idtext
Only deals in this pipeline.
Phasephase_idtext
Only deals in this phase.
Responsible userresponsible_user_idtext
Only deals owned by this user.
Closing on or afterclosing_fromdate
Only deals expected to close on or after this date.
Closing on or beforeclosing_untildate
Only deals expected to close on or before this date.
Updated sinceupdated_sincedate and time
Only deals with activity on or after this date and time.
Sort bysort_bytext
What to order the results by.One of: created_at (Date created), weighted_value (Weighted value).
Ordersort_ordertext
Ascending or descending. Defaults to ascending when 'Sort by' is set.One of: asc (Ascending), desc (Descending).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Page numberpage_numbernumber
Which page to return, starting at 1. Use it with 'Has more' to read on.At least 1.

Outputs

countnumber
How many came back on this page
dealslist
The deals
has_moretrue/false
Whether a next page exists; raise the page number to get it
page_numbernumber
The page number returned
page_sizenumber
The page size used
totalnumber
How many match in all (a lower bound if Teamleader does not say)
Example output
{
  "count": 1,
  "deals": [
    {
      "closed_at": "example",
      "created_at": "example",
      "current_phase": {},
      "department": {},
      "estimated_closing_date": "example",
      "estimated_probability": 1,
      "estimated_value": {},
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "lead": {},
      "lost_reason": {},
      "pipeline": {},
      "purchase_order_number": "example",
      "reference": "example",
      "responsible_user": {},
      "source": {},
      "status": "example",
      "summary": "example",
      "title": "example",
      "updated_at": "example",
      "web_url": "example",
      "weighted_value": {}
    }
  ],
  "has_more": false,
  "page_number": 1,
  "page_size": 20,
  "total": 1
}

List tasks

List tasks, filtering by assignee, done or open, due date or customer. Gets one page; to see more, run it again with the next page it gives.

Inputs

Searchtermtext
Matches the task's description.
Assigned toassigned_totext
Only tasks for this user or a team they are in.
Done or notstatetext
Only open tasks or only completed ones. Leave empty for both.One of: open (Open tasks), completed (Completed tasks).
Due on or afterdue_fromdate
Only tasks due from this date.
Due on or beforedue_bydate
Only tasks due by this date.
Customer typecustomer_typetext
Whether the customer is a company or a contact.One of: company, contact.
Customer IDcustomer_idtext
The customer's id, from 'List companies', 'List contacts' or an earlier step.
Sort bysort_bytext
What to order the results by.One of: due_on (Due date), created_at (Date created).
Ordersort_ordertext
Ascending or descending. Defaults to ascending when 'Sort by' is set.One of: asc (Ascending), desc (Descending).
Page sizepage_sizenumber
How many to return, 1 to 100. Defaults to 20.From 1 to 100.
Page numberpage_numbernumber
Which page to return, starting at 1. Use it with 'Has more' to read on.At least 1.

Outputs

countnumber
How many came back on this page
has_moretrue/false
Whether a next page exists; raise the page number to get it
page_numbernumber
The page number returned
page_sizenumber
The page size used
taskslist
The tasks
totalnumber
How many match in all (a lower bound if Teamleader does not say)
Example output
{
  "count": 1,
  "has_more": false,
  "page_number": 1,
  "page_size": 20,
  "tasks": [
    {
      "assignee": {},
      "completed": true,
      "completed_at": "example",
      "customer": {},
      "deal": {},
      "description": "example",
      "due_on": "example",
      "estimated_duration": {},
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "priority": "example",
      "title": "example",
      "work_type": {}
    }
  ],
  "total": 1
}

List work types

List the work types set up in Teamleader. A work type's id is what 'Create task' takes.

Inputs

None.

Outputs

countnumber
How many work types
work_typeslist
The work types
Example output
{
  "count": 1,
  "work_types": [
    {
      "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
      "name": "example"
    }
  ]
}

Mark deal as lost

Mark a deal as lost, with the reason.

Inputs

Deal IDdeal_idtextRequired
The deal's id, from 'List deals' or an earlier step.
Lost reasonreason_idtext
Why the deal was lost.
Extra informationextra_infotext
More about why it was lost.

Outputs

dealobject
The deal, now lost
Example output
{
  "deal": {
    "closed_at": "example",
    "created_at": "example",
    "current_phase": {},
    "department": {},
    "estimated_closing_date": "example",
    "estimated_probability": 1,
    "estimated_value": {},
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "lead": {},
    "lost_reason": {},
    "pipeline": {},
    "purchase_order_number": "example",
    "reference": "example",
    "responsible_user": {},
    "source": {},
    "status": "example",
    "summary": "example",
    "title": "example",
    "updated_at": "example",
    "web_url": "example",
    "weighted_value": {}
  }
}

Mark deal as won

Mark a deal as won.

Inputs

Deal IDdeal_idtextRequired
The deal's id, from 'List deals' or an earlier step.

Outputs

dealobject
The deal, now won
Example output
{
  "deal": {
    "closed_at": "example",
    "created_at": "example",
    "current_phase": {},
    "department": {},
    "estimated_closing_date": "example",
    "estimated_probability": 1,
    "estimated_value": {},
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "lead": {},
    "lost_reason": {},
    "pipeline": {},
    "purchase_order_number": "example",
    "reference": "example",
    "responsible_user": {},
    "source": {},
    "status": "example",
    "summary": "example",
    "title": "example",
    "updated_at": "example",
    "web_url": "example",
    "weighted_value": {}
  }
}

Move deal to phase

Move a deal to another phase of its pipeline.

Inputs

Deal IDdeal_idtextRequired
The deal's id, from 'List deals' or an earlier step.
Phasephase_idtextRequired
The phase to move the deal to.

Outputs

dealobject
The deal in its new phase
Example output
{
  "deal": {
    "closed_at": "example",
    "created_at": "example",
    "current_phase": {},
    "department": {},
    "estimated_closing_date": "example",
    "estimated_probability": 1,
    "estimated_value": {},
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "lead": {},
    "lost_reason": {},
    "pipeline": {},
    "purchase_order_number": "example",
    "reference": "example",
    "responsible_user": {},
    "source": {},
    "status": "example",
    "summary": "example",
    "title": "example",
    "updated_at": "example",
    "web_url": "example",
    "weighted_value": {}
  }
}

Remove tags from contact

Take tags off a contact. Other tags stay.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
TagstagslistRequired
The tags.

Outputs

contactobject
The contact with its tags
Example output
{
  "contact": {
    "added_at": "example",
    "birthdate": "example",
    "companies": [],
    "emails": [],
    "first_name": "example",
    "gender": "example",
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "last_name": "example",
    "marketing_mails_consent": true,
    "primary_address": {},
    "remarks": "example",
    "salutation": "example",
    "status": "example",
    "tags": [],
    "telephones": [],
    "updated_at": "example",
    "web_url": "example",
    "website": "example"
  }
}

Update company

Change a company's details. Only the fields you fill in change, except that an e-mail, a phone number or an address replaces the company's current ones.

Inputs

Company IDcompany_idtextRequired
The company's id, from 'List companies' or an earlier step.
Namenametext
A new name.
VAT numbervat_numbertext
The company's VAT number.
E-mailemailtext
The primary e-mail address. It replaces the company's e-mail addresses.
Phonephonetext
A phone number. It replaces the company's phone numbers.
Websitewebsitetext
The company's website.
Languagelanguagetext
The language to write to them in.One of: nl (Dutch), en (English), fr (French), de (German), da (Danish), es (Spanish), fi (Finnish), it (Italian), nb (Norwegian), pl (Polish), and 3 more.
Responsible userresponsible_user_idtext
The Teamleader user who looks after the company.
Preferred currencypreferred_currencytext
The currency to use for the company.One of: EUR (Euro (EUR)), USD (US dollar (USD)), GBP (Pound sterling (GBP)), CHF (Swiss franc (CHF)), DKK (Danish krone (DKK)), SEK (Swedish krona (SEK)), NOK (Norwegian krone (NOK)), PLN (Polish zloty (PLN)), CZK (Czech koruna (CZK)), RON (Romanian leu (RON)), and 13 more.
Remarksremarkstext
Background information, as Markdown.
Allow marketing e-mailsmarketing_mails_consenttrue/false
Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
Street and numberaddress_line_1text
The primary address, first line. An address needs this, the postal code, the city and the country; it replaces the current primary address.
Postal codepostal_codetext
The primary address' postal code.
Citycitytext
The primary address' city.
Country codecountrytext
The two-letter country code, such as BE or NL.

Outputs

companyobject
The company as it is now
Example output
{
  "company": {
    "added_at": "example",
    "emails": [],
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "marketing_mails_consent": true,
    "name": "example",
    "preferred_currency": "example",
    "primary_address": {},
    "responsible_user": {},
    "status": "example",
    "tags": [],
    "telephones": [],
    "updated_at": "example",
    "vat_number": "example",
    "web_url": "example",
    "website": "example"
  }
}

Update contact

Change a contact's details. Only the fields you fill in change, except that an e-mail, a phone or mobile number or an address replaces the contact's current ones. Use 'Add tags' for tags.

Inputs

Contact IDcontact_idtextRequired
The contact's id, from 'List contacts' or an earlier step.
Last namelast_nametext
A new last name.
First namefirst_nametext
The contact's first name.
E-mailemailtext
The primary e-mail address. It replaces the contact's e-mail addresses.
Phonephonetext
A phone number. Setting a phone or mobile number replaces the contact's phone numbers.
Mobilemobiletext
A mobile number. Setting a phone or mobile number replaces the contact's phone numbers.
Websitewebsitetext
The contact's website.
Salutationsalutationtext
How to address them, such as Mr or Ms.
Gendergendertext
The contact's gender.One of: female, male, non_binary (Non-binary), prefers_not_to_say (Prefers not to say), unknown.
Languagelanguagetext
The language to write to them in.One of: nl (Dutch), en (English), fr (French), de (German), da (Danish), es (Spanish), fi (Finnish), it (Italian), nb (Norwegian), pl (Polish), and 3 more.
Birthdatebirthdatedate
Their date of birth.
Remarksremarkstext
Background information, as Markdown.
Allow marketing e-mailsmarketing_mails_consenttrue/false
Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
Street and numberaddress_line_1text
The primary address, first line. An address needs this, the postal code, the city and the country; it replaces the current primary address.
Postal codepostal_codetext
The primary address' postal code.
Citycitytext
The primary address' city.
Country codecountrytext
The two-letter country code, such as BE or NL.

Outputs

contactobject
The contact as it is now
Example output
{
  "contact": {
    "added_at": "example",
    "birthdate": "example",
    "companies": [],
    "emails": [],
    "first_name": "example",
    "gender": "example",
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "language": "example",
    "last_name": "example",
    "marketing_mails_consent": true,
    "primary_address": {},
    "remarks": "example",
    "salutation": "example",
    "status": "example",
    "tags": [],
    "telephones": [],
    "updated_at": "example",
    "web_url": "example",
    "website": "example"
  }
}

Update deal

Change a deal's title, summary, value, probability, closing date, owner, department or source. Only the fields you fill in change.

Inputs

Deal IDdeal_idtextRequired
The deal's id, from 'List deals' or an earlier step.
Titletitletext
A new title.
Summarysummarytext
Remarks about the deal.
Sourcesource_idtext
Where the deal came from.
Departmentdepartment_idtext
The department the deal belongs to.
Responsible userresponsible_user_idtext
The Teamleader user who owns the deal.
Estimated valueestimated_valuenumber
The expected amount of the deal.
Currencycurrencytext
The currency of the estimated value. Defaults to EUR.One of: EUR (Euro (EUR)), USD (US dollar (USD)), GBP (Pound sterling (GBP)), CHF (Swiss franc (CHF)), DKK (Danish krone (DKK)), SEK (Swedish krona (SEK)), NOK (Norwegian krone (NOK)), PLN (Polish zloty (PLN)), CZK (Czech koruna (CZK)), RON (Romanian leu (RON)), and 13 more.
Probability (%)probabilitynumber
The chance of winning, from 0 to 100.From 0 to 100.
Expected closing dateclosing_datedate
When the deal is expected to close.
Purchase order numberpurchase_order_numbertext
The customer's purchase order number.

Outputs

dealobject
The deal as it is now
Example output
{
  "deal": {
    "closed_at": "example",
    "created_at": "example",
    "current_phase": {},
    "department": {},
    "estimated_closing_date": "example",
    "estimated_probability": 1,
    "estimated_value": {},
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "lead": {},
    "lost_reason": {},
    "pipeline": {},
    "purchase_order_number": "example",
    "reference": "example",
    "responsible_user": {},
    "source": {},
    "status": "example",
    "summary": "example",
    "title": "example",
    "updated_at": "example",
    "web_url": "example",
    "weighted_value": {}
  }
}

Update task

Change a task's title, due date, work type, assignee or links. Only the fields you fill in change.

Inputs

Task IDtask_idtextRequired
The task's id, from 'List tasks' or an earlier step.
Titletitletext
A new title.
Due datedue_ondate
A new due date.
Work typework_type_idtext
A new work type.
Descriptiondescriptiontext
Details about the task.
Assign toassignee_idtext
The Teamleader user to give the task to. Leave empty to leave it unassigned.
Estimated minutesestimated_minutesnumber
How long the task should take, in minutes.At least 1.
Deal IDdeal_idtext
The deal the task belongs to, from 'List deals' or an earlier step.
Customer typecustomer_typetext
Whether the customer is a company or a contact.One of: company, contact.
Customer IDcustomer_idtext
The customer's id, from 'List companies', 'List contacts' or an earlier step.

Outputs

taskobject
The task as it is now
Example output
{
  "task": {
    "assignee": {},
    "completed": true,
    "completed_at": "example",
    "customer": {},
    "deal": {},
    "description": "example",
    "due_on": "example",
    "estimated_duration": {},
    "id": "9d4096c3-813f-4bd5-b3c4-4091807b5b74",
    "priority": "example",
    "title": "example",
    "work_type": {}
  }
}

On this page