-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi.yaml
2537 lines (2537 loc) · 88.4 KB
/
openapi.yaml
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.0
info:
version: v3
title: Karbon API 3.0
description: Karbon HQ API Description here
termsOfService: Shareware
contact:
name: Developer Support
email: api_help@karbonhq.com
license:
name: MIT
url: https://opensource.org/licenses/MIT
paths:
/v3/ClientGroups:
get:
tags:
- ClientGroups
summary: Get and/or Filter a Paged List of Client Groups
operationId: ClientGroups_Get
parameters:
- name: $select
in: query
description: Limits the properties returned in the result.
required: false
schema:
type: string
- name: $filter
in: query
description: "Restricts the set of items returned. The maximum number of
expressions is 100. The allowed functions are: startswith,
alldatetimefunctions."
required: false
schema:
type: string
- name: $orderby
in: query
description: Specifies the order in which items are returned. The maximum number
of expressions is 5.
required: false
schema:
type: string
- name: $top
in: query
description: Limits the number of items returned from a collection.
required: false
schema:
type: integer
format: int32
- name: $skip
in: query
description: Excludes the specified number of items of the queried collection
from the result.
required: false
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Microsoft.AspNet.OData.PageResult_Karbo\
n.Api.Contacts.V2.ClientGroupSummaryDTO_"
examples:
response:
value:
Items:
- FullName: Karbon Sales Team
PhoneNumber: "03212345678"
Website: https://www.karbonhq.com
LastModifiedDateTime: 2020-08-04T03:33:26.734954Z
ClientGroupKey: ZGNmtYyLm4z
- FullName: Acme Management Team
PhoneNumber: "0478371927"
Website: https://www.acme.com
LastModifiedDateTime: 2020-08-11T03:33:26.734954Z
ClientGroupKey: ZGNmtYyLm4z
NextPageLink: https://karbonapi.com/ClientGroups?$skip=100
Count: 123
application/xml:
schema:
$ref: "#/components/schemas/Microsoft.AspNet.OData.PageResult_Karbo\
n.Api.Contacts.V2.ClientGroupSummaryDTO_"
post:
tags:
- ClientGroups
summary: Create a Client Group
operationId: ClientGroups_Post
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ClientGroupDTO"
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ClientGroupDTO"
description: The new Client Group to Create
required: true
responses:
"201":
description: Client Group successfully created
headers:
Location:
description: Location of the newly created Resource
schema:
type: string
content:
application/json:
examples:
response:
value:
FullName: Karbon Sales Team
BusinessCard:
BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: e0391fa3-f4a4-40ae-a8c4-5a24dfecc2ee
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: e0391fa3-f4a4-40ae-a8c4-5a24dfecc2ee
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: 01a257b1-36ed-442e-9cd7-487c544bfc2f
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: 01a257b1-36ed-442e-9cd7-487c544bfc2f
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
ClientOwner: myowner@karbonhq.com
ClientManager: mymanager@karbonhq.com
ContactType: Supplier
UserDefinedIdentifier: abc123
Members: null
LastModifiedDateTime: 2020-08-04T03:33:26.8039927Z
ClientGroupKey: ZGNmtYyLm4z
"400":
description: Incoming Model is invalid
"500":
description: Error processing Request
"/v3/ClientGroups/{key}":
get:
tags:
- ClientGroups
summary: Gets a single Client Group by supplied Key
operationId: GetClientGroupByKey
parameters:
- name: key
in: path
description: The Client Group Key
required: true
schema:
type: string
- name: $select
in: query
description: Limits the properties returned in the result.
required: false
schema:
type: string
- name: $expand
in: query
description: Indicates the related entities to be represented inline. The maximum
depth is 2.
required: false
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
examples:
response:
value:
FullName: Karbon Sales Team
BusinessCard:
BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 3b5e60d0-8bbd-4fd7-b31a-14328d00a534
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 3b5e60d0-8bbd-4fd7-b31a-14328d00a534
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: 14da8d26-6698-4f03-af7c-5c7bc545a6de
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: 14da8d26-6698-4f03-af7c-5c7bc545a6de
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
ClientOwner: myowner@karbonhq.com
ClientManager: mymanager@karbonhq.com
ContactType: Supplier
UserDefinedIdentifier: abc123
Members: null
LastModifiedDateTime: 2020-08-04T03:33:26.8189943Z
ClientGroupKey: ZGNmtYyLm4z
"404":
description: No Client Group found for provided key
put:
tags:
- ClientGroups
summary: Perform a full update of a Client Group
operationId: ClientGroups_Put
parameters:
- name: key
in: path
description: Key of the Client Group to update
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ClientGroupDTO"
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ClientGroupDTO"
description: The new (full) details of the Client Group to update with.
required: true
responses:
"204":
description: Client Group successfully updated
"400":
description: Incoming Model is invalid
"500":
description: Error processing Request
patch:
tags:
- ClientGroups
summary: Perform a Partial update of a Client Group
operationId: ClientGroups_Patch
parameters:
- name: key
in: path
description: Key of the Client Group to update
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ClientGroupDTO"
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ClientGroupDTO"
description: The new details of the Client Group to update. NOTE only the
properties to be updated need to be provided
required: true
responses:
"204":
description: Client Group successfully updated
"400":
description: Invalid property to update
"500":
description: Error processing Request
"/v3/ClientGroups/GetByUserDefinedIdentifier(userDefinedIdentifier='{userDefinedIdentifier}')":
get:
tags:
- ClientGroups
summary: Get a Client Group from the supplied User Defined Identifier
operationId: ClientGroups_GetByUserDefinedIdentifier
parameters:
- name: userDefinedIdentifier
in: path
description: The UserDefinedIdentifier
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
examples:
response:
value:
FullName: Karbon Sales Team
BusinessCard:
BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 17c4eca8-69b3-42ce-9651-d267a7b848b2
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 17c4eca8-69b3-42ce-9651-d267a7b848b2
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: 6439a686-7f49-4567-af91-8a61840aaf2d
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: 6439a686-7f49-4567-af91-8a61840aaf2d
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
ClientOwner: myowner@karbonhq.com
ClientManager: mymanager@karbonhq.com
ContactType: Supplier
UserDefinedIdentifier: abc123
Members: null
LastModifiedDateTime: 2020-08-04T03:33:26.8200002Z
ClientGroupKey: ZGNmtYyLm4z
"400":
description: UserDefinedIdentifier is missing or empty
"404":
description: No Client Group found for provided UserDefinedIdentifer
/v3/Contacts:
get:
tags:
- Contacts
summary: Get and/or Filter a Paged List of Contacts
operationId: Contacts_Get
parameters:
- name: $select
in: query
description: Limits the properties returned in the result.
required: false
schema:
type: string
- name: $filter
in: query
description: "Restricts the set of items returned. The maximum number of
expressions is 100. The allowed functions are: startswith,
alldatetimefunctions. The allowed properties are: FullName,
EmailAddress, PhoneNumber."
required: false
schema:
type: string
- name: $orderby
in: query
description: "Specifies the order in which items are returned. The maximum number
of expressions is 5. The allowed properties are: FullName,
LastModifiedDateTime."
required: false
schema:
type: string
- name: $top
in: query
description: Limits the number of items returned from a collection. The maximum
value is 100.
required: false
schema:
type: integer
format: int32
- name: $skip
in: query
description: Excludes the specified number of items of the queried collection
from the result.
required: false
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/Microsoft.AspNet.OData.PageResult_Karbo\
n.Api.Contacts.V2.ContactSummaryDTO_"
examples:
response:
value:
Items:
- FullName: Adams, Douglas Noel
PreferredName: Doug
Salutation: Mr
ClientOwner: myowner@megadodopublications.com
ClientManager: mymanager@megadodopublications.com
Address: 42 Galaxy Way, London
EmailAddress: DNA@megadodopublications.net
PhoneNumber: "+61212345678"
RoleOrTitle: CEO
UserDefinedIdentifier: "42"
LastModifiedDateTime: 2020-08-04T03:33:26.8250027Z
ContactKey: 2BtTSg4xM7Dt
- FullName: Asimov, Isaac
PreferredName: Zac
Salutation: Mr
ClientOwner: myowner@bostonuniversity.edu
ClientManager: mymanager@bostonuniversity.edu
Address: 1920 Foundation Boulevard, Petrovichi, Russia
EmailAddress: asimo@bostonuniversity.edu
PhoneNumber: "069283779143"
RoleOrTitle: Writer
UserDefinedIdentifier: "5020"
LastModifiedDateTime: 2020-08-16T03:33:26.8250027Z
ContactKey: 23WWskXjR4wX
NextPageLink: https://karbonapi.com/Contacts?$skip=100
Count: 123
application/xml:
schema:
$ref: "#/components/schemas/Microsoft.AspNet.OData.PageResult_Karbo\
n.Api.Contacts.V2.ContactSummaryDTO_"
post:
tags:
- Contacts
summary: Create a Contact
operationId: Contacts_Post
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ContactDTO"
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ContactDTO"
description: The new Contact to Create
required: true
responses:
"201":
description: Contact successfully created
headers:
Location:
description: Location of the newly created Resource
schema:
type: string
content:
application/json:
examples:
response:
value:
FirstName: Douglas
MiddleName: Noel
LastName: Adams
PreferredName: Doug
Salutation: Mr
BusinessCards:
- BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 23a8d967-151a-439b-8118-e4c1327a87c7
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 23a8d967-151a-439b-8118-e4c1327a87c7
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: bef9bdb5-786b-4876-930d-5b3268ccfdc2
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: bef9bdb5-786b-4876-930d-5b3268ccfdc2
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
- BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 42dedf34-c1ee-4680-bb3f-c6a59c6822b4
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 42dedf34-c1ee-4680-bb3f-c6a59c6822b4
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: 64ce63c4-2c09-414b-93ed-6b0153cca4e9
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: 64ce63c4-2c09-414b-93ed-6b0153cca4e9
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
ClientOwner: myowner@karbonhq.com
ClientManager: mymanager@karbonhq.com
ContactType: Supplier
UserDefinedIdentifier: "42"
LastModifiedDateTime: 2020-08-04T03:33:26.8339623Z
ContactKey: ZGNmtYyLm4z
"400":
description: Incoming Model is invalid
"500":
description: Error processing Request
"/v3/Contacts/{key}":
get:
tags:
- Contacts
summary: Gets a single Contact by supplied Key
operationId: GetContactByKey
parameters:
- name: key
in: path
description: The Contact Key
required: true
schema:
type: string
- name: $select
in: query
description: Limits the properties returned in the result.
required: false
schema:
type: string
- name: $expand
in: query
description: Indicates the related entities to be represented inline. The maximum
depth is 2.
required: false
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
examples:
response:
value:
FirstName: Douglas
MiddleName: Noel
LastName: Adams
PreferredName: Doug
Salutation: Mr
BusinessCards:
- BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 653b2986-a715-4e73-941d-08a8d92313f3
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 653b2986-a715-4e73-941d-08a8d92313f3
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: 1aefb445-3825-405b-ada5-e7749c832a74
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: 1aefb445-3825-405b-ada5-e7749c832a74
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
- BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 481c8f80-05c9-4641-8d49-1dc69b40d26f
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 481c8f80-05c9-4641-8d49-1dc69b40d26f
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: 40371e8d-79b4-4df4-8878-8dd3a9f02486
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: 40371e8d-79b4-4df4-8878-8dd3a9f02486
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
ClientOwner: myowner@karbonhq.com
ClientManager: mymanager@karbonhq.com
ContactType: Supplier
UserDefinedIdentifier: "42"
LastModifiedDateTime: 2020-08-04T03:33:26.8389537Z
ContactKey: ZGNmtYyLm4z
"404":
description: No Contact found for provided key
put:
tags:
- Contacts
summary: Perform a full update of a Contact
operationId: Contacts_Put
parameters:
- name: key
in: path
description: Key of the Contact to update
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ContactDTO"
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ContactDTO"
description: The new (full) details of the Contact to update with.
required: true
responses:
"204":
description: Contact successfully updated
"400":
description: Incoming Model is invalid
"500":
description: Error processing Request
patch:
tags:
- Contacts
summary: Perform a Partial update of a Contact
operationId: Contacts_Patch
parameters:
- name: key
in: path
description: Key of the Contact to update
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ContactDTO"
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.Contacts.V2.ContactDTO"
description: The new details of the Contact to update. NOTE only the properties to
be updated need to be provided
required: true
responses:
"204":
description: Contact successfully updated
"400":
description: Invalid property to update
"500":
description: Error processing Request
"/v3/Contacts/GetByUserDefinedIdentifier(userDefinedIdentifier='{userDefinedIdentifier}')":
get:
tags:
- Contacts
summary: Get a contact from the supplied User Defined Identifier
operationId: Contacts_GetByUserDefinedIdentifier
parameters:
- name: userDefinedIdentifier
in: path
description: The UserDefinedIdentifier
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
examples:
response:
value:
FirstName: Douglas
MiddleName: Noel
LastName: Adams
PreferredName: Doug
Salutation: Mr
BusinessCards:
- BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 2e9c1fb6-9133-40e2-9412-cb4860799b3a
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 2e9c1fb6-9133-40e2-9412-cb4860799b3a
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: ebcd82f6-7080-4709-b899-f9720c3f2eb6
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: ebcd82f6-7080-4709-b899-f9720c3f2eb6
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
- BusinessCardKey: 2xfLMq5PFqb7
IsPrimaryCard: false
Addresses:
- AddressKey: 066c52ab-bb44-49cb-8818-8f3ca98ac83c
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
- AddressKey: 066c52ab-bb44-49cb-8818-8f3ca98ac83c
AddressLines: 2400 Bridgeway, Ste 280
City: Sausalito
StateProvinceCounty: CA
ZipCode: "94965"
CountryCode: US
Label: Work
PhoneNumbers:
- PhoneNumberKey: e394fc5d-3aa4-4027-bb4d-6a920515bc88
Number: "+61212345678"
CountryCode: US
Label: Work
- PhoneNumberKey: e394fc5d-3aa4-4027-bb4d-6a920515bc88
Number: "+61212345678"
CountryCode: US
Label: Work
WebSites:
- https://www.karbonhq.com
EmailAddresses:
- enquiries@karbonhq.com
OrganizationKey: ZGNmtYyLm4z
RoleOrTitle: CEO
ClientOwner: myowner@karbonhq.com
ClientManager: mymanager@karbonhq.com
ContactType: Supplier
UserDefinedIdentifier: "42"
LastModifiedDateTime: 2020-08-04T03:33:26.8389537Z
ContactKey: ZGNmtYyLm4z
"400":
description: UserDefinedIdentifier is missing or empty
"404":
description: No Contact found for provided UserDefinedIdentifer
/v3/Files:
post:
tags:
- Files
summary: Creates and Links a File
operationId: Files_Post
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
FileName:
description: Name of the file
type: string
MimeType:
description: Specifies the kind of document being uploaded. Must be a
valid MIME type as per RFC 6838, note this is not the file
extension.
type: string
contact_keys:
description: Comma seperated list of Contact keys to link this file to.
type: array
items:
type: string
organization_keys:
description: Comma seperated list of Organization keys to link this file
to.
type: array
items:
type: string
client_group_keys:
description: Comma seperated list of Client Group keys to link this file
to.
type: array
items:
type: string
workitem_keys:
description: Comma seperated list of Work Item keys to link this file to.
type: array
items:
type: string
file:
description: File to upload.
type: string
format: binary
required:
- FileName
- MimeType
- file
responses:
"201":
description: File created and linked successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.Files.FileDTO"
examples:
response:
value:
Id: 2xfLMq5PFqb7
Name: TaxQuestionaire
MimeType: application/pdf
Size: 1024
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.Files.FileDTO"
"500":
description: Error processing Request
/v3/Notes:
post:
tags:
- Notes
summary: Create a Note
operationId: Notes_Post
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.ContentItems.NoteDTO"
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.ContentItems.NoteDTO"
description: The new Note to Create
required: true
responses:
"201":
description: Note successfully created
headers:
Location:
description: Location of the newly created Resource
schema:
type: string
content:
application/json:
schema:
$ref: "#/components/schemas/Karbon.Api.ContentItems.NoteDTO"
examples:
response:
value:
Id: 2xfLMq5PFqb7
Subject: This is the note subject
Body: This is the note body
AuthorEmailAddress: author@karbonhq.com
AssigneeEmailAddress: assignee@karbonhq.com
DueDate: 2020-08-25T03:33:26.8459933Z
TodoDate: 2020-08-19T03:33:26.8459933Z
application/xml:
schema:
$ref: "#/components/schemas/Karbon.Api.ContentItems.NoteDTO"
"400":
description: Incoming Model is invalid
"500":
description: Error processing Request
/v3/Organizations:
get:
tags:
- Organizations
summary: Get and/or Filter a Paged List of Organizations
operationId: Organizations_Get
parameters:
- name: $select
in: query
description: Limits the properties returned in the result.
required: false
schema:
type: string
- name: $filter
in: query
description: "Restricts the set of items returned. The maximum number of
expressions is 100. The allowed functions are: startswith,
alldatetimefunctions. The allowed properties are: FullName."
required: false
schema:
type: string
- name: $orderby
in: query
description: "Specifies the order in which items are returned. The maximum number
of expressions is 5. The allowed properties are: FullName,
LastModifiedDateTime."
required: false
schema:
type: string
- name: $top
in: query
description: Limits the number of items returned from a collection. The maximum
value is 100.
required: false
schema:
type: integer
format: int32
- name: $skip
in: query
description: Excludes the specified number of items of the queried collection
from the result.
required: false
schema:
type: integer
format: int32
responses:
"200":
description: OK
content:
application/json:
examples:
response:
value:
Items:
- FullName: Acme Inventions
PhoneNumber: "98764331"
Website: https://www.acme.com
LastModifiedDateTime: 2020-08-04T03:33:26.8509988Z
OrganizationKey: ZGNmtYyLm4z