Getting startedGeneralCRMDealsInvoicesSubscriptionsProductsTicketsTimetracking & TasksCallsMeetingsPlanningProjectsExternal costsNotesFilesUsers & TeamsCustom Fields

Teamleader Custom Fields 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 manage notes from Teamleader objects.

Notes API overview

Getting all custom fields for one object type

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

Required POST parameters

  • for: string: contact, company, sale, project, invoice, ticket, milestone, todo, meeting

Sample output

Example output: JSON array containing the ID, name and type of each custom field for this
type of object.

Getting detailed custom field info

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

Required POST parameters

  • custom_field_id : integer: ID of the custom field

Sample output

Example output: JSON array containing information about this custom field including the name and tpe.
If the custom field is a set or enum type all possible options will be passed in the 'options' value as an array.

Adding options to a custom field (for set and enum type custom fields)

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

Required POST parameters

  • custom_field_id : integer: ID of the custom field
  • option_name : string: name of the option

Sample output

Example output: ID of the new option that was added to the possible values of the custom field.