-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathKarbonAPI.yml
8767 lines (8763 loc) · 455 KB
/
KarbonAPI.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.2
servers:
-
url: 'https://api.karbonhq.com'
description: The production API server
info:
description: >
This document covers Karbon API endpoints and data formats. You can find
additional developer resources at [Karbon Developer
Center](https://developers.karbonhq.com). <br><br><b>Please note the
following</b> <ul><li>Karbon's APIs use the OData standard to help with
resource searching. Use [OData's reference
guide](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/) to
learn more about OData URI conventions.</li> <li>PATCH operations are
limited to simple top-level properties and currently do not work on
nested objects.</li> <li>OData's <code>$expand</code> option is only
available where explicitly mentioned.</li> <li>If an endpoint allows you
to use multiple properties with the <code>$expand</code> option, you can
assign a comma-separated list of the properties to the
<code>$expand</code> option.</li> <li>Wherever <code>$orderby</code> option is explicitly
mentioned, you can also use allowed property name followed by space then
<code>desc</code> keyword to receive the response in descending
order.</li>
</ul>
<p><b style="color:red">Warning!!</b> - The examples shown below are for illustration purpose only. Attempting to call an API using the examples for
request payload might result in unusual behaviour because the Karbon generated values for various entities' keys may differ from the values in your tenant.</p>
<hr> <h2>Credentials for accessing Karbon APIs<h2>
<p>You will need two credentials - an Authorization token and a Karbon
Tenant AccessKey - to access Karbon APIs. If you don't already have these
credentials, follow the steps below to receive them and access Karbon
APIs: <ol> <li> [Register](https://developers.karbonhq.com/register) for
a free developer account to receive the Authorization
(<code>Bearer</code>) token via an email.</li>
<li> [Find](https://help.karbonhq.com/en/articles/4580888-karbon-api-integration#h_03a24631ea)
your Karbon Tenant Accesskey under Settings -> Connected Apps in
Karbon.</li> <li>Assign the Authorization token to
<code>Authorization</code> header and Karbon Tenant AccessKey to
<code>AccessKey</code> header to send requests to Karbon APIs.</li>
</ol></p> <hr>
version: v3
title: Karbon API
termsOfService: 'https://karbonhq.com/terms-of-use/'
contact:
name: API Support
url: karbonhq.com/contact-us
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
-
name: Client Groups
description: 'Create a client group to manage related contacts, create work for them, and see all related jobs in a single view. [Read more](https://help.karbonhq.com/en/articles/5880261-manage-a-client-group)'
-
name: Client Request Recipients
description: 'Receive information about the recipient of the the Client Request Tasks. [Read more](https://help.karbonhq.com/en/collections/102205-client-tasks)'
-
name: Client Requests
description: 'Review Client Requests that you have created to assign tasks, schedule automatic reminders and receive information. [Read more](https://help.karbonhq.com/en/collections/102205-client-tasks)'
-
name: Client Task Comment Attachments
description: 'Manage attachments in Client Request Tasks comments. [Read more](https://help.karbonhq.com/en/collections/102205-client-tasks)'
-
name: Client Task Comments
description: 'Manage Client Tasks comments and receive information about them. [Read more](https://help.karbonhq.com/en/collections/102205-client-tasks)'
-
name: Client Tasks
description: 'Use Client Tasks to collaborate with clients, assign tasks, schedule automatic reminders and receive info. [Read more](https://help.karbonhq.com/en/collections/102205-client-tasks)'
-
name: Comments
description: 'Use comments on tasks to add notes or bring a colleague into the conversation to collaborate on the task. [Read more](https://help.karbonhq.com/en/articles/2111192-comment-and-collaborate-on-a-task)'
-
name: Contacts
description: 'Manage your contacts and get the full overview over clients, whether they are individuals or organizations. [Read more](https://help.karbonhq.com/en/articles/5708609-overview-of-contacts)'
-
name: Estimate Summaries
description: 'Estimate and track time to understand jobs that are on-budget, allocate resources, and uncover performance insights to transform your firm. [Read more](https://help.karbonhq.com/en/articles/4439115-overview-of-time-budgets)'
-
name: Files
description: 'Handle files and attachments. [Read more](https://help.karbonhq.com/en/articles/5714089-files-and-attachments)'
-
name: Notes
description: 'Hold a conversation internally within your company. Unlike an email, Notes are viewed only by members of your team. [Read more](https://help.karbonhq.com/en/articles/5919746-use-notes)'
-
name: Organizations
description: 'Create an organization to represent marriages and couples and client groups to represent families. [Read more](https://help.karbonhq.com/en/articles/5880261-manage-a-client-group)'
-
name: Socket Manager
description: Operations about Socket Manager
-
name: Timesheets
description: "Review colleagues' weekly submitted timesheets. [Read more](https://help.karbonhq.com/en/articles/6022358-add-budget-estimates-track-time-and-submit-time-sheets)"
-
name: Users
description: 'Create and view the basics & defaults for colleagues, teams and job roles to customize Karbon to represent the way you and your team work. [Read more](https://help.karbonhq.com/en/articles/3731216-edit-your-user-profile)'
-
name: Webhook Subscriptions
description: Integrate your system with Karbon to receive changes made to your data in Karbon.
-
name: Work Items
description: 'Manage a Work Item to best fit your workflow, including timelines, tasks and work teams. [Read more](https://help.karbonhq.com/en/articles/6057036-managing-work-items-and-teams)'
-
name: Work Schedules
description: 'Set a Work Item to repeat on a defined schedule. [Read more](https://help.karbonhq.com/en/articles/6096234-setup-repeating-work-on-a-schedule)'
-
name: Work Templates
description: "Find and review templates that you created to fit your firm's unique workflows. [Read more](https://help.karbonhq.com/en/articles/5325202-create-and-customize-work-templates)"
security:
-
ApiKeyAuth: []
BearerAuth: []
paths:
/v3/ClientGroups:
get:
tags:
- Client Groups
summary: Gets a list of Client Groups
parameters:
-
in: query
name: $filter
schema:
type: string
enum:
- FullName
example: "FullName eq 'Sample Management Team'"
description: "When this parameter is combined with the URI, this endpoint will return a subset of the Client Groups that satisfy the <code>$filter</code> expression. \n"
-
in: query
name: $orderby
schema:
type: string
enum:
- FullName
default: ClientGroupKey
example:
- FullName
- FulName desc
description: >
When this parameter is combined with the URI, this
endpoint will return a list of Client Groups, sorted by
the available properties.
-
in: query
name: $top
schema:
type: integer
minimum: 0
maximum: 100
example: 50
description: >
When this parameter is combined with the URI and a value
N is assigned to it, this endpoint will return only the
first N Client Groups.
-
in: query
name: $skip
schema:
type: integer
minimum: 0
example: 100
description: >
When this parameter is combined with the URI and a value
N is assigned to it, this endpoint will return all but
the first N Client Groups.
description: >
Use the <code>GET</code> method on this endpoint to receive
a paginated list of Client Groups from your tenant. Using the
query parameters available to this endpoint, you can also filter
the list of Client Groups by their full name. <br><br> <div style
= "border-block: 1px solid #fc7f03;"> <b>Notes</b> <ul> <li>This
endpoint returns a maximum of 100 Client Groups at once.</li>
<li>If the query results in more than 100 Client Groups, a link
to the next set of the results will be given in the
<code>@odata.nextLink</code> field of the response.</li> <li>The
<code>$filter</code> query parameter supports a logical operator
- <code>eq</code> and a property to help you form an
expression.</li> </ul> </div>
operationId: getClientGroups
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/GetClientGroup'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Unsupported Property:
$ref: '#/components/examples/Unsupported_Property_Filter'
Unsupported Orderby Property:
$ref: '#/components/examples/$Orderby_Unsupported_Property'
$top limit exceeded:
$ref: '#/components/examples/Limit_Exceeded_Top'
Unsupported Option:
$ref: '#/components/examples/Unsupported_option'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Unauthorized Access:
$ref: '#/components/examples/UnauthorizedAccess'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Undefined Error:
$ref: '#/components/examples/elongated_5001'
post:
tags:
- Client Groups
summary: Creates a new Client Group
description: >
Use the <code>POST</code> method on this endpoint to create a new
Client Group in your tenant.
operationId: createClientGroup
responses:
'200':
description: Successful operation
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/ResponseCreateClientGroup'
-
type: object
properties:
AccountingDetails:
nullable: true
type: string
description: 'The accounting details associated with the Client Group. This property will be <code>null</code>.'
example:
'@odata.context': 'https://api.karbonhq.com/v3/$metadata#ClientGroups/$entity'
'@odata.type': '#KarbonService.ClientGroupDTO'
ClientGroupKey: 38zlxNyJSr8y
FullName: Abigail Silvers
ClientOwner: [email protected]
ClientManager: [email protected]
ContactType: Client
UserDefinedIdentifier: SILVERS
RestrictionLevel: Public
PrimaryContact: Duncan Moore
LastModifiedDateTime: '2022-07-05T07:30:13.7188114Z'
Members: []
EntityDescription:
Text: Bicycle rental service in the New jersey area.
AccountingDetails: null
headers:
Location:
description: The endpoint URL to the newly created Client Group.
schema:
type: string
example: "https://api.karbonhq.com/v3/ClientGroups('4t8LbR1QcbGS')"
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Incorrect or Missing Data:
$ref: '#/components/examples/Missing_Create_Data'
Unsupported Option:
$ref: '#/components/examples/Unsupported_option'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Unauthorized Access:
$ref: '#/components/examples/UnauthorizedAccess'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Duplicate UDI:
$ref: '#/components/examples/Duplicate_UDI'
Undefined Error:
$ref: '#/components/examples/elongated_5001'
requestBody:
description: Refer to the table below for more information on each field in the request body.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateClientGroup'
example:
FullName: Abigail Silvers
ClientOwner: [email protected]
ClientManager: [email protected]
ContactType: Client
UserDefinedIdentifier: SILVERS
RestrictionLevel: Public
PrimaryContact: Duncan Moore
EntityDescription:
Text: Bicycle rental service in the New jersey area.
"/v3/ClientGroups/GetClientGroupByUserDefinedIdentifier(UserDefinedIdentifier='{UserDefinedIdentifier}')":
get:
tags:
- Client Groups
summary: Gets a Client Group using UserDefinedIdentifier
parameters:
-
required: true
in: path
name: UserDefinedIdentifier
schema:
type: string
example: SILVERS
description: 'A unique identifier that you had created to identify this Client Group. This parameter is <b>not</b> case sensitive.'
-
in: query
name: $expand
schema:
type: string
enum:
- BusinessCard
example: BusinessCard
description: >
When this parameter is combined with the URI, this
endpoint will also return the Business Card of the Client
Group.
description: >
Use the <code>GET</code> method on this endpoint to receive the
details of a Client Group specified using the
UserDefinedIdentifier. <br><br>Using the query parameter
available to this endpoint, you can also include Business Card
details of the Client Group in the response.
operationId: getClientGroupByUDI
responses:
'200':
description: Successful operation
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/ResponseCreateClientGroup'
-
type: object
properties:
AccountingDetails:
nullable: true
type: string
description: 'The accounting details associated with the Client Group. This property will be <code>null</code>.'
-
type: object
properties:
BusinessCard:
$ref: '#/components/schemas/BusinessCard'
example:
'@odata.context': 'https://api.karbonhq.com/v3/$metadata#ClientGroups/$entity'
'@odata.type': '#KarbonService.ClientGroupDTO'
ClientGroupKey: 38zlxNyJSr8y
FullName: Abigail Silvers
ClientOwner: [email protected]
ClientManager: [email protected]
ContactType: Client
UserDefinedIdentifier: SILVERS
RestrictionLevel: Public
PrimaryContact: Duncan Moore
LastModifiedDateTime: '2022-07-05T07:30:13.7188114Z'
Members:
ContactKey: 34yxkY51knn7
OrganizationKey: 4ncPZ7q96SGc
EntityDescription:
Text: Bicycle rental service in the New jersey area.
AccountingDetails: null
BusinessCard:
BusinessCardKey: 2tBHyXtJBxBy
IsPrimaryCard: true
WebSites: '["www.website.one", "www.website.two"]'
EmailAddresses: '["[email protected]", "[email protected]"]'
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: COO
FacebookLink: facebook.com/sampleName
LinkedInLink: linkedin.com/sampleName
TwitterLink: twitter.com/sampleName
SkypeLink: skype.com/sampleName
Addresses:
AddressKey: e150a05a-2dea-4292-8bc8-03398c9384e4
AddressLines: 45 Sample Street
City: Alexandria
StateProvinceCounty: NSW
ZipCode: 2015
CountryCode: AU
Label: Physical
PhoneNumbers:
PhoneNumberKey: 6e0b9ace-24b1-4328-a922-3b8be5ef5052
Number: 1234567890
CountryCode: 61
Label: Work
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
UDI Is Empty:
$ref: '#/components/examples/UDI_Is_Empty'
Unsupported Option:
$ref: '#/components/examples/Unsupported_option'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Unauthorized Access:
$ref: '#/components/examples/UnauthorizedAccess'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
UDI Not Found:
$ref: '#/components/examples/UDI_Not_Found'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Undefined Error:
$ref: '#/components/examples/elongated_5001'
'/v3/ClientGroups/{ClientGroupkey}':
get:
tags:
- Client Groups
summary: Gets a Client Group using ClientGroupkey
parameters:
-
required: true
in: path
name: ClientGroupkey
schema:
type: string
example: 4t8LbR1QcbGS
description: The Karbon-generated Client Group key
-
in: query
name: $expand
schema:
type: string
enum:
- BusinessCard
example: BusinessCard
description: >
When this parameter is combined with the URI, this
endpoint will also return Business Card of the Client
Group.
description: >
Use the <code>GET</code> method on this endpoint to receive the
details of a Client Group specified using the
<code>ClientGroupkey</code>. <br><br>Using the query parameter
available to this endpoint, you can also include the Business
Card details of the Client Group in the response.
operationId: getClientGroupByID
responses:
'200':
description: Successful operation
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/ResponseCreateClientGroup'
-
type: object
properties:
AccountingDetails:
nullable: true
type: string
description: 'The accounting details associated with the Client Group. This property will be <code>null</code>.'
-
type: object
properties:
BusinessCard:
$ref: '#/components/schemas/BusinessCard'
example:
'@odata.context': 'https://api.karbonhq.com/v3/$metadata#ClientGroups/$entity'
'@odata.type': '#KarbonService.ClientGroupDTO'
ClientGroupKey: 38zlxNyJSr8y
FullName: Abigail Silvers
ClientOwner: [email protected]
ClientManager: [email protected]
ContactType: Client
UserDefinedIdentifier: SILVERS
RestrictionLevel: Public
PrimaryContact: Duncan Moore
LastModifiedDateTime: '2022-07-05T07:30:13.7188114Z'
Members:
ContactKey: 34yxkY51knn7
OrganizationKey: 4ncPZ7q96SGc
EntityDescription:
Text: Bicycle rental service in the New jersey area.
AccountingDetails: null
BusinessCard:
BusinessCardKey: 2tBHyXtJBxBy
IsPrimaryCard: true
WebSites: '["www.website.one", "www.website.two"]'
EmailAddresses: '["[email protected]", "[email protected]"]'
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: COO
FacebookLink: facebook.com/sampleName
LinkedInLink: linkedin.com/sampleName
TwitterLink: twitter.com/sampleName
SkypeLink: skype.com/sampleName
Addresses:
AddressKey: e150a05a-2dea-4292-8bc8-03398c9384e4
AddressLines: 45 Sample Street
City: Alexandria
StateProvinceCounty: NSW
ZipCode: 2015
CountryCode: AU
Label: Physical
PhoneNumbers:
PhoneNumberKey: 6e0b9ace-24b1-4328-a922-3b8be5ef5052
Number: 1234567890
CountryCode: 61
Label: Work
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Unsupported Option:
$ref: '#/components/examples/Unsupported_option'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Unauthorized Access:
$ref: '#/components/examples/UnauthorizedAccess'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Key Not Found:
$ref: '#/components/examples/Key_Not_Found'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Undefined Error:
$ref: '#/components/examples/elongated_5001'
put:
tags:
- Client Groups
summary: Updates a Client Group (Full)
parameters:
-
required: true
in: path
name: ClientGroupkey
schema:
type: string
example: 4t8LbR1QcbGS
description: The Karbon-generated Client Group key
description: >
Use the <code>PUT</code> method on this endpoint to update full
details of a Client Group specified using the
<code>ClientGroupkey</code>. <br><br>Using the query parameter
available to this endpoint, you can also update the Business Card
details of the Client Group.
operationId: putClientGroupByID
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Incorrect or Missing Data:
$ref: '#/components/examples/Missing_Update_Data'
Unsupported Option:
$ref: '#/components/examples/Unsupported_option'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Unauthorized Access:
$ref: '#/components/examples/UnauthorizedAccess'
'404':
description: Resource Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Key Not Found:
$ref: '#/components/examples/ResourceNotFound'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Non existent Key:
$ref: '#/components/examples/Shortened_5001'
Undefined Error:
$ref: '#/components/examples/elongated_5001'
requestBody:
description: Refer to the table below for more information on each field in the request body.
required: true
content:
application/json:
schema:
allOf:
-
$ref: '#/components/schemas/CreateClientGroup'
-
type: object
properties:
BusinessCard:
$ref: '#/components/schemas/BusinessCardRequest'
example:
FullName: Abigail Silvers
ClientOwner: [email protected]
ClientManager: [email protected]
ContactType: Client
UserDefinedIdentifier: SILVERS
RestrictionLevel: Public
PrimaryContact: Duncan Moore
EntityDescription:
Text: Bicycle rental service in the New jersey area.
BusinessCard:
IsPrimaryCard: true
WebSites: '["www.website.one", "www.website.two"]'
EmailAddresses: '["[email protected]", "[email protected]"]'
RoleOrTitle: COO
FacebookLink: facebook.com/sampleName
LinkedInLink: linkedin.com/sampleName
TwitterLink: twitter.com/sampleName
SkypeLink: skype.com/sampleName
Addresses:
AddressLines: 45 Sample Street
City: Alexandria
StateProvinceCounty: NSW
ZipCode: 2015
CountryCode: AU
Label: Physical
PhoneNumbers:
Number: 1234567890
CountryCode: 61
Label: Work
patch:
tags:
- Client Groups
summary: Updates a Client Group (Partial)
parameters:
-
required: true
in: path
name: ClientGroupkey
schema:
type: string
example: 4t8LbR1QcbGS
description: The Karbon-generated Client Group key
description: "Use the <code>PATCH</code> method on this endpoint to update partial details of a Client Group specified using the <code>ClientGroupkey</code>. <br><br>This method <b>only supports</b> editing the <code>FullName</code> property. \n"
operationId: patchClientGroupByID
responses:
'204':
description: No Content
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Unsupported Property:
$ref: '#/components/examples/Update_Unsupported_Property'
Unsupported Option:
$ref: '#/components/examples/Unsupported_option'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Unauthorized Access:
$ref: '#/components/examples/UnauthorizedAccess'
'404':
description: Resource Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Key Not Found:
$ref: '#/components/examples/ResourceNotFound'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Non existent Key:
$ref: '#/components/examples/Shortened_5001'
Undefined Error:
$ref: '#/components/examples/elongated_5001'
requestBody:
description: Refer to the table below for more information on each field in the request body.
required: true
content:
application/json:
schema:
type: object
properties:
FullName:
type: string
description: The full name of the Client Group
example: Abigail Silvers
/v3/ClientRequestRecipients:
get:
tags:
- Client Request Recipients
summary: Gets details of a Client email
parameters:
-
in: query
required: true
name: emailAddress
schema:
type: string
example: [email protected]
description: >
When this parameter is combined with the URI, this
endpoint will return the details of a Client email.
description: >
Use the <code>GET</code> method on this endpoint to receive the
details of a Client email address.
operationId: getClientRequestRecipientsByEmail
responses:
'200':
description: Successful operation
content:
application/json:
schema:
required:
- value
- '@odata.context'
type: object
properties:
'@odata.context':
type: string
description: The information about Karbon controllers generating this response.
example: 'https://api.karbonhq.com/v3/$metadata#ClientRequestRecipients'
value:
type: array
items:
required:
- value
- '@odata.context'
type: object
properties:
ClientRequestRecipientKey:
type: string
description: A Karbon-generated unique identifier for the email recipient
example: yD8Rw3DxksW
ClientType:
type: string
enum:
- Contact
- Organization
description: The client type of the Client Request Recipient.
example: Organization
Name:
type: string
description: The name of the Client
example: Acme Corporation
EmailAddresses:
type: string
description: The email address of the client
example: [email protected]
AuthorAvatarUrl:
type: string
description: The URL to the avatar of the client
example: 'https://api.az.karbonemail.com/images/e546f2bc-e48f-4c2a-9384-a1036c28c081'
AvatarIndex:
type: integer
format: int32
description: The background color index number of the Client avatar
example: 25
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Invalid Email Address:
$ref: '#/components/examples/ClientRequestRecipient_Invalid_Email'
Unsupported Option:
$ref: '#/components/examples/Unsupported_option'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFound'
examples:
Unauthorized Access:
$ref: '#/components/examples/UnauthorizedAccess'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Email Not Found:
$ref: '#/components/examples/ClientRequestRecipient_Not_Found'
HTTP Resource Not Found:
$ref: '#/components/examples/HTTP_Resource_Not_Found'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorMessages'
examples:
Undefined Error:
$ref: '#/components/examples/elongated_5001'
/v3/ClientRequests:
get:
tags:
- Client Requests
summary: Gets a list of Client Requests
description: >-
This endpoint can be used to get the details of all Client
Request tasks.<br><br> <div style = "border-block: 1px solid
#fc7f03;"> <b>Notes</b> <ul> <li>This endpoint returns
a maximum of 100 Client Requests at once.</li> <li>If the query
results in more than 100 Client Requests, a link to the next set
of the results will be given in the <code>@odata.nextLink</code>
field of the response.</li> <li>The <code>$expand</code> query
parameter lets you include Recipient and ClientTaskSummaries
associated with the Client task in the response. </li> <li>The
<code>$filter</code> query parameter supports 4 logical operators
(<code>eq</code>, <code>ge</code>, <code>le</code>, and
<code>and</code>) and 4 properties to help you form an
expression. They are listed below with examples of usage.<br>
<ul><br> <li><b>Operators for DateTime Properties</b></li>
<table> <thead>
<tr>
<th>Logical Operators</th>
<th>Purpose</th>
<th>WorkItemCompletedDate</th>
<th>WorkItemDueDate</th>
</tr>
</thead> <tbody>
<tr>
<td>eq</td>
<td>Full-text search</td>
<td>WorkItemCompletedDate eq 2020-10-31T17:04:32Z</td>
<td>WorkItemDueDate eq 2020-10-31T17:04:32Z</td>
</tr>
<tr>
<td>ge</td>
<td>Greater than and equals to</td>
<td>WorkItemCompletedDate ge 2020-10-31T17:04:32Z</td>
<td>WorkItemDueDate ge 2020-10-31T17:04:32Z</td>
</tr>
<tr>
<td>le</td>
<td>Lesser than and equals to</td>
<td>WorkItemCompletedDate le 2020-10-31T17:04:32Z</td>
<td>WorkItemDueDate le 2020-10-31T17:04:32Z</td>
</tr>
<tr>
<td>and</td>
<td>Combines properties</td>
<td colspan = "2">WorkItemCompletedDate ge
2020-10-31T17:04:32Z and WorkItemKey eq '3jtk81v2Xtw7'</td>
</tr>
</tbody> </table><br> <li><b>Operators for other
Properties</b></li><br> <table> <thead>
<tr>
<th>Logical Operators</th>
<th>Purpose</th>
<th>Recipient/ClientRequestRecipientKey</th>
<th>WorkItemkey</th>
</tr>
</thead> <tbody>
<tr>
<td>eq</td>
<td>Full-text search</td>
<td>/v3/ClientRequests?$filter=Recipient/ClientRequestRecipientKe
eq 'yD8Rw3DxksW'</td>
<td>/v3/ClientRequests?$filter=WorkItemKey eq
'3jtk81v2Xtw7'</td>
</tr>
<tr>
<td>and</td>
<td>Combines properties</td>
<td colspan = "2">/v3/ClientRequests?$filter=WorkItemKey
eq '3jtk81v2Xtw7' and WorkItemDueDate ge
2020-10-31T17:04:32Z</td>
</tr>
</tbody> </table> </ul> </li></ul>
operationId: getClientRequests
parameters:
-
in: query
name: $filter
schema:
type: string
enum:
- Recipient/ClientRequestRecipientKey
- WorkItemCompletedDate
- WorkItemDueDate
- WorkItemKey
example: "WorkItemKey eq '3jtk81v2Xtw7'"
description: "When this parameter is combined with the URI, this endpoint will return a subset of the Client Requests that satisfy the <code>$filter</code> expression. \n"
-
in: query
name: $top
schema:
type: integer
minimum: 0
maximum: 100
example: 50
description: >
When this parameter is combined with the URI and a value
N is assigned to it, this endpoint will return only the
first N Client Requests.
-
in: query
name: $skip
schema:
type: integer
minimum: 0
example: 100
description: >
When this parameter is combined with the URI and a value
N is assigned to it, this endpoint will return all but
the first N Client Requests.
-
in: query
name: $expand
schema:
type: string
enum:
- Recipient
- ClientTaskSummaries
example: 'Recipient,ClientTaskSummaries'
description: >
When these parameters are combined with the URI, this
endpoint will also return the Recipient and
ClientTaskSummaries associated with the Client
task. <br><br> <b>Notes</b>: <ul> <li>You <b>must</b>
use the <code>WorkItemKey</code> property on the
<code>$filter</code> option to use
<code>ClientTaskSummaries</code> on the
<code>$expand</code> option. </li> <li>Assign