-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
2622 lines (2569 loc) · 90.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.3
info:
title: Zapier Embed API
description: The Zapier Embed API.
version: 1.0.0
contact:
email: contact@zapier.com
name: Zapier
url: https://help.zapier.com/hc/en-us
x-api-id: 370df4a0-2f97-4972-873f-eef6ac607531
x-audience: external-partner
x-konfig-ignore:
potential-incorrect-type: true
servers:
- description: Production
url: https://api.zapier.com/v2
tags:
- description: Endpoints or functions that leverage Actions.
name: Actions
- description: Endpoints or functions that leverage Authentications.
name: Authentications
- description: Endpoints or functions that leverage Zaps.
name: Zaps
- description: Endpoints or functions that leverage Apps.
name: Apps
- description: Endpoints or functions under this category are in the experimental phase.
name: Experimental
paths:
/actions:
parameters: []
get:
tags:
- Actions
summary: Get Actions
operationId: Actions_listAvailableActions
description: >-
Fetch the available actions for the provided App. It's typical to filter
by type so that only actions that make sense for a particular step are
shown. For example only showing reads for the first step in a Zap.
This endpoint requires the `zap` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
parameters:
- $ref: '#/components/parameters/app'
- $ref: '#/components/parameters/action_type'
responses:
'200':
description: A valid response for fetching available actions for the App.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsListAvailableActionsResponse'
examples:
ActionsExample:
value:
links:
next: null
prev: null
meta:
limit: 10
offset: 0
count: 1
data:
- title: New Lead
description: Triggers when a new lead is added to SuperExampleCRM
type: action
id: uag:1f188536-6dd0-4172-8414-2b90914ddee9
key: new_lead
action_type: READ
app: 83b47c0e-adda-44da-a45d-42565fe521ef
is_instant: true
'404':
$ref: '#/components/responses/FourOhFourError'
'406':
$ref: '#/components/responses/FourOhSixError'
'415':
$ref: '#/components/responses/FourFifteenError'
default:
$ref: '#/components/responses/DefaultError'
/authentications:
parameters: []
get:
tags:
- Authentications
summary: Get Authentications
operationId: Authentications_getAvailable
description: >-
Fetch the available Authentications for the provided App. This will only
return Authentications that are owned by the user and not those that are
shared with them, since it''s not possible to create Zaps with
Authentications you don''t own.
This endpoint requires the `authentication` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
parameters:
- $ref: '#/components/parameters/app'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
responses:
'200':
description: >-
A successful request to get available Authentications for the
provided App.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AuthenticationsGetAvailableResponse'
examples:
AuthenticationsExample:
value:
links:
next: null
prev: null
meta:
limit: 10
offset: 0
count: 1
data:
- title: SuperExampleCRM (example@zapier.com)
type: authentication
id: b3eYnwl
app: b61ae76e-487b-4622-8679-df3d3e20bccc
is_expired: false
'404':
$ref: '#/components/responses/FourOhFourError'
'406':
$ref: '#/components/responses/FourOhSixError'
'415':
$ref: '#/components/responses/FourFifteenError'
default:
$ref: '#/components/responses/DefaultError'
post:
tags:
- Authentications
summary: Create Authentication
operationId: Authentications_createNewAuthentication
description: >-
Creates a new Authentication for the provided App.
This endpoint requires the `authentication:write` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
requestBody:
description: Inputs to create a new Authentication
required: true
content:
application/vnd.api+json:
schema:
$ref: >-
#/components/schemas/AuthenticationsCreateNewAuthenticationRequest
responses:
'201':
description: A successful response to create a new Authentication
content:
application/vnd.api+json:
schema:
$ref: >-
#/components/schemas/AuthenticationsCreateNewAuthenticationResponse
examples:
AuthenticationsExample:
value:
links:
next: null
prev: null
meta:
limit: 10
offset: 0
count: 1
data:
- title: SuperExampleCRM (example@zapier.com)
type: authentication
id: b3eYnwlX
app: b61ae76e-487b-4622-8679-df3d3e20bccc
is_expired: false
'406':
$ref: '#/components/responses/FourOhSixError'
'415':
$ref: '#/components/responses/FourFifteenError'
default:
$ref: '#/components/responses/DefaultError'
/actions/{action}/inputs:
parameters:
- $ref: '#/components/parameters/action'
post:
tags:
- Actions
summary: Get Input Fields
operationId: Actions_getInputFields
description: >-
Get the Input Fields for a particular Action, using the provided
authentication and inputs.
This endpoint requires the `zap:write` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
parameters: []
requestBody:
$ref: '#/components/requestBodies/Inputs'
examples:
Example 1:
value:
authentication: b3eYnwl
inputs:
deal_pipeline: My Awesome Pipeline
limit: 10
offset: 0
responses:
'200':
description: >-
A successful response for getting the input fields for a particular
Action.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsGetInputFieldsResponse'
'404':
$ref: '#/components/responses/FourOhFourError'
'406':
$ref: '#/components/responses/FourOhSixError'
'415':
$ref: '#/components/responses/FourFifteenError'
default:
$ref: '#/components/responses/DefaultError'
x-internal: false
/actions/{action}/outputs:
parameters:
- $ref: '#/components/parameters/action'
post:
tags:
- Actions
summary: Get Output Fields
operationId: Actions_getOutputFields
description: >-
Get the Output Fields for a particular Action, using the provided
authentication and inputs.
This endpoint requires the `zap:write` OAuth scope.
This API is rate limited by IP address (60 requests per min).
parameters: []
requestBody:
$ref: '#/components/requestBodies/Outputs'
examples:
Example 1:
value:
authentication: b3eYnwl
fetch_live_samples: true
inputs:
deal_pipeline: My Awesome Pipeline
limit: 10
offset: 0
responses:
'200':
description: A successful request to get the Output Fields for an Action.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsGetOutputFieldsResponse'
examples:
OutputFieldsExample:
value:
meta:
limit: 10
offset: 0
count: 1
data:
- title: First Name
type: output_field
id: first_name
sample: Wade
'404':
$ref: '#/components/responses/FourOhFourError'
'406':
$ref: '#/components/responses/FourOhSixError'
'415':
$ref: '#/components/responses/FourFifteenError'
default:
$ref: '#/components/responses/DefaultError'
x-internal: false
/actions/{action}/inputs/{input}/choices:
parameters:
- description: An Action ID, as provided by the `/actions` endpoint.
name: action
in: path
required: true
schema:
type: string
example: uag:87b1c14e-ef30-43d5-9395-6c6514dbb123
- description: An Input Field ID, as provided by the `/inputs` endpoint.
schema:
type: string
example: lead_id
name: input
in: path
required: true
post:
tags:
- Actions
summary: Get Choices
operationId: Actions_getChoices
description: >-
Get the possible values for an Input Field that is marked as `SELECT`.
This endpoint requires the `zap` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
parameters:
- description: The page of choices to return, defaults to the first
schema:
type: string
default: '1'
example: '1'
in: query
name: page
requestBody:
description: ''
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsGetChoicesRequest'
responses:
'200':
description: A successful response for getting the requested Input Fields.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsGetChoicesResponse'
examples:
GetChoicesExample:
value:
meta:
page: 10
data:
- type: choice
id: usa
label: United States of America
value: usa
'404':
$ref: '#/components/responses/FourOhFourError'
'406':
$ref: '#/components/responses/FourOhSixError'
'415':
$ref: '#/components/responses/FourFifteenError'
default:
$ref: '#/components/responses/DefaultError'
x-internal: false
/apps:
parameters: []
get:
tags:
- Apps
summary: Get Apps
operationId: Apps_listPopular
security:
- OAuth2: []
description: >-
This endpoint returns a list of popular apps. Keep in mind that Zapier
built-in apps will not be returned and the order of the result is by app
popularity.
This endpoint requires the `zap` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
parameters:
- description: Used for paginating results. Specifies the amount of apps to return.
schema:
type: integer
in: query
name: limit
- description: >-
Used for paginating results. Specifies the offset of the apps to
return.
schema:
type: integer
in: query
name: offset
- description: >-
Categories that apps must have in order to be returned in the
response. E.g. Accounting (`accounting`), AI Tools (`ai-tools`), and
All (`all`).
The full list of valid categories can be retrieved using the
`category` endpoint, detailed
[here](https://platform.zapier.com/embed/partner-api#get-v1categories).
schema:
type: string
in: query
name: category
- description: >-
Parameter to limit the results to apps whose titles match the
provided query.
schema:
type: string
in: query
name: query
- description: >-
Parameter to restrict the results to apps whose ID matches those in
the provided comma-separated value. Cannot be combined with
`category`.
schema:
type: string
in: query
name: ids
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AppsListPopularResponse'
examples:
GetAppsExample:
value:
data:
- title: HubSpot
description: >-
HubSpot is your all-in-one stop for all of your
marketing software needs.
type: app
id: 1e4fcbf4-d80b-4ec3-b33b-c085f1ecbbaa
categories:
- slug: partners
hex_color: 8bcbca
image: >-
https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&ixlib=python-3.0.0&q=50
images:
url_16x16: >-
https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=16&ixlib=python-3.0.0&q=50&w=16
url_32x32: >-
https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=32&ixlib=python-3.0.0&q=50&w=32
url_64x64: >-
https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=64&ixlib=python-3.0.0&q=50&w=64
url_128x128: >-
https://zapier-images.imgix.net/storage/developer/cde9764aa8d19fdd6d591455dbe5a78d.png?auto=format%2Ccompress&fit=crop&h=128&ixlib=python-3.0.0&q=50&w=128
links:
connect_new_authentication: >-
https://zapier.com/engine/auth/start/HubSpotCLIAPI@1.7.1?redirect=https%3A%2F%2Fapi.zapier.com%2Fv2%2Fauthentications%2Fredirect
links:
next: https://api.zapier.com/v2/apps?offset=20&limit=10
prev: https://api.zapier.com/v2/apps?offset=0&limit=10
meta:
limit: 10
offset: 10
count: 133
'401':
description: Unauthorized
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/AppsListPopular401Response'
default:
$ref: '#/components/responses/DefaultError'
/zap-runs:
parameters: []
get:
tags:
- Experimental
summary: Get Zap Runs
operationId: Experimental_getZapRuns
description: >-
This endpoint is a first version tool that delivers basic yet essential
details about their executed Zap runs. As an evolving interface, this
first version serves foundational information about Zap runs.
_However, it's important to note that this is an initial implementation
and the **response payload is not definitive**. Our aim is to
continually iterate and enhance this API, refining its capabilities and
data output, to progressively deliver more valuable and useful
information in future versions._
This endpoint requires the `zap:runs` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
Please note that since this is an experimental tool, if you're
interested in gaining access, you must contact our support team.
parameters:
- description: >-
Find Zap runs equal to or newer than this date. If not provided,
results default to last 30 days' Zap Runs.
schema:
type: string
example: '2024-01-01T10:09:08.07'
in: query
name: from_date
- description: Find Zap runs less than this date.
schema:
type: string
example: '2023-01-02T11:10:09.08'
in: query
name: to_date
- description: Find Zap runs for the specified Zap ID.
schema:
type: string
example: 001fa849-dc8e-aca6-a09b-ba705bceada1
in: query
name: zap_id
- description: Maximum number of returned Zap Runs.
schema:
type: integer
example: 10
in: query
name: limit
- description: Number of Zap Runs to skip.
schema:
type: integer
example: 10
in: query
name: offset
- description: >-
Performs a text search against the `zap_title`, `data_in`, and
`data_out` fields, returning only zap runs that match the specified
keywords.
schema:
type: string
maxLength: 150
in: query
name: search
- description: >-
Accepts one or more status values separated by commas, enabling the
filtering of zap runs based on the specified status or statuses
provided.
schema:
type: string
example: throttled
enum:
- delayed
- scheduled
- pending
- error
- error_handled
- halted
- throttled
- held
- filtered
- skipped
- success
in: query
name: statuses
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentalGetZapRunsResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentalGetZapRuns401Response'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ExperimentalGetZapRuns403Response'
x-internal: false
/zaps:
parameters: []
get:
tags:
- Zaps
summary: Get Zaps
operationId: Zaps_getFilteredZaps
description: >-
This endpoint returns a list of Zaps for the authenticated Zapier user.
The `expand` array can be used to expand selected fields into full
objects in the response. Inputs with keys can also be passed to filter
Zaps by certain criteria.
This endpoint requires the `zap` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
parameters:
- description: Used for paginating results. Specifies the amount of apps to return
schema:
type: integer
in: query
name: limit
- description: >-
Used for paginating results. Specifies the offset of the apps to
return
schema:
type: integer
in: query
name: offset
- description: >-
You may pass inputs[KEY]=VALUE1,VALUE2 to filter for Zaps that
contain those settings. For example, if your OAuth app is Trello you
may filter for Zaps that contain a certain Trello board using
inputs[board]=BOARD_ID — Keys are defined by your app on the
developer platform.
schema:
type: object
additionalProperties:
type: string
in: query
name: inputs
style: deepObject
allowReserved: true
- description: >-
A comma separated list of Zap fields that should be expanded from
ids to full objects in the response. If a field may not be expanded,
its encoded form will be returned instead.
schema:
type: string
example: steps.action
in: query
name: expand
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ZapsGetFilteredZapsResponse'
examples:
GetZapsExample:
value:
links:
next: https://api.zapier.com/v2/zaps?offset=20&limit=10
prev: https://api.zapier.com/v2/zaps?offset=0&limit=10
meta:
limit: 10
offset: 10
count: 133
data:
- title: My Zap
type: zap
id: 00000000-0000-c000-8000-000000012345
is_enabled: false
last_successful_run_date: '2019-08-24T14:15:22Z'
steps:
- action: uag:1f188536-6dd0-4172-8414-2b90914ddee9
inputs:
deal_stage: CLOSED_WON
authentication: b3eYnwl
- action: uag:1f188536-6dd0-4172-8414-2b90914ddaa7
inputs:
full_name: '{{customer__full_name}}'
authentication: BRn9rRg
links:
html_editor: >-
https://zapier.com/webintent/edit-zap/00000000-0000-c000-8000-000000012345
updated_at: '2019-08-24T14:15:22Z'
'401':
description: Unauthorized
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ZapsGetFilteredZaps401Response'
'403':
description: Forbidden
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ZapsGetFilteredZaps403Response'
default:
$ref: '#/components/responses/DefaultError'
post:
tags:
- Zaps
summary: Create a Zap
operationId: Zaps_createZap
description: >-
This URL creates a new Zap based on a series of steps and a given title.
`is_enabled` must be set to true when creating a new Zap.
This endpoint requires the `zap:write` OAuth scope.
This API is rate limited by IP address (60 requests per min), or partner
(150 requests per min), whichever occurs first.
parameters:
- description: >-
A comma separated list of Zap fields that should be expanded from
ids to full objects in the response. If a field may not be expanded,
its encoded form will be returned instead.
schema:
type: string
in: query
name: expand
requestBody:
description: ''
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ZapsCreateZapRequest'
responses:
'201':
description: Created
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ZapsCreateZapResponse'
default:
$ref: '#/components/responses/DefaultError'
/actions/{action}/test:
parameters:
- description: An Action ID, as provided by the `/actions` endpoint.
schema:
type: string
name: action
in: path
required: true
post:
tags:
- Actions
summary: Test an action (step)
operationId: Actions_testActionExecution
description: >-
Tests the action (step) in the third party api, using the provided
authentication and inputs. On a successful test returns 200 and the
result of executing the action, otherwise it returns a 400 and details
about the failure.
This endpoint requires the `zap:write` OAuth scope.
This API is rate limited by IP address (60 requests per min).
requestBody:
$ref: '#/components/requestBodies/TestAction'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ActionsTestActionExecutionResponse'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsTestActionExecution200Response'
'404':
$ref: '#/components/responses/FourOhFourError'
'406':
$ref: '#/components/responses/FourOhSixError'
x-stoplight:
id: fgw9khltcrahx
components:
parameters:
limit:
description: >-
Used for paginating results. Specifies the maximum number of items to
return per page. If this value is not set, it defaults to 10.
name: limit
in: query
required: false
schema:
type: integer
default: 10
offset:
description: Used for paginating results. Specifies the offset to use.
name: offset
in: query
required: false
schema:
type: integer
app:
description: A canonical App ID, as provided by the `/apps` endpoint.
name: app
in: query
required: true
schema:
type: string
format: uuid
example: 868f9d3c-2ea0-4f19-a32d-a61b276ab8de
action:
description: An Action ID, as provided by the `/actions` endpoint.
name: action
in: path
required: true
schema:
type: string
example: uag:87b1c14e-ef30-43d5-9395-6c6514dbb123
action_type:
description: The type of Action to filter for.
name: action_type
in: query
required: true
schema:
type: string
enum:
- READ
- WRITE
example: READ
responses:
DefaultError:
description: An unexpected error has occurred but details are available.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsListAvailableActionsdefaultResponse'
FourOhSixError:
description: This request is invalid.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsListAvailableActions406Response'
FourFifteenError:
description: This media type is unsupported.
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsListAvailableActions415Response'
FourOhFourError:
description: Not found
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/ActionsListAvailableActions404Response'
schemas:
InputsWithAuthenticationId:
description: The common data object that includes inputs and an authentication id.
type: object
properties:
authentication:
description: >-
An Authentication ID, as provided by the `/authentications`
endpoint.
type:
- string
- 'null'
x-stoplight:
id: x4243l2r0sn61
inputs:
description: >-
The current set of input fields in a JSON object, where each key is
the `id` of an Input Field, and the corresponding value the current
value of the field.
type: object
limit:
description: >-
Used for paginating results. Specifies the maximum number of items
to return per page.
type: integer
format: int32
offset:
description: Used for paginating results. Specifies the offset to use.
type: integer
format: int32
required:
- authentication
- inputs
examples:
authentication: BRn9rRg
inputs:
stage_name: CLOSED_WON
limit: 10
offset: 20
InputsWithAuthenticationIdAndFetchLiveSamples:
title: InputsWithAuthenticationIdAndFetchLiveSamples
description: The common data object that includes inputs and an authentication id.
x-stoplight:
id: slf9f11zlbpep
type: object
examples:
authentication: BRn9rRg
inputs:
stage_name: CLOSED_WON
limit: 10
offset: 20
properties:
authentication:
description: >-
An Authentication ID, as provided by the `/authentications`
endpoint.
type:
- string
- 'null'
inputs:
description: >-
The current set of input fields in a JSON object, where each key is
the `id` of an Input Field, and the corresponding value the current
value of the field.
type: object
fetch_live_samples:
description: Whether to retrieve live samples for the field
type: boolean
x-stoplight:
id: sztwd2jml2g66
default: false
required:
- authentication
- inputs
Links:
title: Links
description: The links object returned in paginated response bodies.
x-stoplight:
id: g3mw8odxd2a5b
type: object
properties:
next:
description: The URL of the next page of paginated results.
type:
- string
- 'null'
x-stoplight:
id: w5nhbvv8b1r4r
format: uri
pattern: ^https:\/\/api\.zapier\.com\/.*
example: https://api.zapier.com/v2/apps?offset=20&limit=10
readOnly: true
nullable: true
default: null
prev:
description: The URL of the previous page of paginated results.
type:
- string
- 'null'
x-stoplight:
id: 3rs1teh1vdfoz
format: uri
pattern: ^https:\/\/api\.zapier\.com\/.*
example: https://api.zapier.com/v2/apps?offset=0&limit=10
readOnly: true
nullable: true
default: null
Meta:
title: Meta
description: The meta object returned in paginated response bodies.
x-stoplight:
id: msk45ygr2wrc8
type: object
properties:
limit:
description: The limit value used in the request.
type: integer
x-stoplight:
id: 2fm9jmi21w2gp
minimum: 1
example: 10
readOnly: true
format: int32
offset:
description: The offset value used in the request.
type: integer
x-stoplight:
id: eio99why05ylu
minimum: 0
default: 0
example: 10
format: int32
count:
description: >-
The total number of objects in the collection represented by the
endpoint.
type: integer
x-stoplight:
id: nh8w20vy7kwk4
minimum: 0
example: 133
readOnly: true
format: int32
LinksWithPage:
title: LinksWithPage
description: The links object returned in paginated response bodies.
x-stoplight:
id: xzqnni6w46yxz
type: object
properties:
next:
description: The URL of the next page of paginated results.
type:
- string