NYnylas
Application-level workflows

Return all workflows

Changed on

Returns all application-level workflows.

get/v3/workflows

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    HTTP bearer

Query parameters

limitinteger

The maximum number of objects to return. See Pagination for more information.

page_tokenstring

An identifier that specifies which page of data to return. You can get this value from the next_cursor response field. See Pagination for more information.

Response

Success. Returns list of workflows.

request_idstring required

The ID of the request.

next_cursorstring required

A cursor pointing to the next page of results for the request.

Example response

{
  "request_id": "9ca1d434-5ac7-4331-b8fb-3749c9a758d3",
  "data": [
    {
      "id": "b79c82b2-a51b-4c54-8469-28006a43551a",
      "grant_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
      "app_id": null,
      "is_enabled": true,
      "name": "Booking Confirmation Workflow",
      "trigger_event": "booking.created",
      "delay": 1,
      "template_id": "14c00cc8-648c-4381-ad10-52641d9bac8e",
      "date_created": 1756477389
    },
    {
      "id": "c89d93c3-b62c-5d65-9570-39117b54662b",
      "grant_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
      "app_id": null,
      "is_enabled": true,
      "name": "Booking Reminder Workflow",
      "trigger_event": "booking.reminder",
      "delay": 60,
      "template_id": "25d11dd9-759d-5492-be21-63752e6cbd9f",
      "date_created": 1756477500
    },
    {
      "id": "d90e04d4-c73d-6e76-a681-40228c65773c",
      "grant_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
      "app_id": null,
      "is_enabled": false,
      "name": "Booking Cancellation Workflow",
      "trigger_event": "booking.cancelled",
      "delay": 0,
      "template_id": "36e22ee0-86ae-6603-cf32-74863f7dce0g",
      "date_created": 1756477600
    }
  ],
  "next_cursor": "eyJjdXJzb3IiOiJub3RpZmljYXRpb25fd29ya2Zsb3dfYjc5YzgyYjIifQ=="
}

Changes

  • 7782a3e3ab70Revision changes
    • info

      removed the message.created enum value from the // response property for the response status

    • info

      removed the message.updated enum value from the // response property for the response status

  • 5b50586c3710Revision changes
    • warning

      added the new calendar.created enum value to the // response property for the response status

    • warning

      added the new calendar.deleted enum value to the // response property for the response status

    • warning

      added the new calendar.updated enum value to the // response property for the response status

    • warning

      added the new contact.deleted enum value to the // response property for the response status

    • warning

      added the new contact.updated enum value to the // response property for the response status

    • warning

      added the new event.created enum value to the // response property for the response status

    • warning

      added the new event.deleted enum value to the // response property for the response status

    • warning

      added the new event.updated enum value to the // response property for the response status

    • warning

      added the new folder.created enum value to the // response property for the response status

    • warning

      added the new folder.deleted enum value to the // response property for the response status

    • warning

      added the new folder.updated enum value to the // response property for the response status

    • warning

      added the new grant.created enum value to the // response property for the response status

    • warning

      added the new grant.deleted enum value to the // response property for the response status

    • warning

      added the new grant.expired enum value to the // response property for the response status

    • warning

      added the new grant.imap_sync_completed enum value to the // response property for the response status

    • warning

      added the new grant.updated enum value to the // response property for the response status

    • warning

      added the new message.bounce_detected enum value to the // response property for the response status

    • warning

      added the new message.created enum value to the // response property for the response status

    • warning

      added the new message.link_clicked enum value to the // response property for the response status

    • warning

      added the new message.opened enum value to the // response property for the response status

    • warning

      added the new message.send_failed enum value to the // response property for the response status

    • warning

      added the new message.send_success enum value to the // response property for the response status

    • warning

      added the new message.updated enum value to the // response property for the response status

    • warning

      added the new notetaker.created enum value to the // response property for the response status

    • warning

      added the new notetaker.deleted enum value to the // response property for the response status

    • warning

      added the new notetaker.media enum value to the // response property for the response status

    • warning

      added the new notetaker.meeting_state enum value to the // response property for the response status

    • warning

      added the new notetaker.updated enum value to the // response property for the response status

    • warning

      added the new thread.replied enum value to the // response property for the response status