Getting startedGeneralCRMDealsInvoicesSubscriptionsProductsTicketsTimetracking & TasksCallsMeetingsPlanningProjectsExternal costsNotesFilesUsers & TeamsCustom Fields

Teamleader General API

This document assumes you have your API key and know how to perform a POST request (see Getting started)

This part of the api allows you to fetch users, departments, tags and segments from Teamleader.

General API overview

Getting all users

API endpoint: https://app.teamleader.eu/api/getUsers.php

Required POST parameters

  • none

Optional POST parameters

  • show_inactive_users: 0/1 If this flag is set to 1, Teamleader will return also return inactive users

Sample output

Example output: JSON array containing ID's and real names of all users.

Getting all departments

API endpoint: https://app.teamleader.eu/api/getDepartments.php

Required POST parameters

  • none

Sample output

Example output: JSON array containing ID's and names of all departments in your account.

Getting all tags

API endpoint: https://app.teamleader.eu/api/getTags.php

Required POST parameters

  • none

Sample output

Example output: JSON array containing ID's and names of all tags in your account.

Getting segments

API endpoint: https://app.teamleader.eu/api/getSegments.php

Required POST parameters

  • object_type string: pick one option: crm_companies, crm_contacts, crm_todos, crm_callbacks, crm_meetings, inv_invoices, inv_creditnotes, pro_projects, sale_sales or ticket_tickets

Sample output

Example output: JSON array containing ID's and names of relevant segments in your account.