De Teamleader V1 API documentatie is te vinden op archive.org.
De oorspronkelijke documentatie van de Teamleader V1 API is door Teamleader offline gehaald.
Merk op dat waar hier gesproken wordt over Teamleader, dit product inmiddels ook bekend staat als “Teamleader Focus”. De producten zijn identiek aan elkaar; uitsluitend de naam is gewijzigd. De API-koppeling is identiek en alle bestaande Invantive software en scripts zijn ongewijzigd blijven werken.
Historie
De Teamleader V1 API is formeel sinds 31 december 2018 beëindigd. Het advies is om integraties en downloads om te zetten naar de nieuwe V2 API. Echter, zoals zoveel gerijpte API’s is hij praktisch nog steeds beschikbaar en biedt bovendien informatie in de JSON die nog niet via de V2 API te vinden is.
Andere Bronnen voor Documentatie
Naast de online documentatie van de Teamleader V1 API zijn de API V1 velden ook te vinden in de Invantive SQL documentatie onder het schema V1 in het Teamleader API V1 datamodel.
Eventueel later toegevoegde velden in de V1 API zijn ook te analyseren door de instructies te volgen op Collect Native Platform Call Data. Praktisch gezegd kun je hiermee de JSON die de Teamleader API teruggeeft op een request op schijf vastleggen en geautomatiseerd of handmatig analyseren.
Omzetten Teamleader API V1 naar V2
Voor een aantal tabellen bestaan er in V1 en V2 vergelijkbare tabellen. Meestal zijn ze aan de Engelstalige naam te herkennen. Zo is er Teamleader.V1.Projects en Teamleader.V2.Projects.
Een wezenlijk verschil tussen V1 en de nieuwe V2 API-koppeling is de overstap qua nummering van rijen. V1 gebruikt getallen en V2 gebruikt GUID’s. Het gebruik van een brugstaat voor het koppelen van de getallen en GUID’s is beschreven in Relate Teamleader V1 with V2 rows (Teamleader Focus).
Huidig Teamleader API V1 versus V2 Gebruik
Een analyse over het Teamleader V1 versus V2 API gebruik over juni 2021 door Invantive SQL gebruikers (meestal voor rapportage in Power BI) laat het volgende verloop zien qua relatieve aantallen API-calls voor de twee versies van de API-koppeling:
| V1 (%) | V2 (%) |
|---|---|
| 92 | 8 |
Bij analyse van het gebruik door gebruikers die de afgelopen drie maanden Invantive in gebruik hebben genomen, dan is de verhouding anders:
| V1 (%) | V2 (%) |
|---|---|
| 34 | 66 |
Het omzetten van oude rapportages en interfaces van V1 naar de nieuwe API lijkt niet echt van de grond te komen. Hopelijk breidt Teamleader de Teamleader V2 API verder uit met de velden die wel in de V1 API zitten, maar niet in de V2, en combineren ze dat met nieuwe optimalisatise qua verwerkingssnelheid op V2.
Top-20 o.b.v. API-calls
De top-20 meest gebruikte Teamleader API tabellen met transacties op basis van aantallen API-calls voor transacties zijn:
| Naam | API-calls van Totaal (%) |
|---|---|
| Teamleader.V1.task | 11 |
| Teamleader.V1.ticket | 9 |
| Teamleader.V1.ticket_messages | 9 |
| Teamleader.V1.company | 8 |
| Teamleader.V1.ticket_custom_field_values_by_id | 6 |
| Teamleader.V1.meeting_custom_field_values_by_id | 6 |
| Teamleader.V1.contact | 5 |
| Teamleader.V1.timetracking_entry | 4 |
| Teamleader.V1.invoice_items | 4 |
| Teamleader.V1.deal | 4 |
| Teamleader.V1.timetracking_for_invoice | 3 |
| Teamleader.V1.contact_departement | 3 |
| Teamleader.V2.InvoiceLinesById | 3 |
| Teamleader.V1.deal_items | 2 |
| Teamleader.V1.project_custom_field_values_by_id | 2 |
| Teamleader.V1.contacts_by_company | 2 |
| Teamleader.V1.deals_by_project | 2 |
| Teamleader.V1.meeting_attending_internal | 2 |
| Teamleader.V1.deal_phase_changes | 1 |
| Teamleader.V1.project | 1 |
Merk hierbij op dat vooral de Teamleader V1 API als onhebbelijkheid heeft dat een puntquery per rij nodig is om vrij basale data op te halen. Het gebruik van de Teamleader API voor grotere organisaties vereist daarom meestal extra voorbereiding en is soms niet vruchtbaar. De Teamleader V2 API wordt net zoals de V1 API beperkt in zijn verwerkingssnelheid door de noodzaak van puntqueries, maar in mindere mate.
De top-20 meest gebruikte Teamleader API tabellen met seeded data op basis van aantallen API-calls voor seeded data zijn:
| Naam | API-calls van Totaal (%) |
|---|---|
| Teamleader.V2.CustomFieldsByCompanyId | 18 |
| Teamleader.V1.product | 14 |
| Teamleader.V1.custom_field_options | 7 |
| Teamleader.V1.custom_fields | 6 |
| Teamleader.V2.CustomFieldsByTaskId | 5 |
| Teamleader.V2.CustomFieldsByProjectId | 4 |
| Teamleader.V2.CustomFieldsByContactId | 3 |
| Teamleader.V2.CustomFieldsByDealId | 3 |
| Teamleader.V2.CustomFieldsByInvoiceId | 2 |
| Teamleader.V1.project_projecttype | 2 |
| Teamleader.V1.product_suppliers | 2 |
| Teamleader.V2.CustomFieldsByMilestoneId | 2 |
| Teamleader.V2.Products | 1 |
| Teamleader.V1.product_prices | 1 |
| Teamleader.V2.ProductById | 1 |
| Teamleader.V2.CustomFieldDefinitions | 0 |
| Teamleader.V2.CustomFieldsByProductId | 0 |
| Teamleader.V2.BusinessTypes | 0 |
| Teamleader.V1.products | 0 |
| Teamleader.V2.Me | 0 |
Top-20 o.b.v. Gebruikerspopulatie
De top-20 meest gebruikte Teamleader API tabellen met transacties op basis van gebruikerspopulatie zijn:
| Naam | Gebruikerspopulatie (%) |
|---|---|
| Teamleader.V1.projects | 66 |
| Teamleader.V1.companies | 63 |
| Teamleader.V1.deals | 59 |
| Teamleader.V2.Deals | 50 |
| Teamleader.V1.project | 41 |
| Teamleader.V1.contacts | 41 |
| Teamleader.V2.Projects | 41 |
| Teamleader.V1.deal | 34 |
| Teamleader.V1.timetracking_entries | 34 |
| Teamleader.V2.Invoices | 34 |
| Teamleader.V1.company | 31 |
| Teamleader.V2.Companies | 31 |
| Teamleader.V1.meetings | 31 |
| Teamleader.V1.deal_items | 28 |
| Teamleader.V2.TimeTracking | 28 |
| Teamleader.V2.MigrateId | 28 |
| Teamleader.V1.milestones_by_project | 28 |
| Teamleader.V1.subscriptions | 28 |
| Teamleader.V1.tasks | 25 |
| Teamleader.V1.invoices | 25 |
De top-20 meest gebruikte Teamleader API tabellen met seeded data op basis van gebruikerspopulatie zijn:
| Naam | Gebruikerspopulatie (%) |
|---|---|
| Teamleader.V1.custom_fields | 100 |
| Teamleader.V2.CustomFieldDefinitions | 63 |
| Teamleader.V1.custom_field_options | 59 |
| Teamleader.V2.Users | 44 |
| Teamleader.V1.deal_phases | 41 |
| Teamleader.V1.users | 38 |
| Teamleader.V2.DealPhases | 31 |
| Teamleader.V1.products | 28 |
| Teamleader.V2.Me | 25 |
| Teamleader.V2.Products | 22 |
| Teamleader.V2.Departments | 19 |
| Teamleader.V2.WorkTypes | 19 |
| Teamleader.V2.DealSources | 19 |
| Teamleader.V2.ActivityTypes | 19 |
| Teamleader.V1.deal_sources | 19 |
| Teamleader.V2.CustomFieldsByProjectId | 16 |
| Teamleader.V1.teams | 16 |
| Teamleader.V1.task_types | 16 |
| Teamleader.V2.CustomFieldsByCompanyId | 13 |
| Teamleader.V2.CustomFieldsByDealId | 13 |