@teamleader/focus-api-specification 1.98.0 → 1.99.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.99.0
|
|
7
7
|
servers:
|
|
8
8
|
- url: https://api.focus.teamleader.eu
|
|
9
9
|
variables: {}
|
|
@@ -832,6 +832,51 @@ paths:
|
|
|
832
832
|
- type: user
|
|
833
833
|
id: bef8c53b-b6bc-0fde-944e-5c4b16e5155a
|
|
834
834
|
deprecated: false
|
|
835
|
+
/customFieldDefinitions.create:
|
|
836
|
+
post:
|
|
837
|
+
tags:
|
|
838
|
+
- custom_fields
|
|
839
|
+
summary: customFieldDefinitions.create
|
|
840
|
+
description: |
|
|
841
|
+
Create a custom field definition.
|
|
842
|
+
|
|
843
|
+
***Required scopes:*** `settings`
|
|
844
|
+
operationId: customFieldDefinitions.create
|
|
845
|
+
parameters: []
|
|
846
|
+
requestBody:
|
|
847
|
+
description: ''
|
|
848
|
+
content:
|
|
849
|
+
application/json:
|
|
850
|
+
schema:
|
|
851
|
+
allOf:
|
|
852
|
+
- $ref: '#/components/schemas/customFieldDefinitions.createrequest'
|
|
853
|
+
- example:
|
|
854
|
+
label: ''
|
|
855
|
+
type: single_line
|
|
856
|
+
context: contact
|
|
857
|
+
example:
|
|
858
|
+
label: ''
|
|
859
|
+
type: single_line
|
|
860
|
+
context: contact
|
|
861
|
+
required: true
|
|
862
|
+
responses:
|
|
863
|
+
'201':
|
|
864
|
+
description: ''
|
|
865
|
+
headers: {}
|
|
866
|
+
content:
|
|
867
|
+
application/json:
|
|
868
|
+
schema:
|
|
869
|
+
allOf:
|
|
870
|
+
- $ref: '#/components/schemas/customFieldDefinitions.createresponse'
|
|
871
|
+
- example:
|
|
872
|
+
data:
|
|
873
|
+
type: customFieldDefinition
|
|
874
|
+
id: 526960d3-8d49-4a71-9f62-7b8b74aef058
|
|
875
|
+
example:
|
|
876
|
+
data:
|
|
877
|
+
type: customFieldDefinition
|
|
878
|
+
id: 526960d3-8d49-4a71-9f62-7b8b74aef058
|
|
879
|
+
deprecated: false
|
|
835
880
|
/customFieldDefinitions.list:
|
|
836
881
|
post:
|
|
837
882
|
tags:
|
|
@@ -17231,6 +17276,26 @@ components:
|
|
|
17231
17276
|
- $ref: '#/components/schemas/TypeAndId'
|
|
17232
17277
|
description: ''
|
|
17233
17278
|
description: ''
|
|
17279
|
+
CustomFieldDefinitionType:
|
|
17280
|
+
type: string
|
|
17281
|
+
enum:
|
|
17282
|
+
- single_line
|
|
17283
|
+
- multi_line
|
|
17284
|
+
- single_select
|
|
17285
|
+
- multi_select
|
|
17286
|
+
- date
|
|
17287
|
+
- money
|
|
17288
|
+
- auto_increment
|
|
17289
|
+
- integer
|
|
17290
|
+
- number
|
|
17291
|
+
- boolean
|
|
17292
|
+
- email
|
|
17293
|
+
- telephone
|
|
17294
|
+
- url
|
|
17295
|
+
- company
|
|
17296
|
+
- contact
|
|
17297
|
+
- product
|
|
17298
|
+
- user
|
|
17234
17299
|
Context:
|
|
17235
17300
|
title: Context
|
|
17236
17301
|
enum:
|
|
@@ -17244,6 +17309,59 @@ components:
|
|
|
17244
17309
|
- subscription
|
|
17245
17310
|
- ticket
|
|
17246
17311
|
type: string
|
|
17312
|
+
customFieldDefinitions.createrequest:
|
|
17313
|
+
title: customFieldDefinitions.createrequest
|
|
17314
|
+
required:
|
|
17315
|
+
- label
|
|
17316
|
+
- type
|
|
17317
|
+
- context
|
|
17318
|
+
type: object
|
|
17319
|
+
properties:
|
|
17320
|
+
label:
|
|
17321
|
+
type: string
|
|
17322
|
+
type:
|
|
17323
|
+
allOf:
|
|
17324
|
+
- $ref: '#/components/schemas/CustomFieldDefinitionType'
|
|
17325
|
+
- example: single_line
|
|
17326
|
+
context:
|
|
17327
|
+
allOf:
|
|
17328
|
+
- $ref: '#/components/schemas/Context'
|
|
17329
|
+
- example: contact
|
|
17330
|
+
configuration:
|
|
17331
|
+
type: object
|
|
17332
|
+
description: |
|
|
17333
|
+
- Use `options` when `type` is one of [`single_select`, `multi_select`]
|
|
17334
|
+
- Use `default_value` when `type` is `auto_increment`
|
|
17335
|
+
- Use `searchable` when `type` is one of [`single_line`, `company`, `integer`, `number`, `auto_increment`, `email`, `telephone`]
|
|
17336
|
+
oneOf:
|
|
17337
|
+
- type: object
|
|
17338
|
+
title: options
|
|
17339
|
+
properties:
|
|
17340
|
+
options:
|
|
17341
|
+
type: array
|
|
17342
|
+
items:
|
|
17343
|
+
type: string
|
|
17344
|
+
- type: object
|
|
17345
|
+
title: default_value
|
|
17346
|
+
properties:
|
|
17347
|
+
default_value:
|
|
17348
|
+
type: number
|
|
17349
|
+
- type: object
|
|
17350
|
+
title: searchable
|
|
17351
|
+
properties:
|
|
17352
|
+
searchable:
|
|
17353
|
+
type: boolean
|
|
17354
|
+
customFieldDefinitions.createresponse:
|
|
17355
|
+
title: customFieldDefinitions.createresponse
|
|
17356
|
+
type: object
|
|
17357
|
+
properties:
|
|
17358
|
+
data:
|
|
17359
|
+
allOf:
|
|
17360
|
+
- $ref: '#/components/schemas/TypeAndId'
|
|
17361
|
+
- properties:
|
|
17362
|
+
type:
|
|
17363
|
+
type: string
|
|
17364
|
+
example: customFieldDefinition
|
|
17247
17365
|
customFieldDefinitions.listrequest:
|
|
17248
17366
|
title: customFieldDefinitions.listrequest
|
|
17249
17367
|
type: object
|
|
@@ -17291,25 +17409,7 @@ components:
|
|
|
17291
17409
|
- $ref: '#/components/schemas/Context'
|
|
17292
17410
|
- example: contact
|
|
17293
17411
|
type:
|
|
17294
|
-
|
|
17295
|
-
enum:
|
|
17296
|
-
- single_line
|
|
17297
|
-
- multi_line
|
|
17298
|
-
- single_select
|
|
17299
|
-
- multi_select
|
|
17300
|
-
- date
|
|
17301
|
-
- money
|
|
17302
|
-
- auto_increment
|
|
17303
|
-
- integer
|
|
17304
|
-
- number
|
|
17305
|
-
- boolean
|
|
17306
|
-
- email
|
|
17307
|
-
- telephone
|
|
17308
|
-
- url
|
|
17309
|
-
- company
|
|
17310
|
-
- contact
|
|
17311
|
-
- product
|
|
17312
|
-
- user
|
|
17412
|
+
$ref: '#/components/schemas/CustomFieldDefinitionType'
|
|
17313
17413
|
label:
|
|
17314
17414
|
type: string
|
|
17315
17415
|
group:
|
|
@@ -17360,25 +17460,7 @@ components:
|
|
|
17360
17460
|
- $ref: '#/components/schemas/Context'
|
|
17361
17461
|
- example: contact
|
|
17362
17462
|
type:
|
|
17363
|
-
|
|
17364
|
-
enum:
|
|
17365
|
-
- single_line
|
|
17366
|
-
- multi_line
|
|
17367
|
-
- single_select
|
|
17368
|
-
- multi_select
|
|
17369
|
-
- date
|
|
17370
|
-
- money
|
|
17371
|
-
- auto_increment
|
|
17372
|
-
- integer
|
|
17373
|
-
- number
|
|
17374
|
-
- boolean
|
|
17375
|
-
- email
|
|
17376
|
-
- telephone
|
|
17377
|
-
- url
|
|
17378
|
-
- company
|
|
17379
|
-
- contact
|
|
17380
|
-
- product
|
|
17381
|
-
- user
|
|
17463
|
+
$ref: '#/components/schemas/CustomFieldDefinitionType'
|
|
17382
17464
|
label:
|
|
17383
17465
|
type: string
|
|
17384
17466
|
group:
|
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.99.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"
|