@zapier/zapier-sdk 0.48.0 → 0.48.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +740 -283
  3. package/dist/index.cjs +5 -2
  4. package/dist/index.mjs +5 -2
  5. package/dist/plugins/listInputFields/index.js +1 -1
  6. package/dist/plugins/tables/createTableFields/index.d.ts.map +1 -1
  7. package/dist/plugins/tables/createTableFields/index.js +1 -0
  8. package/dist/plugins/tables/createTableRecords/index.d.ts.map +1 -1
  9. package/dist/plugins/tables/createTableRecords/index.js +1 -0
  10. package/dist/plugins/tables/updateTableRecords/index.d.ts.map +1 -1
  11. package/dist/plugins/tables/updateTableRecords/index.js +1 -0
  12. package/package.json +1 -1
package/README.md CHANGED
@@ -394,6 +394,17 @@ Get current user's profile information
394
394
 
395
395
  **Returns:** `Promise<ProfileItem>`
396
396
 
397
+ | Name | Type | Required | Possible Values | Description |
398
+ | --------------------- | --------- | -------- | --------------- | ----------- |
399
+ | `data` | `object` | ✅ | — | |
400
+ | ​ ↳ `id` | `string` | ✅ | — | |
401
+ | ​ ↳ `first_name` | `string` | ✅ | — | |
402
+ | ​ ↳ `last_name` | `string` | ✅ | — | |
403
+ | ​ ↳ `full_name` | `string` | ✅ | — | |
404
+ | ​ ↳ `email` | `string` | ✅ | — | |
405
+ | ​ ↳ `email_confirmed` | `boolean` | ✅ | — | |
406
+ | ​ ↳ `timezone` | `string` | ✅ | — | |
407
+
397
408
  **Example:**
398
409
 
399
410
  ```typescript
@@ -408,22 +419,36 @@ Get detailed information about a specific action
408
419
 
409
420
  **Parameters:**
410
421
 
411
- | Name | Type | Required | Default | Possible Values | Description |
412
- | -------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
413
- | `options` | `object` | ✅ | — | — | |
414
- | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
415
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
416
- | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
422
+ | Name | Type | Required | Default | Possible Values | Description |
423
+ | ---------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
424
+ | `options` | `object` | ✅ | — | — | |
425
+ | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
426
+ | ​ ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
427
+ | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
417
428
 
418
429
  **Returns:** `Promise<ActionItem>`
419
430
 
431
+ | Name | Type | Required | Possible Values | Description |
432
+ | ------------------ | --------- | -------- | ---------------------------------------------------------------------------------------------- | ----------- |
433
+ | `data` | `object` | ✅ | — | |
434
+ | ​ ↳ `id` | `string` | ❌ | — | |
435
+ | ​ ↳ `key` | `string` | ✅ | — | |
436
+ | ​ ↳ `description` | `string` | ✅ | — | |
437
+ | ​ ↳ `is_important` | `boolean` | ❌ | — | |
438
+ | ​ ↳ `is_hidden` | `boolean` | ❌ | — | |
439
+ | ​ ↳ `app_key` | `string` | ✅ | — | |
440
+ | ​ ↳ `app_version` | `string` | ❌ | — | |
441
+ | ​ ↳ `action_type` | `string` | ✅ | `filter`, `read`, `read_bulk`, `run`, `search`, `search_and_write`, `search_or_write`, `write` | |
442
+ | ​ ↳ `title` | `string` | ✅ | — | |
443
+ | ​ ↳ `type` | `string` | ✅ | `action` | |
444
+
420
445
  **Example:**
421
446
 
422
447
  ```typescript
423
448
  const { data: action } = await zapier.getAction({
424
- app: "example-value",
449
+ app: "example-app",
425
450
  actionType: "read",
426
- action: "example-value",
451
+ action: "example-action",
427
452
  });
428
453
  ```
429
454
 
@@ -433,14 +458,14 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
433
458
 
434
459
  **Parameters:**
435
460
 
436
- | Name | Type | Required | Default | Possible Values | Description |
437
- | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
438
- | `options` | `object` | ✅ | — | — | |
439
- | ↳ `app` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
440
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
441
- | ↳ `action` | `string` | ✅ | — | — | Action key to get the input schema for |
442
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
443
- | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
461
+ | Name | Type | Required | Default | Possible Values | Description |
462
+ | ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
463
+ | `options` | `object` | ✅ | — | — | |
464
+ | ​ ↳ `app` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
465
+ | ​ ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
466
+ | ​ ↳ `action` | `string` | ✅ | — | — | Action key to get the input schema for |
467
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
468
+ | ​ ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
444
469
 
445
470
  **Returns:** `Promise<InputSchemaItem>`
446
471
 
@@ -448,9 +473,9 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
448
473
 
449
474
  ```typescript
450
475
  const { data: inputSchema } = await zapier.getInputFieldsSchema({
451
- app: "example-value",
476
+ app: "example-app",
452
477
  actionType: "read",
453
- action: "example-value",
478
+ action: "example-action",
454
479
  });
455
480
  ```
456
481
 
@@ -460,28 +485,43 @@ List all actions for a specific app
460
485
 
461
486
  **Parameters:**
462
487
 
463
- | Name | Type | Required | Default | Possible Values | Description |
464
- | -------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
465
- | `options` | `object` | ✅ | — | — | |
466
- | ↳ `app` | `string` | ✅ | — | — | App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github') |
467
- | ↳ `actionType` | `string` | ❌ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Filter actions by type |
468
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of actions per page |
469
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
470
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
488
+ | Name | Type | Required | Default | Possible Values | Description |
489
+ | ---------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
490
+ | `options` | `object` | ✅ | — | — | |
491
+ | ​ ↳ `app` | `string` | ✅ | — | — | App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github') |
492
+ | ​ ↳ `actionType` | `string` | ❌ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Filter actions by type |
493
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of actions per page |
494
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
495
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
471
496
 
472
497
  **Returns:** `Promise<PaginatedResult<ActionItem>>`
473
498
 
499
+ | Name | Type | Required | Possible Values | Description |
500
+ | ------------------ | ---------- | -------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
501
+ | `data[]` | `object[]` | ✅ | — | |
502
+ | ​ ↳ `id` | `string` | ❌ | — | |
503
+ | ​ ↳ `key` | `string` | ✅ | — | |
504
+ | ​ ↳ `description` | `string` | ✅ | — | |
505
+ | ​ ↳ `is_important` | `boolean` | ❌ | — | |
506
+ | ​ ↳ `is_hidden` | `boolean` | ❌ | — | |
507
+ | ​ ↳ `app_key` | `string` | ✅ | — | |
508
+ | ​ ↳ `app_version` | `string` | ❌ | — | |
509
+ | ​ ↳ `action_type` | `string` | ✅ | `filter`, `read`, `read_bulk`, `run`, `search`, `search_and_write`, `search_or_write`, `write` | |
510
+ | ​ ↳ `title` | `string` | ✅ | — | |
511
+ | ​ ↳ `type` | `string` | ✅ | `action` | |
512
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
513
+
474
514
  **Example:**
475
515
 
476
516
  ```typescript
477
517
  // Get first page and a cursor for the second page
478
518
  const { data: actions, nextCursor } = await zapier.listActions({
479
- app: "example-value",
519
+ app: "example-app",
480
520
  });
481
521
 
482
522
  // Or iterate over all pages
483
523
  for await (const page of zapier.listActions({
484
- app: "example-value",
524
+ app: "example-app",
485
525
  })) {
486
526
  // Do something with each page
487
527
  }
@@ -489,7 +529,7 @@ for await (const page of zapier.listActions({
489
529
  // Or iterate over individual items across all pages
490
530
  for await (const action of zapier
491
531
  .listActions({
492
- app: "example-value",
532
+ app: "example-app",
493
533
  })
494
534
  .items()) {
495
535
  // Do something with each action
@@ -502,40 +542,49 @@ Get the available choices for a dynamic dropdown input field
502
542
 
503
543
  **Parameters:**
504
544
 
505
- | Name | Type | Required | Default | Possible Values | Description |
506
- | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
507
- | `options` | `object` | ✅ | — | — | |
508
- | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
509
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
510
- | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
511
- | ↳ `inputField` | `string` | ✅ | — | — | Input field key to get choices for |
512
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
513
- | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
514
- | ↳ `page` | `number` | ❌ | — | — | Page number for paginated results |
515
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of choices per page |
516
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
517
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
545
+ | Name | Type | Required | Default | Possible Values | Description |
546
+ | ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
547
+ | `options` | `object` | ✅ | — | — | |
548
+ | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
549
+ | ​ ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
550
+ | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
551
+ | ​ ↳ `inputField` | `string` | ✅ | — | — | Input field key to get choices for |
552
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
553
+ | ​ ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
554
+ | ​ ↳ `page` | `number` | ❌ | — | — | Page number for paginated results |
555
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of choices per page |
556
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
557
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
518
558
 
519
559
  **Returns:** `Promise<PaginatedResult<InputFieldChoiceItem>>`
520
560
 
561
+ | Name | Type | Required | Possible Values | Description |
562
+ | ------------ | ---------- | -------- | --------------- | -------------------------------------------------------------- |
563
+ | `data[]` | `object[]` | ✅ | — | |
564
+ | ​ ↳ `key` | `string` | ❌ | — | |
565
+ | ​ ↳ `label` | `string` | ❌ | — | |
566
+ | ​ ↳ `sample` | `string` | ❌ | — | |
567
+ | ​ ↳ `value` | `string` | ❌ | — | |
568
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
569
+
521
570
  **Example:**
522
571
 
523
572
  ```typescript
524
573
  // Get first page and a cursor for the second page
525
574
  const { data: inputFieldChoices, nextCursor } =
526
575
  await zapier.listInputFieldChoices({
527
- app: "example-value",
576
+ app: "example-app",
528
577
  actionType: "read",
529
- action: "example-value",
530
- inputField: "example-value",
578
+ action: "example-action",
579
+ inputField: "example-input-field",
531
580
  });
532
581
 
533
582
  // Or iterate over all pages
534
583
  for await (const page of zapier.listInputFieldChoices({
535
- app: "example-value",
584
+ app: "example-app",
536
585
  actionType: "read",
537
- action: "example-value",
538
- inputField: "example-value",
586
+ action: "example-action",
587
+ inputField: "example-input-field",
539
588
  })) {
540
589
  // Do something with each page
541
590
  }
@@ -543,10 +592,10 @@ for await (const page of zapier.listInputFieldChoices({
543
592
  // Or iterate over individual items across all pages
544
593
  for await (const inputFieldChoice of zapier
545
594
  .listInputFieldChoices({
546
- app: "example-value",
595
+ app: "example-app",
547
596
  actionType: "read",
548
- action: "example-value",
549
- inputField: "example-value",
597
+ action: "example-action",
598
+ inputField: "example-input-field",
550
599
  })
551
600
  .items()) {
552
601
  // Do something with each inputFieldChoice
@@ -559,48 +608,89 @@ Get the input fields required for a specific action
559
608
 
560
609
  **Parameters:**
561
610
 
562
- | Name | Type | Required | Default | Possible Values | Description |
563
- | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
564
- | `options` | `object` | ✅ | — | — | |
565
- | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
566
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
567
- | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
568
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
569
- | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
570
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of input fields per page |
571
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
572
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
573
-
574
- **Returns:** `Promise<PaginatedResult<RootFieldItemItem>>`
611
+ | Name | Type | Required | Default | Possible Values | Description |
612
+ | ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
613
+ | `options` | `object` | ✅ | — | — | |
614
+ | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
615
+ | ​ ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
616
+ | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
617
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
618
+ | ​ ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
619
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of input fields per page |
620
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
621
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
622
+
623
+ **Returns:** `Promise<PaginatedResult<RootFieldItem>>`
624
+
625
+ | Name | Type | Required | Possible Values | Description |
626
+ | ------------ | ---------- | -------- | --------------- | -------------------------------------------------------------- |
627
+ | `data[]` | `object[]` | ✅ | — | One of the variants below, distinguished by `type` |
628
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
629
+
630
+ **When `type` is `"input_field"`:**
631
+
632
+ | Name | Type | Required | Possible Values | Description |
633
+ | -------------------------- | --------- | -------- | --------------- | ----------- |
634
+ | `type` | `string` | ✅ | `input_field` | |
635
+ | `key` | `string` | ✅ | — | |
636
+ | `default_value` | `string` | ✅ | — | |
637
+ | `depends_on` | `array` | ✅ | — | |
638
+ | `description` | `string` | ✅ | — | |
639
+ | `invalidates_input_fields` | `boolean` | ✅ | — | |
640
+ | `is_required` | `boolean` | ✅ | — | |
641
+ | `placeholder` | `string` | ✅ | — | |
642
+ | `title` | `string` | ✅ | — | |
643
+ | `value_type` | `string` | ✅ | — | |
644
+ | `format` | `string` | ❌ | — | |
645
+ | `items` | `object` | ❌ | — | |
646
+ | ​ ↳ `type` | `string` | ✅ | — | |
647
+
648
+ **When `type` is `"info_field"`:**
649
+
650
+ | Name | Type | Required | Possible Values | Description |
651
+ | ------------- | -------- | -------- | --------------- | ----------- |
652
+ | `type` | `string` | ✅ | `info_field` | |
653
+ | `key` | `string` | ✅ | — | |
654
+ | `description` | `string` | ✅ | — | |
655
+ | `title` | `string` | ❌ | — | |
656
+
657
+ **When `type` is `"fieldset"`:**
658
+
659
+ | Name | Type | Required | Possible Values | Description |
660
+ | -------- | -------- | -------- | --------------- | ----------- |
661
+ | `type` | `string` | ✅ | `fieldset` | |
662
+ | `key` | `string` | ✅ | — | |
663
+ | `title` | `string` | ✅ | — | |
664
+ | `fields` | `array` | ✅ | — | |
575
665
 
576
666
  **Example:**
577
667
 
578
668
  ```typescript
579
669
  // Get first page and a cursor for the second page
580
- const { data: rootFieldItems, nextCursor } = await zapier.listInputFields({
581
- app: "example-value",
670
+ const { data: rootFields, nextCursor } = await zapier.listInputFields({
671
+ app: "example-app",
582
672
  actionType: "read",
583
- action: "example-value",
673
+ action: "example-action",
584
674
  });
585
675
 
586
676
  // Or iterate over all pages
587
677
  for await (const page of zapier.listInputFields({
588
- app: "example-value",
678
+ app: "example-app",
589
679
  actionType: "read",
590
- action: "example-value",
680
+ action: "example-action",
591
681
  })) {
592
682
  // Do something with each page
593
683
  }
594
684
 
595
685
  // Or iterate over individual items across all pages
596
- for await (const rootFieldItem of zapier
686
+ for await (const rootField of zapier
597
687
  .listInputFields({
598
- app: "example-value",
688
+ app: "example-app",
599
689
  actionType: "read",
600
- action: "example-value",
690
+ action: "example-action",
601
691
  })
602
692
  .items()) {
603
- // Do something with each rootFieldItem
693
+ // Do something with each rootField
604
694
  }
605
695
  ```
606
696
 
@@ -610,18 +700,18 @@ Execute an action with the given inputs
610
700
 
611
701
  **Parameters:**
612
702
 
613
- | Name | Type | Required | Default | Possible Values | Description |
614
- | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
615
- | `options` | `object` | ✅ | — | — | |
616
- | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
617
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
618
- | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
619
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
620
- | ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the action |
621
- | ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
622
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of results per page |
623
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
624
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
703
+ | Name | Type | Required | Default | Possible Values | Description |
704
+ | ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
705
+ | `options` | `object` | ✅ | — | — | |
706
+ | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
707
+ | ​ ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
708
+ | ​ ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
709
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. Mutually exclusive with connectionId. |
710
+ | ​ ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the action |
711
+ | ​ ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
712
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of results per page |
713
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
714
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
625
715
 
626
716
  **Returns:** `Promise<PaginatedResult<ActionResultItem>>`
627
717
 
@@ -630,16 +720,16 @@ Execute an action with the given inputs
630
720
  ```typescript
631
721
  // Get first page and a cursor for the second page
632
722
  const { data: actionResults, nextCursor } = await zapier.runAction({
633
- app: "example-value",
723
+ app: "example-app",
634
724
  actionType: "read",
635
- action: "example-value",
725
+ action: "example-action",
636
726
  });
637
727
 
638
728
  // Or iterate over all pages
639
729
  for await (const page of zapier.runAction({
640
- app: "example-value",
730
+ app: "example-app",
641
731
  actionType: "read",
642
- action: "example-value",
732
+ action: "example-action",
643
733
  })) {
644
734
  // Do something with each page
645
735
  }
@@ -647,9 +737,9 @@ for await (const page of zapier.runAction({
647
737
  // Or iterate over individual items across all pages
648
738
  for await (const actionResult of zapier
649
739
  .runAction({
650
- app: "example-value",
740
+ app: "example-app",
651
741
  actionType: "read",
652
- action: "example-value",
742
+ action: "example-action",
653
743
  })
654
744
  .items()) {
655
745
  // Do something with each actionResult
@@ -664,10 +754,10 @@ Bind a connection alias or numeric connectionId to an app
664
754
 
665
755
  **Parameters:**
666
756
 
667
- | Name | Type | Required | Default | Possible Values | Description |
668
- | -------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
669
- | `options` | `object` | ✅ | — | — | |
670
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
757
+ | Name | Type | Required | Default | Possible Values | Description |
758
+ | ---------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
759
+ | `options` | `object` | ✅ | — | — | |
760
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
671
761
 
672
762
  **Returns:** `Promise<AppProxy>`
673
763
 
@@ -683,12 +773,12 @@ Execute an action with the given inputs for the bound app, as an alternative to
683
773
 
684
774
  **Parameters:**
685
775
 
686
- | Name | Type | Required | Default | Possible Values | Description |
687
- | -------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
688
- | `options` | `object` | ✅ | — | — | |
689
- | ↳ `inputs` | `object` | ❌ | — | — | |
690
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
691
- | ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
776
+ | Name | Type | Required | Default | Possible Values | Description |
777
+ | ---------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
778
+ | `options` | `object` | ✅ | — | — | |
779
+ | ​ ↳ `inputs` | `object` | ❌ | — | — | |
780
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
781
+ | ​ ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
692
782
 
693
783
  **Returns:** `Promise<PaginatedResult<ActionResultItem>>`
694
784
 
@@ -721,15 +811,67 @@ Get detailed information about a specific app
721
811
  | Name | Type | Required | Default | Possible Values | Description |
722
812
  | --------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
723
813
  | `options` | `object` | ✅ | — | — | |
724
- | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
814
+ | ​ ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
725
815
 
726
816
  **Returns:** `Promise<AppItem>`
727
817
 
818
+ | Name | Type | Required | Possible Values | Description |
819
+ | ---------------------------- | ---------- | -------- | --------------- | --------------------------------------------------- |
820
+ | `data` | `object` | ✅ | — | |
821
+ | ​ ↳ `slug` | `string` | ✅ | — | URL-friendly slug identifier |
822
+ | ​ ↳ `age_in_days` | `number` | ❌ | — | Number of days since the implementation was created |
823
+ | ​ ↳ `auth_type` | `string` | ❌ | — | Authentication type (e.g., oauth2, api_key) |
824
+ | ​ ↳ `banner` | `string` | ❌ | — | Banner message or status indicator |
825
+ | ​ ↳ `categories[]` | `object[]` | ❌ | — | Categories the implementation belongs to |
826
+ | ​   ↳ `id` | `number` | ✅ | — | Unique identifier for the category |
827
+ | ​   ↳ `name` | `string` | ✅ | — | Display name of the category |
828
+ | ​   ↳ `slug` | `string` | ✅ | — | URL-friendly slug for the category |
829
+ | ​ ↳ `images` | `object` | ❌ | — | Icon images at various sizes |
830
+ | ​   ↳ `url_16x16` | `string` | ❌ | — | 16x16 pixel icon URL |
831
+ | ​   ↳ `url_32x32` | `string` | ❌ | — | 32x32 pixel icon URL |
832
+ | ​   ↳ `url_64x64` | `string` | ❌ | — | 64x64 pixel icon URL |
833
+ | ​   ↳ `url_128x128` | `string` | ❌ | — | 128x128 pixel icon URL |
834
+ | ​ ↳ `popularity` | `number` | ❌ | — | Popularity score for ranking apps |
835
+ | ​ ↳ `has_filters` | `boolean` | ❌ | — | Whether the app has filter actions |
836
+ | ​ ↳ `has_reads` | `boolean` | ❌ | — | Whether the app has read actions |
837
+ | ​ ↳ `has_searches` | `boolean` | ❌ | — | Whether the app has search actions |
838
+ | ​ ↳ `has_searches_or_writes` | `boolean` | ❌ | — | Whether the app has search or write actions |
839
+ | ​ ↳ `has_upfront_fields` | `boolean` | ❌ | — | Whether the app has upfront input fields |
840
+ | ​ ↳ `has_writes` | `boolean` | ❌ | — | Whether the app has write actions |
841
+ | ​ ↳ `is_beta` | `boolean` | ❌ | — | Whether the app is in beta |
842
+ | ​ ↳ `is_built_in` | `boolean` | ❌ | — | Whether the app is a built-in Zapier app |
843
+ | ​ ↳ `is_deprecated` | `boolean` | ❌ | — | Whether the app is deprecated |
844
+ | ​ ↳ `is_featured` | `boolean` | ❌ | — | Whether the app is featured |
845
+ | ​ ↳ `is_hidden` | `boolean` | ❌ | — | Whether the app is hidden from listings |
846
+ | ​ ↳ `is_invite` | `boolean` | ❌ | — | Whether the app is invite-only |
847
+ | ​ ↳ `is_premium` | `boolean` | ❌ | — | Whether the app requires a premium plan |
848
+ | ​ ↳ `is_public` | `boolean` | ❌ | — | Whether the app is publicly available |
849
+ | ​ ↳ `is_upcoming` | `boolean` | ❌ | — | Whether the app is upcoming/not yet released |
850
+ | ​ ↳ `version` | `string` | ❌ | — | App version |
851
+ | ​ ↳ `visibility` | `string` | ❌ | — | Visibility status (e.g., public, private) |
852
+ | ​ ↳ `actions` | `object` | ❌ | — | Count of available actions by type |
853
+ | ​   ↳ `read` | `number` | ❌ | — | Number of read actions |
854
+ | ​   ↳ `read_bulk` | `number` | ❌ | — | Number of bulk read actions |
855
+ | ​   ↳ `write` | `number` | ❌ | — | Number of write actions |
856
+ | ​   ↳ `search` | `number` | ❌ | — | Number of search actions |
857
+ | ​   ↳ `search_or_write` | `number` | ❌ | — | Number of search-or-write actions |
858
+ | ​   ↳ `search_and_write` | `number` | ❌ | — | Number of search-and-write actions |
859
+ | ​   ↳ `filter` | `number` | ❌ | — | Number of filter actions |
860
+ | ​ ↳ `description` | `string` | ❌ | — | Description of the app |
861
+ | ​ ↳ `primary_color` | `string` | ❌ | — | Primary brand color (hex) |
862
+ | ​ ↳ `secondary_color` | `string` | ❌ | — | Secondary brand color (hex) |
863
+ | ​ ↳ `classification` | `string` | ❌ | — | App classification category |
864
+ | ​ ↳ `api_docs_url` | `string` | ❌ | — | URL to API documentation |
865
+ | ​ ↳ `image` | `string` | ❌ | — | Default image URL for the app |
866
+ | ​ ↳ `title` | `string` | ✅ | — | Display name of the app |
867
+ | ​ ↳ `key` | `string` | ✅ | — | App key (versionless implementation name) |
868
+ | ​ ↳ `implementation_id` | `string` | ✅ | — | Full implementation ID including version |
869
+
728
870
  **Example:**
729
871
 
730
872
  ```typescript
731
873
  const { data: app } = await zapier.getApp({
732
- app: "example-value",
874
+ app: "example-app",
733
875
  });
734
876
  ```
735
877
 
@@ -739,17 +881,70 @@ List all available apps with optional filtering
739
881
 
740
882
  **Parameters:**
741
883
 
742
- | Name | Type | Required | Default | Possible Values | Description |
743
- | ------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
744
- | `options` | `object` | ✅ | — | — | |
745
- | ↳ `search` | `string` | ❌ | — | — | Search term to filter apps by name |
746
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of apps per page |
747
- | ↳ `apps` | `array` | ❌ | — | — | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
748
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
749
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
884
+ | Name | Type | Required | Default | Possible Values | Description |
885
+ | -------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
886
+ | `options` | `object` | ✅ | — | — | |
887
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter apps by name |
888
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of apps per page |
889
+ | ​ ↳ `apps` | `array` | ❌ | — | — | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
890
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
891
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
750
892
 
751
893
  **Returns:** `Promise<PaginatedResult<AppItem>>`
752
894
 
895
+ | Name | Type | Required | Possible Values | Description |
896
+ | ---------------------------- | ---------- | -------- | --------------- | -------------------------------------------------------------- |
897
+ | `data[]` | `object[]` | ✅ | — | |
898
+ | ​ ↳ `slug` | `string` | ✅ | — | URL-friendly slug identifier |
899
+ | ​ ↳ `age_in_days` | `number` | ❌ | — | Number of days since the implementation was created |
900
+ | ​ ↳ `auth_type` | `string` | ❌ | — | Authentication type (e.g., oauth2, api_key) |
901
+ | ​ ↳ `banner` | `string` | ❌ | — | Banner message or status indicator |
902
+ | ​ ↳ `categories[]` | `object[]` | ❌ | — | Categories the implementation belongs to |
903
+ | ​   ↳ `id` | `number` | ✅ | — | Unique identifier for the category |
904
+ | ​   ↳ `name` | `string` | ✅ | — | Display name of the category |
905
+ | ​   ↳ `slug` | `string` | ✅ | — | URL-friendly slug for the category |
906
+ | ​ ↳ `images` | `object` | ❌ | — | Icon images at various sizes |
907
+ | ​   ↳ `url_16x16` | `string` | ❌ | — | 16x16 pixel icon URL |
908
+ | ​   ↳ `url_32x32` | `string` | ❌ | — | 32x32 pixel icon URL |
909
+ | ​   ↳ `url_64x64` | `string` | ❌ | — | 64x64 pixel icon URL |
910
+ | ​   ↳ `url_128x128` | `string` | ❌ | — | 128x128 pixel icon URL |
911
+ | ​ ↳ `popularity` | `number` | ❌ | — | Popularity score for ranking apps |
912
+ | ​ ↳ `has_filters` | `boolean` | ❌ | — | Whether the app has filter actions |
913
+ | ​ ↳ `has_reads` | `boolean` | ❌ | — | Whether the app has read actions |
914
+ | ​ ↳ `has_searches` | `boolean` | ❌ | — | Whether the app has search actions |
915
+ | ​ ↳ `has_searches_or_writes` | `boolean` | ❌ | — | Whether the app has search or write actions |
916
+ | ​ ↳ `has_upfront_fields` | `boolean` | ❌ | — | Whether the app has upfront input fields |
917
+ | ​ ↳ `has_writes` | `boolean` | ❌ | — | Whether the app has write actions |
918
+ | ​ ↳ `is_beta` | `boolean` | ❌ | — | Whether the app is in beta |
919
+ | ​ ↳ `is_built_in` | `boolean` | ❌ | — | Whether the app is a built-in Zapier app |
920
+ | ​ ↳ `is_deprecated` | `boolean` | ❌ | — | Whether the app is deprecated |
921
+ | ​ ↳ `is_featured` | `boolean` | ❌ | — | Whether the app is featured |
922
+ | ​ ↳ `is_hidden` | `boolean` | ❌ | — | Whether the app is hidden from listings |
923
+ | ​ ↳ `is_invite` | `boolean` | ❌ | — | Whether the app is invite-only |
924
+ | ​ ↳ `is_premium` | `boolean` | ❌ | — | Whether the app requires a premium plan |
925
+ | ​ ↳ `is_public` | `boolean` | ❌ | — | Whether the app is publicly available |
926
+ | ​ ↳ `is_upcoming` | `boolean` | ❌ | — | Whether the app is upcoming/not yet released |
927
+ | ​ ↳ `version` | `string` | ❌ | — | App version |
928
+ | ​ ↳ `visibility` | `string` | ❌ | — | Visibility status (e.g., public, private) |
929
+ | ​ ↳ `actions` | `object` | ❌ | — | Count of available actions by type |
930
+ | ​   ↳ `read` | `number` | ❌ | — | Number of read actions |
931
+ | ​   ↳ `read_bulk` | `number` | ❌ | — | Number of bulk read actions |
932
+ | ​   ↳ `write` | `number` | ❌ | — | Number of write actions |
933
+ | ​   ↳ `search` | `number` | ❌ | — | Number of search actions |
934
+ | ​   ↳ `search_or_write` | `number` | ❌ | — | Number of search-or-write actions |
935
+ | ​   ↳ `search_and_write` | `number` | ❌ | — | Number of search-and-write actions |
936
+ | ​   ↳ `filter` | `number` | ❌ | — | Number of filter actions |
937
+ | ​ ↳ `description` | `string` | ❌ | — | Description of the app |
938
+ | ​ ↳ `primary_color` | `string` | ❌ | — | Primary brand color (hex) |
939
+ | ​ ↳ `secondary_color` | `string` | ❌ | — | Secondary brand color (hex) |
940
+ | ​ ↳ `classification` | `string` | ❌ | — | App classification category |
941
+ | ​ ↳ `api_docs_url` | `string` | ❌ | — | URL to API documentation |
942
+ | ​ ↳ `image` | `string` | ❌ | — | Default image URL for the app |
943
+ | ​ ↳ `title` | `string` | ✅ | — | Display name of the app |
944
+ | ​ ↳ `key` | `string` | ✅ | — | App key (versionless implementation name) |
945
+ | ​ ↳ `implementation_id` | `string` | ✅ | — | Full implementation ID including version |
946
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
947
+
753
948
  **Example:**
754
949
 
755
950
  ```typescript
@@ -775,19 +970,26 @@ Create new client credentials for the authenticated user
775
970
 
776
971
  **Parameters:**
777
972
 
778
- | Name | Type | Required | Default | Possible Values | Description |
779
- | ----------------- | -------- | -------- | -------------- | --------------- | ---------------------------------------------- |
780
- | `options` | `object` | ✅ | — | — | |
781
- | ↳ `name` | `string` | ✅ | — | — | Human-readable name for the client credentials |
782
- | ↳ `allowedScopes` | `array` | ❌ | `["external"]` | — | Scopes to allow for these credentials |
973
+ | Name | Type | Required | Default | Possible Values | Description |
974
+ | ------------------- | -------- | -------- | -------------- | --------------- | ---------------------------------------------- |
975
+ | `options` | `object` | ✅ | — | — | |
976
+ | ​ ↳ `name` | `string` | ✅ | — | — | Human-readable name for the client credentials |
977
+ | ​ ↳ `allowedScopes` | `array` | ❌ | `["external"]` | — | Scopes to allow for these credentials |
783
978
 
784
- **Returns:** `Promise<any>`
979
+ **Returns:** `Promise<ClientCredentialsItem>`
980
+
981
+ | Name | Type | Required | Possible Values | Description |
982
+ | ------------------- | -------- | -------- | --------------- | ---------------------------------------------------------- |
983
+ | `data` | `object` | ✅ | — | |
984
+ | ​ ↳ `client_id` | `string` | ✅ | — | The public identifier (Client ID) of the OAuth application |
985
+ | ​ ↳ `name` | `string` | ✅ | — | Human-readable name of the OAuth application |
986
+ | ​ ↳ `client_secret` | `string` | ✅ | — | The client secret (only shown once on creation) |
785
987
 
786
988
  **Example:**
787
989
 
788
990
  ```typescript
789
991
  const result = await zapier.createClientCredentials({
790
- name: "example-value",
992
+ name: "example-name",
791
993
  });
792
994
  ```
793
995
 
@@ -797,18 +999,18 @@ Delete client credentials by client ID
797
999
 
798
1000
  **Parameters:**
799
1001
 
800
- | Name | Type | Required | Default | Possible Values | Description |
801
- | ------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------- |
802
- | `options` | `object` | ✅ | — | — | |
803
- | ↳ `clientId` | `string` | ✅ | — | — | The client ID of the client credentials to delete |
1002
+ | Name | Type | Required | Default | Possible Values | Description |
1003
+ | -------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------- |
1004
+ | `options` | `object` | ✅ | — | — | |
1005
+ | ​ ↳ `clientId` | `string` | ✅ | — | — | The client ID of the client credentials to delete |
804
1006
 
805
- **Returns:** `Promise<any>`
1007
+ **Returns:** `Promise<{ success: boolean }>`
806
1008
 
807
1009
  **Example:**
808
1010
 
809
1011
  ```typescript
810
1012
  const result = await zapier.deleteClientCredentials({
811
- clientId: "example-id",
1013
+ clientId: "example-client-id",
812
1014
  });
813
1015
  ```
814
1016
 
@@ -818,15 +1020,25 @@ List client credentials for the authenticated user
818
1020
 
819
1021
  **Parameters:**
820
1022
 
821
- | Name | Type | Required | Default | Possible Values | Description |
822
- | ------------ | -------- | -------- | ------- | --------------- | ---------------------------------------------- |
823
- | `options` | `object` | ✅ | — | — | |
824
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of credentials per page |
825
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
826
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
1023
+ | Name | Type | Required | Default | Possible Values | Description |
1024
+ | -------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------- |
1025
+ | `options` | `object` | ✅ | — | — | |
1026
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of credentials per page |
1027
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1028
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
827
1029
 
828
1030
  **Returns:** `Promise<PaginatedResult<ClientCredentialsItem>>`
829
1031
 
1032
+ | Name | Type | Required | Possible Values | Description |
1033
+ | -------------------- | ---------- | -------- | --------------- | ---------------------------------------------------------------- |
1034
+ | `data[]` | `object[]` | ✅ | — | |
1035
+ | ​ ↳ `client_id` | `string` | ✅ | — | The public identifier (Client ID) of the OAuth application |
1036
+ | ​ ↳ `name` | `string` | ✅ | — | Human-readable name of the OAuth application |
1037
+ | ​ ↳ `allowed_scopes` | `array` | ✅ | — | List of OAuth scopes that this application is allowed to request |
1038
+ | ​ ↳ `created_at` | `string` | ❌ | — | When the application was created (ISO 8601) |
1039
+ | ​ ↳ `updated_at` | `string` | ❌ | — | When the application was last updated (ISO 8601) |
1040
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1041
+
830
1042
  **Example:**
831
1043
 
832
1044
  ```typescript
@@ -853,19 +1065,50 @@ Find the first connection matching the criteria
853
1065
 
854
1066
  **Parameters:**
855
1067
 
856
- | Name | Type | Required | Default | Possible Values | Description |
857
- | ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
858
- | `options` | `object` | ✅ | — | — | |
859
- | ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
860
- | ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
861
- | ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
862
- | ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
863
- | ↳ `account` | `string` | ❌ | — | — | Account to filter by |
864
- | ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
865
- | ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
1068
+ | Name | Type | Required | Default | Possible Values | Description |
1069
+ | ------------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
1070
+ | `options` | `object` | ✅ | — | — | |
1071
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
1072
+ | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
1073
+ | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
1074
+ | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
1075
+ | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
1076
+ | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
1077
+ | ​ ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
866
1078
 
867
1079
  **Returns:** `Promise<ConnectionItem>`
868
1080
 
1081
+ | Name | Type | Required | Possible Values | Description |
1082
+ | ------------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------- |
1083
+ | `data` | `object` | ✅ | — | |
1084
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1085
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
1086
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1087
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1088
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1089
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1090
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1091
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1092
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1093
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1094
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1095
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1096
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1097
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1098
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1099
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1100
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1101
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1102
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1103
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1104
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1105
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1106
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1107
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1108
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1109
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1110
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1111
+
869
1112
  **Example:**
870
1113
 
871
1114
  ```typescript
@@ -878,19 +1121,50 @@ Find a unique connection matching the criteria
878
1121
 
879
1122
  **Parameters:**
880
1123
 
881
- | Name | Type | Required | Default | Possible Values | Description |
882
- | ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
883
- | `options` | `object` | ✅ | — | — | |
884
- | ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
885
- | ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
886
- | ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
887
- | ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
888
- | ↳ `account` | `string` | ❌ | — | — | Account to filter by |
889
- | ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
890
- | ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
1124
+ | Name | Type | Required | Default | Possible Values | Description |
1125
+ | ------------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
1126
+ | `options` | `object` | ✅ | — | — | |
1127
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
1128
+ | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
1129
+ | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
1130
+ | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
1131
+ | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
1132
+ | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
1133
+ | ​ ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
891
1134
 
892
1135
  **Returns:** `Promise<ConnectionItem>`
893
1136
 
1137
+ | Name | Type | Required | Possible Values | Description |
1138
+ | ------------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------- |
1139
+ | `data` | `object` | ✅ | — | |
1140
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1141
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
1142
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1143
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1144
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1145
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1146
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1147
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1148
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1149
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1150
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1151
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1152
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1153
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1154
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1155
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1156
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1157
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1158
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1159
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1160
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1161
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1162
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1163
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1164
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1165
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1166
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1167
+
894
1168
  **Example:**
895
1169
 
896
1170
  ```typescript
@@ -903,13 +1177,44 @@ Execute getConnection
903
1177
 
904
1178
  **Parameters:**
905
1179
 
906
- | Name | Type | Required | Default | Possible Values | Description |
907
- | -------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
908
- | `options` | `object` | ✅ | — | — | |
909
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
1180
+ | Name | Type | Required | Default | Possible Values | Description |
1181
+ | ---------------- | ---------------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1182
+ | `options` | `object` | ✅ | — | — | |
1183
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
910
1184
 
911
1185
  **Returns:** `Promise<ConnectionItem>`
912
1186
 
1187
+ | Name | Type | Required | Possible Values | Description |
1188
+ | ------------------------------ | --------- | -------- | --------------- | ---------------------------------------------------------- |
1189
+ | `data` | `object` | ✅ | — | |
1190
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1191
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
1192
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1193
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1194
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1195
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1196
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1197
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1198
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1199
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1200
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1201
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1202
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1203
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1204
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1205
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1206
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1207
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1208
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1209
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1210
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1211
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1212
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1213
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1214
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1215
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1216
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1217
+
913
1218
  **Example:**
914
1219
 
915
1220
  ```typescript
@@ -922,23 +1227,55 @@ List available connections with optional filtering
922
1227
 
923
1228
  **Parameters:**
924
1229
 
925
- | Name | Type | Required | Default | Possible Values | Description |
926
- | ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
927
- | `options` | `object` | ✅ | — | — | |
928
- | ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
929
- | ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
930
- | ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
931
- | ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
932
- | ↳ `connections` | `array` | ❌ | — | — | List of connection IDs to filter by |
933
- | ↳ `account` | `string` | ❌ | — | — | Account to filter by |
934
- | ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
935
- | ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
936
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of connections per page |
937
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
938
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
1230
+ | Name | Type | Required | Default | Possible Values | Description |
1231
+ | ------------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
1232
+ | `options` | `object` | ✅ | — | — | |
1233
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
1234
+ | ​ ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
1235
+ | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
1236
+ | ​ ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
1237
+ | ​ ↳ `connections` | `array` | ❌ | — | — | List of connection IDs to filter by |
1238
+ | ​ ↳ `account` | `string` | ❌ | — | — | Account to filter by |
1239
+ | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
1240
+ | ​ ↳ `expired` | `boolean` | ❌ | — | — | Show only expired connections (default: only non-expired connections are returned) |
1241
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of connections per page |
1242
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1243
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
939
1244
 
940
1245
  **Returns:** `Promise<PaginatedResult<ConnectionItem>>`
941
1246
 
1247
+ | Name | Type | Required | Possible Values | Description |
1248
+ | ------------------------------ | ---------- | -------- | --------------- | -------------------------------------------------------------- |
1249
+ | `data[]` | `object[]` | ✅ | — | |
1250
+ | ​ ↳ `id` | `string` | ✅ | — | Unique identifier for the connection |
1251
+ | ​ ↳ `date` | `string` | ✅ | — | Date created |
1252
+ | ​ ↳ `lastchanged` | `string` | ❌ | — | Date last changed |
1253
+ | ​ ↳ `account_id` | `string` | ✅ | — | Account ID associated with this connection |
1254
+ | ​ ↳ `destination_selected_api` | `string` | ❌ | — | Destination API key (if applicable) |
1255
+ | ​ ↳ `is_invite_only` | `boolean` | ✅ | — | Whether the connection is invite-only |
1256
+ | ​ ↳ `is_private` | `boolean` | ✅ | — | Whether the connection is private |
1257
+ | ​ ↳ `shared_with_all` | `boolean` | ✅ | — | Whether the connection is shared with all users |
1258
+ | ​ ↳ `is_stale` | `string` | ❌ | — | Stale status string |
1259
+ | ​ ↳ `is_shared` | `string` | ❌ | — | Shared status string |
1260
+ | ​ ↳ `marked_stale_at` | `string` | ❌ | — | Date when marked stale |
1261
+ | ​ ↳ `label` | `string` | ❌ | — | User label for the connection |
1262
+ | ​ ↳ `identifier` | `string` | ❌ | — | Identifier |
1263
+ | ​ ↳ `title` | `string` | ❌ | — | Title of the connection |
1264
+ | ​ ↳ `url` | `string` | ❌ | — | URL to the connection resource |
1265
+ | ​ ↳ `groups` | `array` | ❌ | — | Array of groups associated with the connection |
1266
+ | ​ ↳ `members` | `string` | ❌ | — | Members associated with the connection |
1267
+ | ​ ↳ `permissions` | `object` | ❌ | — | Permissions for the connection |
1268
+ | ​ ↳ `public_id` | `string` | ❌ | — | Public UUID for the connection |
1269
+ | ​ ↳ `account_public_id` | `string` | ❌ | — | Public UUID for the associated account |
1270
+ | ​ ↳ `customuser_public_id` | `string` | ❌ | — | Public UUID for the associated custom user |
1271
+ | ​ ↳ `implementation_id` | `string` | ❌ | — | Implementation ID (was selected_api) |
1272
+ | ​ ↳ `profile_id` | `string` | ❌ | — | Profile ID (was customuser_id) |
1273
+ | ​ ↳ `is_expired` | `string` | ❌ | — | Whether the connection is expired (mapped from is_stale) |
1274
+ | ​ ↳ `expired_at` | `string` | ❌ | — | Date when connection expired (mapped from marked_stale_at) |
1275
+ | ​ ↳ `app_key` | `string` | ❌ | — | App Key extracted from implementation_id |
1276
+ | ​ ↳ `app_version` | `string` | ❌ | — | App Version extracted from implementation_id |
1277
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1278
+
942
1279
  **Example:**
943
1280
 
944
1281
  ```typescript
@@ -964,23 +1301,23 @@ Make authenticated HTTP requests to any API through Zapier. Pass a connectionId
964
1301
 
965
1302
  **Parameters:**
966
1303
 
967
- | Name | Type | Required | Default | Possible Values | Description |
968
- | --------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
969
- | `url` | `string, custom` | ✅ | — | — | The full URL of the API endpoint to call (proxied through Zapier's Relay service) |
970
- | `init` | `object` | ❌ | — | — | Request options including method, headers, body, and authentication |
971
- | ↳ `method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET) |
972
- | ↳ `headers` | `object` | ❌ | — | — | HTTP headers to include in the request |
973
- | ↳ `body` | `string, custom, record` | ❌ | — | — | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
974
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
975
- | ↳ `callbackUrl` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
976
- | ↳ `maxTime` | `number` | ❌ | — | — | Maximum seconds to wait for a response. Honored on a best-effort basis; the server may silently enforce a lower ceiling. |
1304
+ | Name | Type | Required | Default | Possible Values | Description |
1305
+ | ----------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1306
+ | `url` | `string, custom` | ✅ | — | — | The full URL of the API endpoint to call (proxied through Zapier's Relay service) |
1307
+ | `init` | `object` | ❌ | — | — | Request options including method, headers, body, and authentication |
1308
+ | ​ ↳ `method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET) |
1309
+ | ​ ↳ `headers` | `object` | ❌ | — | — | HTTP headers to include in the request |
1310
+ | ​ ↳ `body` | `string, custom, record` | ❌ | — | — | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
1311
+ | ​ ↳ `connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
1312
+ | ​ ↳ `callbackUrl` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
1313
+ | ​ ↳ `maxTime` | `number` | ❌ | — | — | Maximum seconds to wait for a response. Honored on a best-effort basis; the server may silently enforce a lower ceiling. |
977
1314
 
978
1315
  **Returns:** `Promise<Response>`
979
1316
 
980
1317
  **Example:**
981
1318
 
982
1319
  ```typescript
983
- const result = await zapier.fetch("example-value", { key: "value" });
1320
+ const result = await zapier.fetch("https://example.com", {});
984
1321
  ```
985
1322
 
986
1323
  ### Tables
@@ -991,19 +1328,32 @@ Create a new table
991
1328
 
992
1329
  **Parameters:**
993
1330
 
994
- | Name | Type | Required | Default | Possible Values | Description |
995
- | --------------- | -------- | -------- | ------- | --------------- | ------------------------------------ |
996
- | `options` | `object` | ✅ | — | — | |
997
- | ↳ `name` | `string` | ✅ | — | — | The name for the new table |
998
- | ↳ `description` | `string` | ❌ | — | — | An optional description of the table |
1331
+ | Name | Type | Required | Default | Possible Values | Description |
1332
+ | ----------------- | -------- | -------- | ------- | --------------- | ------------------------------------ |
1333
+ | `options` | `object` | ✅ | — | — | |
1334
+ | ​ ↳ `name` | `string` | ✅ | — | — | The name for the new table |
1335
+ | ​ ↳ `description` | `string` | ❌ | — | — | An optional description of the table |
999
1336
 
1000
- **Returns:** `Promise<any>`
1337
+ **Returns:** `Promise<TableItem>`
1338
+
1339
+ | Name | Type | Required | Possible Values | Description |
1340
+ | --------------------- | -------- | -------- | ------------------------ | ----------- |
1341
+ | `data` | `object` | ✅ | — | |
1342
+ | ​ ↳ `id` | `string` | ✅ | — | |
1343
+ | ​ ↳ `name` | `string` | ✅ | — | |
1344
+ | ​ ↳ `description` | `string` | ❌ | — | |
1345
+ | ​ ↳ `created_at` | `string` | ✅ | — | |
1346
+ | ​ ↳ `edited_at` | `string` | ✅ | — | |
1347
+ | ​ ↳ `kind` | `string` | ✅ | `table`, `virtual_table` | |
1348
+ | ​ ↳ `account_id` | `string` | ✅ | — | |
1349
+ | ​ ↳ `profile_id` | `string` | ✅ | — | |
1350
+ | ​ ↳ `parent_table_id` | `string` | ❌ | — | |
1001
1351
 
1002
1352
  **Example:**
1003
1353
 
1004
1354
  ```typescript
1005
1355
  const result = await zapier.createTable({
1006
- name: "example-value",
1356
+ name: "example-name",
1007
1357
  });
1008
1358
  ```
1009
1359
 
@@ -1013,20 +1363,40 @@ Create one or more fields in a table
1013
1363
 
1014
1364
  **Parameters:**
1015
1365
 
1016
- | Name | Type | Required | Default | Possible Values | Description |
1017
- | ---------- | -------- | -------- | ------- | --------------- | ------------------------------------ |
1018
- | `options` | `object` | ✅ | — | — | |
1019
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1020
- | ↳ `fields` | `array` | ✅ | — | — | Array of field definitions to create |
1021
-
1022
- **Returns:** `Promise<any>`
1366
+ | Name | Type | Required | Default | Possible Values | Description |
1367
+ | --------------- | ---------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
1368
+ | `options` | `object` | ✅ | — | — | |
1369
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1370
+ | ​ ↳ `fields[]` | `object[]` | ✅ | — | — | Array of field definitions to create |
1371
+ | ​   ↳ `type` | `string` | ✅ | — | `string`, `multiple_string`, `labeled_string`, `multiple_labeled_string`, `text`, `multiple_text`, `boolean`, `multiple_boolean`, `number`, `multiple_number`, `decimal`, `multiple_decimal`, `datetime`, `multiple_datetime`, `uuid`, `multiple_uuid`, `json`, `multiple_json`, `formula`, `button_trigger_zap`, `button_continue_zap`, `email`, `multiple_email`, `link`, `multiple_link`, `currency`, `phone_number`, `ai_formula`, `linked_record`, `multiple_linked_record` | The data type of the field |
1372
+ | ​   ↳ `name` | `string` | ✅ | — | — | The display name of the field |
1373
+ | ​   ↳ `options` | `object` | ❌ | — | — | Data configuration options for the field |
1374
+ | ​   ↳ `config` | `object` | ❌ | — | — | Display configuration for the field |
1375
+
1376
+ **Returns:** `Promise<FieldItem[]>`
1377
+
1378
+ | Name | Type | Required | Possible Values | Description |
1379
+ | ---------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
1380
+ | `data[]` | `object[]` | ✅ | — | |
1381
+ | ​ ↳ `id` | `string` | ✅ | — | |
1382
+ | ​ ↳ `type` | `string` | ✅ | `string`, `multiple_string`, `labeled_string`, `multiple_labeled_string`, `text`, `multiple_text`, `boolean`, `multiple_boolean`, `number`, `multiple_number`, `decimal`, `multiple_decimal`, `datetime`, `multiple_datetime`, `uuid`, `multiple_uuid`, `json`, `multiple_json`, `formula`, `button_trigger_zap`, `button_continue_zap`, `email`, `multiple_email`, `link`, `multiple_link`, `currency`, `phone_number`, `ai_formula`, `linked_record`, `multiple_linked_record` | |
1383
+ | ​ ↳ `name` | `string` | ✅ | — | |
1384
+ | ​ ↳ `created_at` | `string` | ❌ | — | |
1385
+ | ​ ↳ `edited_at` | `string` | ❌ | — | |
1386
+ | ​ ↳ `options` | `object` | ❌ | — | |
1387
+ | ​ ↳ `config` | `object` | ❌ | — | |
1023
1388
 
1024
1389
  **Example:**
1025
1390
 
1026
1391
  ```typescript
1027
1392
  const result = await zapier.createTableFields({
1028
- table: "example-value",
1029
- fields: ["example-item"],
1393
+ table: "example-table",
1394
+ fields: [
1395
+ {
1396
+ type: "string",
1397
+ name: "example-name",
1398
+ },
1399
+ ],
1030
1400
  });
1031
1401
  ```
1032
1402
 
@@ -1036,21 +1406,34 @@ Create one or more records in a table
1036
1406
 
1037
1407
  **Parameters:**
1038
1408
 
1039
- | Name | Type | Required | Default | Possible Values | Description |
1040
- | ----------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1041
- | `options` | `object` | ✅ | — | — | |
1042
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1043
- | ↳ `records` | `array` | ✅ | — | — | Array of records to create (max 100) |
1044
- | ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1409
+ | Name | Type | Required | Default | Possible Values | Description |
1410
+ | --------------- | ---------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1411
+ | `options` | `object` | ✅ | — | — | |
1412
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1413
+ | ​ ↳ `records[]` | `object[]` | ✅ | — | — | Array of records to create (max 100) |
1414
+ | ​   ↳ `data` | `object` | ✅ | — | — | The field values for the record, keyed by field ID |
1415
+ | ​ ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1416
+
1417
+ **Returns:** `Promise<RecordItem[]>`
1045
1418
 
1046
- **Returns:** `Promise<any>`
1419
+ | Name | Type | Required | Possible Values | Description |
1420
+ | ---------------- | ---------- | -------- | --------------- | ----------- |
1421
+ | `data[]` | `object[]` | ✅ | — | |
1422
+ | ​ ↳ `id` | `string` | ✅ | — | |
1423
+ | ​ ↳ `data` | `object` | ✅ | — | |
1424
+ | ​ ↳ `created_at` | `string` | ✅ | — | |
1425
+ | ​ ↳ `edited_at` | `string` | ✅ | — | |
1047
1426
 
1048
1427
  **Example:**
1049
1428
 
1050
1429
  ```typescript
1051
1430
  const result = await zapier.createTableRecords({
1052
- table: "example-value",
1053
- records: ["example-item"],
1431
+ table: "example-table",
1432
+ records: [
1433
+ {
1434
+ data: {},
1435
+ },
1436
+ ],
1054
1437
  });
1055
1438
  ```
1056
1439
 
@@ -1060,18 +1443,18 @@ Delete a table by its ID
1060
1443
 
1061
1444
  **Parameters:**
1062
1445
 
1063
- | Name | Type | Required | Default | Possible Values | Description |
1064
- | --------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1065
- | `options` | `object` | ✅ | — | — | |
1066
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1446
+ | Name | Type | Required | Default | Possible Values | Description |
1447
+ | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1448
+ | `options` | `object` | ✅ | — | — | |
1449
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1067
1450
 
1068
- **Returns:** `Promise<any>`
1451
+ **Returns:** `Promise<{ success: boolean }>`
1069
1452
 
1070
1453
  **Example:**
1071
1454
 
1072
1455
  ```typescript
1073
1456
  const result = await zapier.deleteTable({
1074
- table: "example-value",
1457
+ table: "example-table",
1075
1458
  });
1076
1459
  ```
1077
1460
 
@@ -1081,20 +1464,20 @@ Delete one or more fields from a table
1081
1464
 
1082
1465
  **Parameters:**
1083
1466
 
1084
- | Name | Type | Required | Default | Possible Values | Description |
1085
- | ---------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------- |
1086
- | `options` | `object` | ✅ | — | — | |
1087
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1088
- | ↳ `fields` | `array` | ✅ | — | — | Fields to operate on. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
1467
+ | Name | Type | Required | Default | Possible Values | Description |
1468
+ | ------------ | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------- |
1469
+ | `options` | `object` | ✅ | — | — | |
1470
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1471
+ | ​ ↳ `fields` | `array` | ✅ | — | — | Fields to operate on. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
1089
1472
 
1090
- **Returns:** `Promise<any>`
1473
+ **Returns:** `Promise<{ success: boolean }>`
1091
1474
 
1092
1475
  **Example:**
1093
1476
 
1094
1477
  ```typescript
1095
1478
  const result = await zapier.deleteTableFields({
1096
- table: "example-value",
1097
- fields: ["example-item"],
1479
+ table: "example-table",
1480
+ fields: ["example-field"],
1098
1481
  });
1099
1482
  ```
1100
1483
 
@@ -1104,20 +1487,20 @@ Delete one or more records from a table
1104
1487
 
1105
1488
  **Parameters:**
1106
1489
 
1107
- | Name | Type | Required | Default | Possible Values | Description |
1108
- | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1109
- | `options` | `object` | ✅ | — | — | |
1110
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1111
- | ↳ `records` | `array` | ✅ | — | — | Record IDs to operate on |
1490
+ | Name | Type | Required | Default | Possible Values | Description |
1491
+ | ------------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1492
+ | `options` | `object` | ✅ | — | — | |
1493
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1494
+ | ​ ↳ `records` | `array` | ✅ | — | — | Record IDs to operate on |
1112
1495
 
1113
- **Returns:** `Promise<any>`
1496
+ **Returns:** `Promise<{ success: boolean }>`
1114
1497
 
1115
1498
  **Example:**
1116
1499
 
1117
1500
  ```typescript
1118
1501
  const result = await zapier.deleteTableRecords({
1119
- table: "example-value",
1120
- records: ["example-item"],
1502
+ table: "example-table",
1503
+ records: ["example-record"],
1121
1504
  });
1122
1505
  ```
1123
1506
 
@@ -1127,18 +1510,31 @@ Get detailed information about a specific table
1127
1510
 
1128
1511
  **Parameters:**
1129
1512
 
1130
- | Name | Type | Required | Default | Possible Values | Description |
1131
- | --------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1132
- | `options` | `object` | ✅ | — | — | |
1133
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1513
+ | Name | Type | Required | Default | Possible Values | Description |
1514
+ | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1515
+ | `options` | `object` | ✅ | — | — | |
1516
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1134
1517
 
1135
1518
  **Returns:** `Promise<TableItem>`
1136
1519
 
1520
+ | Name | Type | Required | Possible Values | Description |
1521
+ | --------------------- | -------- | -------- | ------------------------ | ----------- |
1522
+ | `data` | `object` | ✅ | — | |
1523
+ | ​ ↳ `id` | `string` | ✅ | — | |
1524
+ | ​ ↳ `name` | `string` | ✅ | — | |
1525
+ | ​ ↳ `description` | `string` | ❌ | — | |
1526
+ | ​ ↳ `created_at` | `string` | ✅ | — | |
1527
+ | ​ ↳ `edited_at` | `string` | ✅ | — | |
1528
+ | ​ ↳ `kind` | `string` | ✅ | `table`, `virtual_table` | |
1529
+ | ​ ↳ `account_id` | `string` | ✅ | — | |
1530
+ | ​ ↳ `profile_id` | `string` | ✅ | — | |
1531
+ | ​ ↳ `parent_table_id` | `string` | ❌ | — | |
1532
+
1137
1533
  **Example:**
1138
1534
 
1139
1535
  ```typescript
1140
1536
  const { data: table } = await zapier.getTable({
1141
- table: "example-value",
1537
+ table: "example-table",
1142
1538
  });
1143
1539
  ```
1144
1540
 
@@ -1148,21 +1544,29 @@ Get a single record from a table by ID
1148
1544
 
1149
1545
  **Parameters:**
1150
1546
 
1151
- | Name | Type | Required | Default | Possible Values | Description |
1152
- | ----------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1153
- | `options` | `object` | ✅ | — | — | |
1154
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1155
- | ↳ `record` | `string` | ✅ | — | — | The unique identifier of the record |
1156
- | ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1547
+ | Name | Type | Required | Default | Possible Values | Description |
1548
+ | ------------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1549
+ | `options` | `object` | ✅ | — | — | |
1550
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1551
+ | ​ ↳ `record` | `string` | ✅ | — | — | The unique identifier of the record |
1552
+ | ​ ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1157
1553
 
1158
1554
  **Returns:** `Promise<RecordItem>`
1159
1555
 
1556
+ | Name | Type | Required | Possible Values | Description |
1557
+ | ---------------- | -------- | -------- | --------------- | ----------- |
1558
+ | `data` | `object` | ✅ | — | |
1559
+ | ​ ↳ `id` | `string` | ✅ | — | |
1560
+ | ​ ↳ `data` | `object` | ✅ | — | |
1561
+ | ​ ↳ `created_at` | `string` | ✅ | — | |
1562
+ | ​ ↳ `edited_at` | `string` | ✅ | — | |
1563
+
1160
1564
  **Example:**
1161
1565
 
1162
1566
  ```typescript
1163
1567
  const { data: record } = await zapier.getTableRecord({
1164
- table: "example-value",
1165
- record: "example-value",
1568
+ table: "example-table",
1569
+ record: "example-record",
1166
1570
  });
1167
1571
  ```
1168
1572
 
@@ -1172,25 +1576,37 @@ List fields for a table
1172
1576
 
1173
1577
  **Parameters:**
1174
1578
 
1175
- | Name | Type | Required | Default | Possible Values | Description |
1176
- | ---------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------- |
1177
- | `options` | `object` | ✅ | — | — | |
1178
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1179
- | ↳ `fields` | `array` | ❌ | — | — | Fields to operate on. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
1579
+ | Name | Type | Required | Default | Possible Values | Description |
1580
+ | ------------ | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------- |
1581
+ | `options` | `object` | ✅ | — | — | |
1582
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1583
+ | ​ ↳ `fields` | `array` | ❌ | — | — | Fields to operate on. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
1180
1584
 
1181
1585
  **Returns:** `Promise<PaginatedResult<FieldItem>>`
1182
1586
 
1587
+ | Name | Type | Required | Possible Values | Description |
1588
+ | ---------------- | ---------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
1589
+ | `data[]` | `object[]` | ✅ | — | |
1590
+ | ​ ↳ `id` | `string` | ✅ | — | |
1591
+ | ​ ↳ `type` | `string` | ✅ | `string`, `multiple_string`, `labeled_string`, `multiple_labeled_string`, `text`, `multiple_text`, `boolean`, `multiple_boolean`, `number`, `multiple_number`, `decimal`, `multiple_decimal`, `datetime`, `multiple_datetime`, `uuid`, `multiple_uuid`, `json`, `multiple_json`, `formula`, `button_trigger_zap`, `button_continue_zap`, `email`, `multiple_email`, `link`, `multiple_link`, `currency`, `phone_number`, `ai_formula`, `linked_record`, `multiple_linked_record` | |
1592
+ | ​ ↳ `name` | `string` | ✅ | — | |
1593
+ | ​ ↳ `created_at` | `string` | ❌ | — | |
1594
+ | ​ ↳ `edited_at` | `string` | ❌ | — | |
1595
+ | ​ ↳ `options` | `object` | ❌ | — | |
1596
+ | ​ ↳ `config` | `object` | ❌ | — | |
1597
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1598
+
1183
1599
  **Example:**
1184
1600
 
1185
1601
  ```typescript
1186
1602
  // Get first page and a cursor for the second page
1187
1603
  const { data: fields, nextCursor } = await zapier.listTableFields({
1188
- table: "example-value",
1604
+ table: "example-table",
1189
1605
  });
1190
1606
 
1191
1607
  // Or iterate over all pages
1192
1608
  for await (const page of zapier.listTableFields({
1193
- table: "example-value",
1609
+ table: "example-table",
1194
1610
  })) {
1195
1611
  // Do something with each page
1196
1612
  }
@@ -1198,7 +1614,7 @@ for await (const page of zapier.listTableFields({
1198
1614
  // Or iterate over individual items across all pages
1199
1615
  for await (const field of zapier
1200
1616
  .listTableFields({
1201
- table: "example-value",
1617
+ table: "example-table",
1202
1618
  })
1203
1619
  .items()) {
1204
1620
  // Do something with each field
@@ -1211,32 +1627,44 @@ List records in a table with optional filtering and sorting
1211
1627
 
1212
1628
  **Parameters:**
1213
1629
 
1214
- | Name | Type | Required | Default | Possible Values | Description |
1215
- | ---------------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1216
- | `options` | `object` | ✅ | — | — | |
1217
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1218
- | ↳ `filters` | `array` | ❌ | — | — | Filter conditions for the query |
1219
- | ↳ `sort` | `object` | ❌ | — | — | Sort records by a field |
1220
- |    ↳ `fieldKey` | `string` | ✅ | — | — | The field key to sort by |
1221
- |    ↳ `direction` | `string` | ❌ | `"asc"` | — | Sort direction |
1222
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of records per page (max 1000) |
1223
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1224
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
1225
- | ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1630
+ | Name | Type | Required | Default | Possible Values | Description |
1631
+ | ----------------- | ---------- | -------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1632
+ | `options` | `object` | ✅ | — | — | |
1633
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1634
+ | ​ ↳ `filters[]` | `object[]` | ❌ | — | — | Filter conditions for the query |
1635
+ | ​   ↳ `fieldKey` | `string` | ✅ | — | — | The field key to filter on (e.g. f1, f2) |
1636
+ | ​   ↳ `operator` | `string` | ✅ | — | `exact`, `different`, `contains`, `icontains`, `gte`, `gt`, `lt`, `lte`, `range`, `in`, `isnull`, `startswith`, `search`, `is_within` | The comparison operator |
1637
+ | ​   ↳ `value` | `string` | ❌ | — | — | The value to compare against |
1638
+ | ​ ↳ `sort` | `object` | ❌ | — | — | Sort records by a field |
1639
+ | ​   ↳ `fieldKey` | `string` | ✅ | — | — | The field key to sort by |
1640
+ | ​   ↳ `direction` | `string` | ❌ | `"asc"` | — | Sort direction |
1641
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of records per page (max 1000) |
1642
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1643
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
1644
+ | ​ ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1226
1645
 
1227
1646
  **Returns:** `Promise<PaginatedResult<RecordItem>>`
1228
1647
 
1648
+ | Name | Type | Required | Possible Values | Description |
1649
+ | ---------------- | ---------- | -------- | --------------- | -------------------------------------------------------------- |
1650
+ | `data[]` | `object[]` | ✅ | — | |
1651
+ | ​ ↳ `id` | `string` | ✅ | — | |
1652
+ | ​ ↳ `data` | `object` | ✅ | — | |
1653
+ | ​ ↳ `created_at` | `string` | ✅ | — | |
1654
+ | ​ ↳ `edited_at` | `string` | ✅ | — | |
1655
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1656
+
1229
1657
  **Example:**
1230
1658
 
1231
1659
  ```typescript
1232
1660
  // Get first page and a cursor for the second page
1233
1661
  const { data: records, nextCursor } = await zapier.listTableRecords({
1234
- table: "example-value",
1662
+ table: "example-table",
1235
1663
  });
1236
1664
 
1237
1665
  // Or iterate over all pages
1238
1666
  for await (const page of zapier.listTableRecords({
1239
- table: "example-value",
1667
+ table: "example-table",
1240
1668
  })) {
1241
1669
  // Do something with each page
1242
1670
  }
@@ -1244,7 +1672,7 @@ for await (const page of zapier.listTableRecords({
1244
1672
  // Or iterate over individual items across all pages
1245
1673
  for await (const record of zapier
1246
1674
  .listTableRecords({
1247
- table: "example-value",
1675
+ table: "example-table",
1248
1676
  })
1249
1677
  .items()) {
1250
1678
  // Do something with each record
@@ -1257,20 +1685,34 @@ List tables available to the authenticated user
1257
1685
 
1258
1686
  **Parameters:**
1259
1687
 
1260
- | Name | Type | Required | Default | Possible Values | Description |
1261
- | ----------------- | --------- | -------- | ------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------- |
1262
- | `options` | `object` | ✅ | — | — | |
1263
- | ↳ `tables` | `array` | ❌ | — | — | Filter by specific table IDs |
1264
- | ↳ `kind` | `string` | ❌ | — | `table`, `virtual_table`, `both` | Filter by table type |
1265
- | ↳ `search` | `string` | ❌ | — | — | Search term to filter tables by name |
1266
- | ↳ `owner` | `string` | ❌ | — | — | Filter by table owner. Use "me" for the current user, or a numeric user ID. Requires includeShared to be true. |
1267
- | ↳ `includeShared` | `boolean` | ❌ | — | — | Include tables shared with you. Without this, only your own tables are returned. |
1268
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of tables per page |
1269
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1270
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
1688
+ | Name | Type | Required | Default | Possible Values | Description |
1689
+ | ------------------- | --------- | -------- | ------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------- |
1690
+ | `options` | `object` | ✅ | — | — | |
1691
+ | ​ ↳ `tables` | `array` | ❌ | — | — | Filter by specific table IDs |
1692
+ | ​ ↳ `kind` | `string` | ❌ | — | `table`, `virtual_table`, `both` | Filter by table type |
1693
+ | ​ ↳ `search` | `string` | ❌ | — | — | Search term to filter tables by name |
1694
+ | ​ ↳ `owner` | `string` | ❌ | — | — | Filter by table owner. Use "me" for the current user, or a numeric user ID. Requires includeShared to be true. |
1695
+ | ​ ↳ `includeShared` | `boolean` | ❌ | — | — | Include tables shared with you. Without this, only your own tables are returned. |
1696
+ | ​ ↳ `pageSize` | `number` | ❌ | — | — | Number of tables per page |
1697
+ | ​ ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1698
+ | ​ ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
1271
1699
 
1272
1700
  **Returns:** `Promise<PaginatedResult<TableItem>>`
1273
1701
 
1702
+ | Name | Type | Required | Possible Values | Description |
1703
+ | --------------------- | ---------- | -------- | ------------------------ | -------------------------------------------------------------- |
1704
+ | `data[]` | `object[]` | ✅ | — | |
1705
+ | ​ ↳ `id` | `string` | ✅ | — | |
1706
+ | ​ ↳ `name` | `string` | ✅ | — | |
1707
+ | ​ ↳ `description` | `string` | ❌ | — | |
1708
+ | ​ ↳ `created_at` | `string` | ✅ | — | |
1709
+ | ​ ↳ `edited_at` | `string` | ✅ | — | |
1710
+ | ​ ↳ `kind` | `string` | ✅ | `table`, `virtual_table` | |
1711
+ | ​ ↳ `account_id` | `string` | ✅ | — | |
1712
+ | ​ ↳ `profile_id` | `string` | ✅ | — | |
1713
+ | ​ ↳ `parent_table_id` | `string` | ❌ | — | |
1714
+ | `nextCursor` | `string` | ❌ | — | Cursor for the next page; omitted when there are no more pages |
1715
+
1274
1716
  **Example:**
1275
1717
 
1276
1718
  ```typescript
@@ -1294,20 +1736,35 @@ Update one or more records in a table
1294
1736
 
1295
1737
  **Parameters:**
1296
1738
 
1297
- | Name | Type | Required | Default | Possible Values | Description |
1298
- | ----------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1299
- | `options` | `object` | ✅ | — | — | |
1300
- | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1301
- | ↳ `records` | `array` | ✅ | — | — | Array of records to update (max 100) |
1302
- | ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1303
-
1304
- **Returns:** `Promise<any>`
1739
+ | Name | Type | Required | Default | Possible Values | Description |
1740
+ | --------------- | ---------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1741
+ | `options` | `object` | ✅ | — | — | |
1742
+ | ​ ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1743
+ | ​ ↳ `records[]` | `object[]` | ✅ | — | — | Array of records to update (max 100) |
1744
+ | ​   ↳ `id` | `string` | ✅ | — | — | The record ID to update |
1745
+ | ​   ↳ `data` | `object` | ✅ | — | — | The field values to update, keyed by field key |
1746
+ | ​ ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1747
+
1748
+ **Returns:** `Promise<RecordItem[]>`
1749
+
1750
+ | Name | Type | Required | Possible Values | Description |
1751
+ | ---------------- | ---------- | -------- | --------------- | ----------- |
1752
+ | `data[]` | `object[]` | ✅ | — | |
1753
+ | ​ ↳ `id` | `string` | ✅ | — | |
1754
+ | ​ ↳ `data` | `object` | ✅ | — | |
1755
+ | ​ ↳ `created_at` | `string` | ✅ | — | |
1756
+ | ​ ↳ `edited_at` | `string` | ✅ | — | |
1305
1757
 
1306
1758
  **Example:**
1307
1759
 
1308
1760
  ```typescript
1309
1761
  const result = await zapier.updateTableRecords({
1310
- table: "example-value",
1311
- records: ["example-item"],
1762
+ table: "example-table",
1763
+ records: [
1764
+ {
1765
+ id: "example-id",
1766
+ data: {},
1767
+ },
1768
+ ],
1312
1769
  });
1313
1770
  ```