@teamleader/focus-api-specification 1.86.0 → 1.88.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -3,7 +3,7 @@ info:
|
|
|
3
3
|
title: Teamleader API
|
|
4
4
|
description: This is the documentation of the Teamleader Focus API. If you have any feedback, or are you missing functionality to support your use case? Let us know via [api@teamleader.eu](mailto:api@teamleader.eu).
|
|
5
5
|
contact: {}
|
|
6
|
-
version: 1.
|
|
6
|
+
version: 1.88.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -3203,6 +3203,9 @@ paths:
|
|
|
3203
3203
|
- active
|
|
3204
3204
|
- deactivated
|
|
3205
3205
|
example: active
|
|
3206
|
+
marketing_mails_consent:
|
|
3207
|
+
type: boolean
|
|
3208
|
+
example: false
|
|
3206
3209
|
page:
|
|
3207
3210
|
title: Page
|
|
3208
3211
|
type: object
|
|
@@ -3226,7 +3229,7 @@ paths:
|
|
|
3226
3229
|
includes:
|
|
3227
3230
|
type: string
|
|
3228
3231
|
description: Comma-separated list of optional includes
|
|
3229
|
-
example: custom_fields
|
|
3232
|
+
example: custom_fields,price_list
|
|
3230
3233
|
- example:
|
|
3231
3234
|
filter:
|
|
3232
3235
|
email:
|
|
@@ -3247,7 +3250,7 @@ paths:
|
|
|
3247
3250
|
number: 1
|
|
3248
3251
|
sort:
|
|
3249
3252
|
- field: added_at
|
|
3250
|
-
includes: custom_fields
|
|
3253
|
+
includes: custom_fields,price_list
|
|
3251
3254
|
example:
|
|
3252
3255
|
filter:
|
|
3253
3256
|
email:
|
|
@@ -3263,12 +3266,13 @@ paths:
|
|
|
3263
3266
|
- expo
|
|
3264
3267
|
- prospect
|
|
3265
3268
|
status: active
|
|
3269
|
+
marketing_mails_consent: true
|
|
3266
3270
|
page:
|
|
3267
3271
|
size: 20
|
|
3268
3272
|
number: 1
|
|
3269
3273
|
sort:
|
|
3270
3274
|
- field: added_at
|
|
3271
|
-
includes: custom_fields
|
|
3275
|
+
includes: custom_fields,price_list
|
|
3272
3276
|
required: true
|
|
3273
3277
|
responses:
|
|
3274
3278
|
'200':
|
|
@@ -3398,6 +3402,9 @@ paths:
|
|
|
3398
3402
|
web_url:
|
|
3399
3403
|
type: string
|
|
3400
3404
|
example: https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
3405
|
+
marketing_mails_consent:
|
|
3406
|
+
type: boolean
|
|
3407
|
+
example: false
|
|
3401
3408
|
custom_fields:
|
|
3402
3409
|
type: array
|
|
3403
3410
|
items:
|
|
@@ -3449,6 +3456,16 @@ paths:
|
|
|
3449
3456
|
- user
|
|
3450
3457
|
example: company
|
|
3451
3458
|
description: Only included with request parameter `includes=custom_fields`
|
|
3459
|
+
price_list:
|
|
3460
|
+
type: object
|
|
3461
|
+
properties:
|
|
3462
|
+
type:
|
|
3463
|
+
type: string
|
|
3464
|
+
example: priceList
|
|
3465
|
+
id:
|
|
3466
|
+
type: string
|
|
3467
|
+
example: 27261187-19c9-081f-b833-021fa5873129
|
|
3468
|
+
description: Only included with request parameter `includes=price_list`
|
|
3452
3469
|
description: ''
|
|
3453
3470
|
- example:
|
|
3454
3471
|
data:
|
|
@@ -3485,6 +3502,7 @@ paths:
|
|
|
3485
3502
|
tags:
|
|
3486
3503
|
- prospect
|
|
3487
3504
|
- expo
|
|
3505
|
+
marketing_mails_consent: false
|
|
3488
3506
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
3489
3507
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
3490
3508
|
web_url: https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
@@ -3493,6 +3511,9 @@ paths:
|
|
|
3493
3511
|
type: customFieldDefinition
|
|
3494
3512
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
3495
3513
|
value: '092980616'
|
|
3514
|
+
price_list:
|
|
3515
|
+
type: priceList
|
|
3516
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
3496
3517
|
example:
|
|
3497
3518
|
data:
|
|
3498
3519
|
- id: 2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
@@ -3528,6 +3549,7 @@ paths:
|
|
|
3528
3549
|
tags:
|
|
3529
3550
|
- prospect
|
|
3530
3551
|
- expo
|
|
3552
|
+
marketing_mails_consent: false
|
|
3531
3553
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
3532
3554
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
3533
3555
|
web_url: https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
@@ -3536,6 +3558,9 @@ paths:
|
|
|
3536
3558
|
type: customFieldDefinition
|
|
3537
3559
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
3538
3560
|
value: '092980616'
|
|
3561
|
+
price_list:
|
|
3562
|
+
type: priceList
|
|
3563
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
3539
3564
|
deprecated: false
|
|
3540
3565
|
/contacts.info:
|
|
3541
3566
|
post:
|
|
@@ -4669,6 +4694,9 @@ paths:
|
|
|
4669
4694
|
- active
|
|
4670
4695
|
- deactivated
|
|
4671
4696
|
example: active
|
|
4697
|
+
marketing_mails_consent:
|
|
4698
|
+
type: boolean
|
|
4699
|
+
example: false
|
|
4672
4700
|
page:
|
|
4673
4701
|
title: Page
|
|
4674
4702
|
type: object
|
|
@@ -4691,7 +4719,7 @@ paths:
|
|
|
4691
4719
|
includes:
|
|
4692
4720
|
type: string
|
|
4693
4721
|
description: Comma-separated list of optional includes
|
|
4694
|
-
example: custom_fields
|
|
4722
|
+
example: custom_fields,price_list
|
|
4695
4723
|
- example:
|
|
4696
4724
|
filter:
|
|
4697
4725
|
email:
|
|
@@ -4713,7 +4741,7 @@ paths:
|
|
|
4713
4741
|
number: 1
|
|
4714
4742
|
sort:
|
|
4715
4743
|
- field: name
|
|
4716
|
-
includes: custom_fields
|
|
4744
|
+
includes: custom_fields,price_list
|
|
4717
4745
|
example:
|
|
4718
4746
|
filter:
|
|
4719
4747
|
email:
|
|
@@ -4730,12 +4758,13 @@ paths:
|
|
|
4730
4758
|
vat_number: BE 0899.623.035
|
|
4731
4759
|
national_identification_number: '63326426'
|
|
4732
4760
|
status: active
|
|
4761
|
+
marketing_mails_consent: true
|
|
4733
4762
|
page:
|
|
4734
4763
|
size: 20
|
|
4735
4764
|
number: 1
|
|
4736
4765
|
sort:
|
|
4737
4766
|
- field: name
|
|
4738
|
-
includes: custom_fields
|
|
4767
|
+
includes: custom_fields,price_list
|
|
4739
4768
|
required: true
|
|
4740
4769
|
responses:
|
|
4741
4770
|
'200':
|
|
@@ -4864,6 +4893,9 @@ paths:
|
|
|
4864
4893
|
items:
|
|
4865
4894
|
type: string
|
|
4866
4895
|
description: ''
|
|
4896
|
+
marketing_mails_consent:
|
|
4897
|
+
type: boolean
|
|
4898
|
+
example: false
|
|
4867
4899
|
custom_fields:
|
|
4868
4900
|
type: array
|
|
4869
4901
|
items:
|
|
@@ -4871,6 +4903,16 @@ paths:
|
|
|
4871
4903
|
type: object
|
|
4872
4904
|
properties: *ref_21
|
|
4873
4905
|
description: Only included with request parameter `includes=custom_fields`
|
|
4906
|
+
price_list:
|
|
4907
|
+
type: object
|
|
4908
|
+
properties:
|
|
4909
|
+
type:
|
|
4910
|
+
type: string
|
|
4911
|
+
example: priceList
|
|
4912
|
+
id:
|
|
4913
|
+
type: string
|
|
4914
|
+
example: 27261187-19c9-081f-b833-021fa5873129
|
|
4915
|
+
description: Only included with request parameter `includes=price_list`
|
|
4874
4916
|
description: ''
|
|
4875
4917
|
- example:
|
|
4876
4918
|
data:
|
|
@@ -4908,6 +4950,7 @@ paths:
|
|
|
4908
4950
|
responsible_user:
|
|
4909
4951
|
type: user
|
|
4910
4952
|
id: 9b99d8f8-183b-4c7b-8354-9b98b47a192e
|
|
4953
|
+
marketing_mails_consent: false
|
|
4911
4954
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
4912
4955
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
4913
4956
|
web_url: https://focus.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e
|
|
@@ -4919,6 +4962,9 @@ paths:
|
|
|
4919
4962
|
type: customFieldDefinition
|
|
4920
4963
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
4921
4964
|
value: '092980616'
|
|
4965
|
+
price_list:
|
|
4966
|
+
type: priceList
|
|
4967
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
4922
4968
|
example:
|
|
4923
4969
|
data:
|
|
4924
4970
|
- id: 96a38bbf-24ed-4083-8a5c-20db92aa471e
|
|
@@ -4955,6 +5001,7 @@ paths:
|
|
|
4955
5001
|
responsible_user:
|
|
4956
5002
|
type: user
|
|
4957
5003
|
id: 9b99d8f8-183b-4c7b-8354-9b98b47a192e
|
|
5004
|
+
marketing_mails_consent: false
|
|
4958
5005
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
4959
5006
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
4960
5007
|
web_url: https://focus.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e
|
|
@@ -4966,6 +5013,9 @@ paths:
|
|
|
4966
5013
|
type: customFieldDefinition
|
|
4967
5014
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
4968
5015
|
value: '092980616'
|
|
5016
|
+
price_list:
|
|
5017
|
+
type: priceList
|
|
5018
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
4969
5019
|
deprecated: false
|
|
4970
5020
|
/companies.info:
|
|
4971
5021
|
post:
|
|
@@ -3,7 +3,7 @@ info:
|
|
|
3
3
|
title: Teamleader API
|
|
4
4
|
description: This is the documentation of the Teamleader Focus API. If you have any feedback, or are you missing functionality to support your use case? Let us know via [api@teamleader.eu](mailto:api@teamleader.eu).
|
|
5
5
|
contact: {}
|
|
6
|
-
version: 1.
|
|
6
|
+
version: 1.88.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -1714,7 +1714,7 @@ paths:
|
|
|
1714
1714
|
number: 1
|
|
1715
1715
|
sort:
|
|
1716
1716
|
- field: added_at
|
|
1717
|
-
includes: custom_fields
|
|
1717
|
+
includes: custom_fields,price_list
|
|
1718
1718
|
example:
|
|
1719
1719
|
filter:
|
|
1720
1720
|
email:
|
|
@@ -1730,12 +1730,13 @@ paths:
|
|
|
1730
1730
|
- expo
|
|
1731
1731
|
- prospect
|
|
1732
1732
|
status: active
|
|
1733
|
+
marketing_mails_consent: true
|
|
1733
1734
|
page:
|
|
1734
1735
|
size: 20
|
|
1735
1736
|
number: 1
|
|
1736
1737
|
sort:
|
|
1737
1738
|
- field: added_at
|
|
1738
|
-
includes: custom_fields
|
|
1739
|
+
includes: custom_fields,price_list
|
|
1739
1740
|
required: true
|
|
1740
1741
|
responses:
|
|
1741
1742
|
'200':
|
|
@@ -1781,6 +1782,7 @@ paths:
|
|
|
1781
1782
|
tags:
|
|
1782
1783
|
- prospect
|
|
1783
1784
|
- expo
|
|
1785
|
+
marketing_mails_consent: false
|
|
1784
1786
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
1785
1787
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
1786
1788
|
web_url: https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
@@ -1789,6 +1791,9 @@ paths:
|
|
|
1789
1791
|
type: customFieldDefinition
|
|
1790
1792
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
1791
1793
|
value: '092980616'
|
|
1794
|
+
price_list:
|
|
1795
|
+
type: priceList
|
|
1796
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
1792
1797
|
example:
|
|
1793
1798
|
data:
|
|
1794
1799
|
- id: 2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
@@ -1824,6 +1829,7 @@ paths:
|
|
|
1824
1829
|
tags:
|
|
1825
1830
|
- prospect
|
|
1826
1831
|
- expo
|
|
1832
|
+
marketing_mails_consent: false
|
|
1827
1833
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
1828
1834
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
1829
1835
|
web_url: https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
@@ -1832,6 +1838,9 @@ paths:
|
|
|
1832
1838
|
type: customFieldDefinition
|
|
1833
1839
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
1834
1840
|
value: '092980616'
|
|
1841
|
+
price_list:
|
|
1842
|
+
type: priceList
|
|
1843
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
1835
1844
|
deprecated: false
|
|
1836
1845
|
/contacts.info:
|
|
1837
1846
|
post:
|
|
@@ -2389,7 +2398,7 @@ paths:
|
|
|
2389
2398
|
number: 1
|
|
2390
2399
|
sort:
|
|
2391
2400
|
- field: name
|
|
2392
|
-
includes: custom_fields
|
|
2401
|
+
includes: custom_fields,price_list
|
|
2393
2402
|
example:
|
|
2394
2403
|
filter:
|
|
2395
2404
|
email:
|
|
@@ -2406,12 +2415,13 @@ paths:
|
|
|
2406
2415
|
vat_number: BE 0899.623.035
|
|
2407
2416
|
national_identification_number: '63326426'
|
|
2408
2417
|
status: active
|
|
2418
|
+
marketing_mails_consent: true
|
|
2409
2419
|
page:
|
|
2410
2420
|
size: 20
|
|
2411
2421
|
number: 1
|
|
2412
2422
|
sort:
|
|
2413
2423
|
- field: name
|
|
2414
|
-
includes: custom_fields
|
|
2424
|
+
includes: custom_fields,price_list
|
|
2415
2425
|
required: true
|
|
2416
2426
|
responses:
|
|
2417
2427
|
'200':
|
|
@@ -2458,6 +2468,7 @@ paths:
|
|
|
2458
2468
|
responsible_user:
|
|
2459
2469
|
type: user
|
|
2460
2470
|
id: 9b99d8f8-183b-4c7b-8354-9b98b47a192e
|
|
2471
|
+
marketing_mails_consent: false
|
|
2461
2472
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
2462
2473
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
2463
2474
|
web_url: https://focus.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e
|
|
@@ -2469,6 +2480,9 @@ paths:
|
|
|
2469
2480
|
type: customFieldDefinition
|
|
2470
2481
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
2471
2482
|
value: '092980616'
|
|
2483
|
+
price_list:
|
|
2484
|
+
type: priceList
|
|
2485
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
2472
2486
|
example:
|
|
2473
2487
|
data:
|
|
2474
2488
|
- id: 96a38bbf-24ed-4083-8a5c-20db92aa471e
|
|
@@ -2505,6 +2519,7 @@ paths:
|
|
|
2505
2519
|
responsible_user:
|
|
2506
2520
|
type: user
|
|
2507
2521
|
id: 9b99d8f8-183b-4c7b-8354-9b98b47a192e
|
|
2522
|
+
marketing_mails_consent: false
|
|
2508
2523
|
added_at: '2016-02-04T16:44:33+00:00'
|
|
2509
2524
|
updated_at: '2016-02-05T16:44:33+00:00'
|
|
2510
2525
|
web_url: https://focus.teamleader.eu/company_detail.php?id=96a38bbf-24ed-4083-8a5c-20db92aa471e
|
|
@@ -2516,6 +2531,9 @@ paths:
|
|
|
2516
2531
|
type: customFieldDefinition
|
|
2517
2532
|
id: bf6765de-56eb-40ec-ad14-9096c5dc5fe1
|
|
2518
2533
|
value: '092980616'
|
|
2534
|
+
price_list:
|
|
2535
|
+
type: priceList
|
|
2536
|
+
id: 5a37d173-78d3-05f3-b018-d51fadc1c5d2
|
|
2519
2537
|
deprecated: false
|
|
2520
2538
|
/companies.info:
|
|
2521
2539
|
post:
|
|
@@ -17945,6 +17963,9 @@ components:
|
|
|
17945
17963
|
- active
|
|
17946
17964
|
- deactivated
|
|
17947
17965
|
example: active
|
|
17966
|
+
marketing_mails_consent:
|
|
17967
|
+
type: boolean
|
|
17968
|
+
example: false
|
|
17948
17969
|
page:
|
|
17949
17970
|
$ref: '#/components/schemas/Page'
|
|
17950
17971
|
sort:
|
|
@@ -17963,7 +17984,7 @@ components:
|
|
|
17963
17984
|
includes:
|
|
17964
17985
|
type: string
|
|
17965
17986
|
description: Comma-separated list of optional includes
|
|
17966
|
-
example: custom_fields
|
|
17987
|
+
example: custom_fields,price_list
|
|
17967
17988
|
Gender:
|
|
17968
17989
|
title: Gender
|
|
17969
17990
|
type: string
|
|
@@ -18131,11 +18152,24 @@ components:
|
|
|
18131
18152
|
web_url:
|
|
18132
18153
|
type: string
|
|
18133
18154
|
example: https://focus.teamleader.eu/contact_detail.php?id=2a39e420-3ba3-4384-8024-fa702ef99c9f
|
|
18155
|
+
marketing_mails_consent:
|
|
18156
|
+
type: boolean
|
|
18157
|
+
example: false
|
|
18134
18158
|
custom_fields:
|
|
18135
18159
|
type: array
|
|
18136
18160
|
items:
|
|
18137
18161
|
$ref: '#/components/schemas/CustomFieldsResponse'
|
|
18138
18162
|
description: Only included with request parameter `includes=custom_fields`
|
|
18163
|
+
price_list:
|
|
18164
|
+
type: object
|
|
18165
|
+
properties:
|
|
18166
|
+
type:
|
|
18167
|
+
type: string
|
|
18168
|
+
example: priceList
|
|
18169
|
+
id:
|
|
18170
|
+
type: string
|
|
18171
|
+
example: 27261187-19c9-081f-b833-021fa5873129
|
|
18172
|
+
description: Only included with request parameter `includes=price_list`
|
|
18139
18173
|
description: ''
|
|
18140
18174
|
contacts.inforequest:
|
|
18141
18175
|
title: contacts.inforequest
|
|
@@ -18725,6 +18759,9 @@ components:
|
|
|
18725
18759
|
- active
|
|
18726
18760
|
- deactivated
|
|
18727
18761
|
example: active
|
|
18762
|
+
marketing_mails_consent:
|
|
18763
|
+
type: boolean
|
|
18764
|
+
example: false
|
|
18728
18765
|
page:
|
|
18729
18766
|
$ref: '#/components/schemas/Page'
|
|
18730
18767
|
sort:
|
|
@@ -18742,7 +18779,7 @@ components:
|
|
|
18742
18779
|
includes:
|
|
18743
18780
|
type: string
|
|
18744
18781
|
description: Comma-separated list of optional includes
|
|
18745
|
-
example: custom_fields
|
|
18782
|
+
example: custom_fields,price_list
|
|
18746
18783
|
CompanyTelephone:
|
|
18747
18784
|
title: CompanyTelephone
|
|
18748
18785
|
required:
|
|
@@ -18853,11 +18890,24 @@ components:
|
|
|
18853
18890
|
items:
|
|
18854
18891
|
type: string
|
|
18855
18892
|
description: ''
|
|
18893
|
+
marketing_mails_consent:
|
|
18894
|
+
type: boolean
|
|
18895
|
+
example: false
|
|
18856
18896
|
custom_fields:
|
|
18857
18897
|
type: array
|
|
18858
18898
|
items:
|
|
18859
18899
|
$ref: '#/components/schemas/CustomFieldsResponse'
|
|
18860
18900
|
description: Only included with request parameter `includes=custom_fields`
|
|
18901
|
+
price_list:
|
|
18902
|
+
type: object
|
|
18903
|
+
properties:
|
|
18904
|
+
type:
|
|
18905
|
+
type: string
|
|
18906
|
+
example: priceList
|
|
18907
|
+
id:
|
|
18908
|
+
type: string
|
|
18909
|
+
example: 27261187-19c9-081f-b833-021fa5873129
|
|
18910
|
+
description: Only included with request parameter `includes=price_list`
|
|
18861
18911
|
description: ''
|
|
18862
18912
|
companies.inforequest:
|
|
18863
18913
|
title: companies.inforequest
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@teamleader/focus-api-specification",
|
|
3
3
|
"description": "Teamleader Focus API Specification",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.88.0",
|
|
5
5
|
"author": "Teamleader <development@teamleader.eu> (https://www.teamleader.eu)",
|
|
6
6
|
"bugs": {
|
|
7
7
|
"url": "https://github.com/teamleadercrm/focus-api-specification/issues"
|