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
| Action | What it does |
|---|---|
| Add tags to contact | Put tags on a contact, creating any that do not exist. |
| Cancel calendar event | Cancel a calendar event for all attendees. |
| Complete task | Mark a task as done. |
| Create calendar event | Create a calendar event with a start and end, linked to a company, contact or deal, optionally with attendees. |
| Create company | Add a company. |
| Create contact | Add a contact. |
| Create deal | Create a deal for a company or contact, optionally in a given phase, with a value, probability and closing date. |
| 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. |
| Delete company | Delete a company. |
| Delete contact | Delete a contact. |
| Delete deal | Delete a deal. |
| Delete task | Delete a task. |
| Get company | Get one company with its e-mail addresses, phone numbers, addresses, tags and responsible user. |
| Get contact | Get one contact with their e-mail addresses, phone numbers, addresses, tags and linked companies. |
| Get current user | Get the Teamleader Focus user the connection acts as: name, e-mail, function, language and time zone. |
| Get deal | Get one deal with its customer, value, phase, owner and source. |
| Link contact to company | Link a contact to a company, with their position there. |
| List activity types | List the activity types set up in Teamleader, such as meeting or call. |
| List calendar events | List calendar events, filtering by attendee, activity type or time. |
| List companies | List companies, searching by name, VAT number, e-mail or phone, or filtering by tags, status or last update. |
| List contacts | List contacts, searching by name, e-mail or phone, or filtering by company, tags, status or last update. |
| List deal phases | List the phases deals go through, in order, optionally only those of one pipeline. |
| List deals | List deals, searching by title or customer, or filtering by state, pipeline, phase, owner, closing date or last activity. |
| List tasks | List tasks, filtering by assignee, done or open, due date or customer. |
| List work types | List the work types set up in Teamleader. |
| Mark deal as lost | Mark a deal as lost, with the reason. |
| Mark deal as won | Mark a deal as won. |
| Move deal to phase | Move a deal to another phase of its pipeline. |
| Remove tags from contact | Take tags off a contact. |
| Update company | Change a company's details. |
| Update contact | Change a contact's details. |
| Update deal | Change a deal's title, summary, value, probability, closing date, owner, department or source. |
| Update task | Change 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 ID
contact_idtextRequired - The contact's id, from 'List contacts' or an earlier step.
- Tags
tagslistRequired - 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 ID
event_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 ID
task_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
- Title
titletextRequired - The event's title.
- Activity type
activity_type_idtextRequired - The kind of event, as set up in Teamleader.
- Start
starts_atdate and timeRequired - When the event starts.
- End
ends_atdate and timeRequired - When the event ends.
- Description
descriptiontext - Details about the event.
- Location
locationtext - Where the event takes place. Teamleader only accepts it when the activity type is a meeting.
- Work type
work_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.
- Attendees
attendee_user_idslist - The Teamleader users who attend.
- Link to
link_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 ID
link_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
- Name
nametextRequired - The company's name.
- VAT number
vat_numbertext - The company's VAT number.
- E-mail
emailtext - The primary e-mail address. It replaces the company's e-mail addresses.
- Phone
phonetext - A phone number. It replaces the company's phone numbers.
- Website
websitetext - The company's website.
- Language
languagetext - 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 user
responsible_user_idtext - The Teamleader user who looks after the company.
- Preferred currency
preferred_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. - Remarks
remarkstext - Background information, as Markdown.
- Allow marketing e-mails
marketing_mails_consenttrue/false - Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
- Street and number
address_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 code
postal_codetext - The primary address' postal code.
- City
citytext - The primary address' city.
- Country code
countrytext - The two-letter country code, such as BE or NL.
- Tags
tagslist - 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 name
last_nametextRequired - The contact's last name.
- First name
first_nametext - The contact's first name.
- E-mail
emailtext - The primary e-mail address. It replaces the contact's e-mail addresses.
- Phone
phonetext - A phone number. Setting a phone or mobile number replaces the contact's phone numbers.
- Mobile
mobiletext - A mobile number. Setting a phone or mobile number replaces the contact's phone numbers.
- Website
websitetext - The contact's website.
- Salutation
salutationtext - How to address them, such as Mr or Ms.
- Gender
gendertext - The contact's gender.One of:
female,male,non_binary(Non-binary),prefers_not_to_say(Prefers not to say),unknown. - Language
languagetext - 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. - Birthdate
birthdatedate - Their date of birth.
- Remarks
remarkstext - Background information, as Markdown.
- Allow marketing e-mails
marketing_mails_consenttrue/false - Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
- Street and number
address_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 code
postal_codetext - The primary address' postal code.
- City
citytext - The primary address' city.
- Country code
countrytext - The two-letter country code, such as BE or NL.
- Tags
tagslist - 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
- Title
titletextRequired - The deal's title.
- Customer type
customer_typetextRequired - Whether the customer is a company or a contact.One of:
company,contact. - Customer ID
customer_idtextRequired - The customer's id, from 'List companies', 'List contacts' or an earlier step.
- Contact person ID
contact_person_idtext - The contact at the customer to deal with, from 'List contacts' or an earlier step.
- Phase
phase_idtext - The phase to start in. Defaults to the first phase of the default pipeline.
- Summary
summarytext - Remarks about the deal.
- Source
source_idtext - Where the deal came from.
- Department
department_idtext - The department the deal belongs to.
- Responsible user
responsible_user_idtext - The Teamleader user who owns the deal.
- Estimated value
estimated_valuenumber - The expected amount of the deal.
- Currency
currencytext - 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 date
closing_datedate - When the deal is expected to close.
- Purchase order number
purchase_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
- Title
titletextRequired - The task's title.
- Due date
due_ondateRequired - When the task is due.
- Work type
work_type_idtextRequired - The kind of work, as set up in Teamleader.
- Description
descriptiontext - Details about the task.
- Assign to
assignee_idtext - The Teamleader user to give the task to. Leave empty to leave it unassigned.
- Estimated minutes
estimated_minutesnumber - How long the task should take, in minutes.At least 1.
- Deal ID
deal_idtext - The deal the task belongs to, from 'List deals' or an earlier step.
- Customer type
customer_typetext - Whether the customer is a company or a contact.One of:
company,contact. - Customer ID
customer_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 ID
company_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 ID
contact_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 ID
deal_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 ID
task_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 ID
company_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 ID
contact_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 ID
deal_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 contact to company
Link a contact to a company, with their position there.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'List contacts' or an earlier step.
- Company ID
company_idtextRequired - The company's id, from 'List companies' or an earlier step.
- Position
positiontext - Their job title at the company.
- Decision maker
decision_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
- Search
termtext - Matches the title and description.
- Attendee
attendee_user_idtext - Only events this user is part of.
- Activity type
activity_type_idtext - Only events of this type.
- From
starts_fromdate and time - Only events that end after this date and time.
- Until
starts_untildate and time - Only events that start before this date and time.
- Order
sort_ordertext - Order by start time. Defaults to Teamleader's own order.One of:
asc(Ascending),desc(Descending). - Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page number
page_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
- Search
termtext - Matches name, VAT number, e-mail and phone number.
- E-mail
emailtext - Only the company with this primary e-mail address.
- VAT number
vat_numbertext - Only the company with this VAT number.
- Tags
tagslist - Only those that have all of these tags.
- Status
statustext - Only active or only deactivated ones.One of:
active,deactivated. - Updated since
updated_sincedate and time - Only those changed on or after this date and time.
- Sort by
sort_bytext - What to order the results by.One of:
added_at(Date added),updated_at(Last updated),name. - Order
sort_ordertext - Ascending or descending. Defaults to ascending when 'Sort by' is set.One of:
asc(Ascending),desc(Descending). - Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page number
page_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
- Search
termtext - Matches first name, last name, e-mail and phone number.
- E-mail
emailtext - Only the contact with this primary e-mail address.
- Company ID
company_idtext - Only contacts linked to this company, from 'List companies' or an earlier step.
- Tags
tagslist - Only those that have all of these tags.
- Status
statustext - Only active or only deactivated ones.One of:
active,deactivated. - Updated since
updated_sincedate and time - Only those changed on or after this date and time.
- Sort by
sort_bytext - What to order the results by.One of:
added_at(Date added),updated_at(Last updated),name. - Order
sort_ordertext - Ascending or descending. Defaults to ascending when 'Sort by' is set.One of:
asc(Ascending),desc(Descending). - Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page number
page_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
- Pipeline
pipeline_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
- Search
termtext - Matches the title, reference and the customer's name.
- Status
statuseslist - Only deals in these states.One or more of:
open,won,lost. - Pipeline
pipeline_idtext - Only deals in this pipeline.
- Phase
phase_idtext - Only deals in this phase.
- Responsible user
responsible_user_idtext - Only deals owned by this user.
- Closing on or after
closing_fromdate - Only deals expected to close on or after this date.
- Closing on or before
closing_untildate - Only deals expected to close on or before this date.
- Updated since
updated_sincedate and time - Only deals with activity on or after this date and time.
- Sort by
sort_bytext - What to order the results by.One of:
created_at(Date created),weighted_value(Weighted value). - Order
sort_ordertext - Ascending or descending. Defaults to ascending when 'Sort by' is set.One of:
asc(Ascending),desc(Descending). - Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page number
page_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
- Search
termtext - Matches the task's description.
- Assigned to
assigned_totext - Only tasks for this user or a team they are in.
- Done or not
statetext - Only open tasks or only completed ones. Leave empty for both.One of:
open(Open tasks),completed(Completed tasks). - Due on or after
due_fromdate - Only tasks due from this date.
- Due on or before
due_bydate - Only tasks due by this date.
- Customer type
customer_typetext - Whether the customer is a company or a contact.One of:
company,contact. - Customer ID
customer_idtext - The customer's id, from 'List companies', 'List contacts' or an earlier step.
- Sort by
sort_bytext - What to order the results by.One of:
due_on(Due date),created_at(Date created). - Order
sort_ordertext - Ascending or descending. Defaults to ascending when 'Sort by' is set.One of:
asc(Ascending),desc(Descending). - Page size
page_sizenumber - How many to return, 1 to 100. Defaults to 20.From 1 to 100.
- Page number
page_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 ID
deal_idtextRequired - The deal's id, from 'List deals' or an earlier step.
- Lost reason
reason_idtext - Why the deal was lost.
- Extra information
extra_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 ID
deal_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 ID
deal_idtextRequired - The deal's id, from 'List deals' or an earlier step.
- Phase
phase_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 ID
contact_idtextRequired - The contact's id, from 'List contacts' or an earlier step.
- Tags
tagslistRequired - 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 ID
company_idtextRequired - The company's id, from 'List companies' or an earlier step.
- Name
nametext - A new name.
- VAT number
vat_numbertext - The company's VAT number.
- E-mail
emailtext - The primary e-mail address. It replaces the company's e-mail addresses.
- Phone
phonetext - A phone number. It replaces the company's phone numbers.
- Website
websitetext - The company's website.
- Language
languagetext - 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 user
responsible_user_idtext - The Teamleader user who looks after the company.
- Preferred currency
preferred_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. - Remarks
remarkstext - Background information, as Markdown.
- Allow marketing e-mails
marketing_mails_consenttrue/false - Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
- Street and number
address_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 code
postal_codetext - The primary address' postal code.
- City
citytext - The primary address' city.
- Country code
countrytext - 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 ID
contact_idtextRequired - The contact's id, from 'List contacts' or an earlier step.
- Last name
last_nametext - A new last name.
- First name
first_nametext - The contact's first name.
- E-mail
emailtext - The primary e-mail address. It replaces the contact's e-mail addresses.
- Phone
phonetext - A phone number. Setting a phone or mobile number replaces the contact's phone numbers.
- Mobile
mobiletext - A mobile number. Setting a phone or mobile number replaces the contact's phone numbers.
- Website
websitetext - The contact's website.
- Salutation
salutationtext - How to address them, such as Mr or Ms.
- Gender
gendertext - The contact's gender.One of:
female,male,non_binary(Non-binary),prefers_not_to_say(Prefers not to say),unknown. - Language
languagetext - 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. - Birthdate
birthdatedate - Their date of birth.
- Remarks
remarkstext - Background information, as Markdown.
- Allow marketing e-mails
marketing_mails_consenttrue/false - Whether Teamleader may send marketing e-mails to them. Leave unset to keep it as it is.
- Street and number
address_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 code
postal_codetext - The primary address' postal code.
- City
citytext - The primary address' city.
- Country code
countrytext - 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 ID
deal_idtextRequired - The deal's id, from 'List deals' or an earlier step.
- Title
titletext - A new title.
- Summary
summarytext - Remarks about the deal.
- Source
source_idtext - Where the deal came from.
- Department
department_idtext - The department the deal belongs to.
- Responsible user
responsible_user_idtext - The Teamleader user who owns the deal.
- Estimated value
estimated_valuenumber - The expected amount of the deal.
- Currency
currencytext - 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 date
closing_datedate - When the deal is expected to close.
- Purchase order number
purchase_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 ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
- Title
titletext - A new title.
- Due date
due_ondate - A new due date.
- Work type
work_type_idtext - A new work type.
- Description
descriptiontext - Details about the task.
- Assign to
assignee_idtext - The Teamleader user to give the task to. Leave empty to leave it unassigned.
- Estimated minutes
estimated_minutesnumber - How long the task should take, in minutes.At least 1.
- Deal ID
deal_idtext - The deal the task belongs to, from 'List deals' or an earlier step.
- Customer type
customer_typetext - Whether the customer is a company or a contact.One of:
company,contact. - Customer ID
customer_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": {}
}
}