NYnylas
Grant-level workflows

Get a workflow

Changed on

Returns the specified grant-level workflow.

get/v3/grants/{grant_id}/workflows/{workflow_id}

Request

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

Response

Success. Returns workflow.

request_idstring required

The ID of the request.

Example response

{
  "data": {
    "app_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
    "date_created": 1756477389,
    "delay": 5,
    "grant_id": "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb",
    "id": "b79c82b2-a51b-4c54-8469-28006a43551a",
    "is_enabled": true,
    "name": "New booking confirmation workflow",
    "template_id": "14c00cc8-648c-4381-ad10-52641d9bac8e",
    "trigger_event": "booking.created",
    "from": {
      "email": "support@example.com",
      "name": "Support"
    }
  }
}

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