-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
9902 lines (9735 loc) · 314 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:
title: Workflows
description: >-
A few years back, Eric (Co-Founder and CEO) got a frustrated call from his
dad. His dad's tire shop had plenty of happy customers, but only a handful
of angry ones were leaving reviews. So we built a product that made getting
more reviews as easy as sending a text.
Launching in 2014, we set out to solve the same problem for local businesses
everywhere, but we realized that messaging with customers wasn't just the
better way to get reviews—it's the better way to do business. We've since
built a multi-product platform that's modernizing the way local business
gets done.
We are here to provide local businesses with everything they need to win.
Get more reviews, collect payments, send text marketing campaigns, and
centralize your communications—all from one easy-to-use platform.
#Podium #PodiumLove #LocalBusiness #TheFutureIsLocal
version: 2021.04.01
x-konfig-ignore:
object-with-no-properties: true
potential-incorrect-type: true
servers:
- url: https://api.podium.com
variables: {}
tags:
- name: Contact
- name: Campaign
- name: Message
- name: Contact Attribute
- name: Conversation
- name: Invoice
- name: Webhook
- name: Contact Tag
- name: Template
- name: Location
- name: Review Invite
- name: Review Response
- name: User
- name: Feedback
- name: Refund
- name: Review
- name: Review Attribution
- name: Organization
- name: Appointment
- name: Campaign Interaction
- name: Payment
- name: Reader
- name: Review Sites Summary
- name: Review Summary
- name: Data Feed Event
- name: Data Stream
paths:
/v4/locations:
get:
tags:
- Location
summary: List all locations.
operationId: Location_listAllLocations
description: >-
List of all the locations that the caller has access to.
If the `cursor` parameter is used then all other parameters will be
ignored. This is to avoid confusion if passing both a `cursor` and other
parameters which would change what data is being returned.
Required scope: `read_locations`.
parameters:
- description: String you would like to search for in the `searchFields` parameter.
in: query
name: search
required: false
schema:
type: string
- description: >-
A list of the fields where you want to search for the `search`
parameters. e.g. ?searchFields[]=name&searchFields[]=displayname
in: query
name: searchFields
required: false
schema:
default:
- name
items:
enum:
- address
- displayName
- name
- podiumPhoneNumber
type: string
type: array
- description: Max number of items to return per request. Defaults to `10`.
in: query
name: limit
required: false
schema:
default: 10
example: 10
maximum: 100
minimum: 0
type: integer
- description: Retrieves the page of items that comes after the `cursor`.
in: query
name: cursor
required: false
schema:
description: Cursor used to access next or previous page in pagination.
example: MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
type: string
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationListAllLocations200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationListAllLocationsResponse'
callbacks: {}
/v4/locations/{uid}:
get:
tags:
- Location
summary: Get a location.
operationId: Location_getByUid
description: |-
Gets a single location by its uid.
Required scope: `read_locations`.
parameters:
- description: Podium unique identifier for location.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationGetByUid200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationGetByUidResponse'
callbacks: {}
patch:
tags:
- Location
summary: Update a location.
operationId: Location_updateByUid
description: >
Update a single location by its uid.
Required scope: `write_locations`.
Be aware: The `addressDetails` property follows the ISO convention. You
might see errors
if trying to update a location's address with an invalid address.
parameters:
- description: Podium unique identifier for location.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
requestBody:
description: Update location params
content:
application/json:
schema:
$ref: '#/components/schemas/LocationUpdateByUidRequest'
required: false
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationUpdateByUid200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/LocationUpdateByUidResponse'
callbacks: {}
/v4/organizations/{uid}:
get:
tags:
- Organization
summary: Get an organization.
operationId: Organization_getByUid
description: |-
Gets a single organization by its uid.
Required scope: `read_organizations`.
parameters:
- description: Podium unique identifier for organization.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationGetByUid200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/OrganizationGetByUidResponse'
callbacks: {}
/v4/users:
get:
tags:
- User
summary: List all users.
operationId: User_listAllUsers
description: >
List of all the users that belong to any of the locations that the
caller has access to.
If the `cursor` parameter is used then all other parameters will be
ignored. This is to avoid confusion if passing both a `cursor` and other
parameters which would change what data is being returned.
Required scope: `read_users`.
parameters:
- description: String you would like to search for in the `searchFields` parameter.
in: query
name: search
required: false
schema:
type: string
- description: Filter on the `createdAt` date.
in: query
name: createdAt
required: false
schema:
properties:
gt:
description: Greater than filter.
example: '2015-01-23T23:50:07Z'
format: date-time
type: string
gte:
description: Greater than or equal to filter.
example: '2015-01-23T23:50:07Z'
format: date-time
type: string
lt:
description: Less than filter.
example: '2015-01-23T23:50:07Z'
format: date-time
type: string
lte:
description: Less than or equal to filter.
example: '2015-01-23T23:50:07Z'
format: date-time
type: string
type: object
style: deepObject
- description: >-
A list of the fields where you want to search for the `search`
parameters. e.g. ?searchFields[]=name&searchFields[]=displayname
in: query
name: searchFields
required: false
schema:
default:
- fullName
items:
enum:
- address
- phone
- fullName
type: string
type: array
- description: Max number of items to return per request. Defaults to `10`.
in: query
name: limit
required: false
schema:
default: 10
example: 10
maximum: 100
minimum: 0
type: integer
- description: Retrieves the page of items that comes after the `cursor`.
in: query
name: cursor
required: false
schema:
description: Cursor used to access next or previous page in pagination.
example: MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
type: string
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/UserListAllUsers200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/UserListAllUsersResponse'
callbacks: {}
/v4/users/{uid}:
get:
tags:
- User
summary: Get a user.
operationId: User_getDetails
description: |-
Gets a user.
Required scope: `read_users`.
parameters:
- description: Podium unique identifier for user.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/UserGetDetails200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/UserGetDetailsResponse'
callbacks: {}
/v4/appointments:
post:
tags:
- Appointment
summary: Create an appointment.
operationId: Appointment_createNewAppointment
description: |-
Create an appointment.
Required scope: `write_appointments`.
parameters: []
requestBody:
description: Create appointment params
content:
application/json:
schema:
$ref: '#/components/schemas/AppointmentCreateNewAppointmentRequest'
required: true
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/AppointmentCreateNewAppointment200Response
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/AppointmentCreateNewAppointmentResponse'
callbacks: {}
/v4/campaign_interactions:
get:
tags:
- Campaign Interaction
summary: List campaign interactions
operationId: CampaignInteraction_listInteractions
description: >
List the campaign interactions that the caller has access to.
If the `cursor` parameter is used then all other parameters will be
ignored. This is to avoid confusion if passing both a `cursor` and other
parameters which would change what data is being returned.
Interactions can be filtered by type, uid of the associated resource, or
timestamp.
Required scope: `read_campaigns`.
parameters:
- description: ''
in: query
name: campaignUid
required: false
schema:
description: Campaign UUID
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
- description: ''
in: query
name: contactUid
required: false
schema:
description: Contact UUID
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
- description: ''
in: query
name: cursor
required: false
schema:
description: Cursor used to access next or previous page in pagination.
example: MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
type: string
- description: The type of interaction this record represents
in: query
name: interactionType
required: false
schema:
items:
enum:
- sent
- queued
- failed
- feedback_left
- link_clicked
- opt_out
- payment_made
- response
- review_left
- resubscribe
type: string
type: array
- description: Max number of items to return per request. Defaults to `10`.
in: query
name: limit
required: false
schema:
default: 10
example: 10
maximum: 100
minimum: 0
type: integer
- description: ''
in: query
name: locationUid
required: false
schema:
description: Location UUID
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/CampaignInteractionListInteractions200Response
default:
description: Error response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/CampaignInteractionListInteractionsResponse
callbacks: {}
/v4/campaigns:
get:
tags:
- Campaign
summary: List all campaigns.
operationId: Campaign_listAll
description: >-
List of all the campaigns that the caller has access to. The campaigns
are sorted by the `updatedAt` date, in descending order
Campaigns can be filtered by their status using the `status` query
parameter
Required scope: `read_campaigns`.
parameters:
- description: Status of the campaign
in: query
name: status
required: false
schema:
type: string
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignListAll200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignListAllResponse'
callbacks: {}
post:
tags:
- Campaign
summary: Create a campaign.
operationId: Campaign_createNewCampaign
description: |-
Create a campaign.
Required scope: `write_campaigns`.
parameters: []
requestBody:
description: Create campaign params
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignCreateNewCampaignRequest'
required: true
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignCreateNewCampaign200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignCreateNewCampaignResponse'
callbacks: {}
/v4/campaigns/{uid}:
delete:
tags:
- Campaign
summary: Delete a campaign.
operationId: Campaign_removeCampaign
description: |-
Delete an existing campaign.
Required scope: `write_campaigns`.
parameters:
- description: UID of the campaign
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignRemoveCampaign200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignRemoveCampaignResponse'
callbacks: {}
get:
tags:
- Campaign
summary: Get a campaign.
operationId: Campaign_getByUid
description: |-
Get a single campaign for the given uid.
Required scope: `read_campaigns`.
parameters:
- description: UID of the campaign
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignGetByUid200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignGetByUidResponse'
callbacks: {}
put:
tags:
- Campaign
summary: Update a campaign.
operationId: Campaign_updateCampaign
description: |-
update a campaign.
Required scope: `write_campaigns`.
parameters:
- description: Podium unique identifier for a campaign.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
requestBody:
description: Update campaign params
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignUpdateCampaignRequest'
required: true
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignUpdateCampaign200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/CampaignUpdateCampaignResponse'
callbacks: {}
/v4/campaigns/{uid}/messages:
post:
tags:
- Message
summary: Create a message for a given campaign
operationId: Message_createForCampaign
description: |-
Send a message through a campaign.
Required scope: `write_campaign_messages`.
parameters:
- description: Podium unique identifier for campaign.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
requestBody:
description: Create campaign message body params
content:
application/json:
schema:
$ref: '#/components/schemas/MessageCreateForCampaignRequest'
required: true
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageCreateForCampaign200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/MessageCreateForCampaignResponse'
callbacks: {}
/v4/contact_attributes:
get:
tags:
- Contact Attribute
summary: List contact attributes
operationId: ContactAttribute_listAttributes
description: |
List contact attributes that are tied to the ownerResource on the token.
Required scope: `read_contacts`.
parameters: []
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeListAttributes200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeListAttributesResponse'
callbacks: {}
post:
tags:
- Contact Attribute
summary: Create a contact attribute
operationId: ContactAttribute_createNewAttribute
description: >
Create an application or organization level attribute to be used on
contacts.
Required scope: `write_contacts`.
parameters: []
requestBody:
description: Create contact attribute params
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeCreateNewAttributeRequest'
required: true
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContactAttributeCreateNewAttribute200Response
default:
description: Error response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContactAttributeCreateNewAttributeResponse
callbacks: {}
/v4/contact_attributes/{uid}:
delete:
tags:
- Contact Attribute
summary: Delete a contact attribute
operationId: ContactAttribute_deleteByUid
description: |-
Delete a contact attribute with its uid.
Required scope: `write_contacts`.
parameters:
- description: Podium unique identifier for attribute.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeDeleteByUid200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeDeleteByUidResponse'
callbacks: {}
get:
tags:
- Contact Attribute
summary: Gets a contact attribute by uid
operationId: ContactAttribute_getAttributeByUid
description: >
Gets an application or organization level attribute by its uid, to be
used on contacts.
Required scope: `read_contacts`.
parameters:
- description: Contacts attribute uid
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContactAttributeGetAttributeByUid200Response
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeGetAttributeByUidResponse'
callbacks: {}
patch:
tags:
- Contact Attribute
summary: Update a contact attribute
operationId: ContactAttribute_updateAttribute
description: >
Update an application or organization level attribute to be used on
contacts.
Required scope: `write_contacts`.
parameters:
- description: Podium unique identifier for attribute.
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
requestBody:
description: Update contact attribute params
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeUpdateAttributeRequest'
required: false
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContactAttributeUpdateAttribute200Response
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactAttributeUpdateAttributeResponse'
callbacks: {}
/v4/contact_tags:
get:
tags:
- Contact Tag
summary: List all tags for the organization
operationId: ContactTag_listAll
description: |
List all tags for the organization.
Required scope: `read_contacts`.
parameters: []
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactTagListAll200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactTagListAllResponse'
callbacks: {}
post:
tags:
- Contact Tag
summary: Create a contact tag for an organization
operationId: ContactTag_createOrganizationLevelTag
description: |
Create an organization level tag for a contact.
Required scope: `write_contacts`.
parameters: []
requestBody:
description: Create contact tag params
content:
application/json:
schema:
$ref: '#/components/schemas/ContactTagCreateOrganizationLevelTagRequest'
required: true
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContactTagCreateOrganizationLevelTag200Response
default:
description: Error response.
content:
application/json:
schema:
$ref: >-
#/components/schemas/ContactTagCreateOrganizationLevelTagResponse
callbacks: {}
/v4/contact_tags/{uid}:
get:
tags:
- Contact Tag
summary: Get a contact tag for an organization given an uid
operationId: ContactTag_getByUid
description: |
Get a organization level tag given the provided uid.
Required scope: `read_contacts`.
parameters:
- description: Contacts tags uid
in: path
name: uid
required: true
schema:
example: 00000000-0000-0000-0000-000000000000
format: uuid
type: string
x-validate: Elixir.KumeteApi.Schema.Common.UUID
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactTagGetByUid200Response'
default:
description: Error response.
content:
application/json:
schema:
$ref: '#/components/schemas/ContactTagGetByUidResponse'
callbacks: {}
patch: