Return all workflows - Grant Level Workflows - API Reference

GET

https://api.us.nylas.com/v3/grants/{grant_id}/workflows

Returns all grant-level workflows for the specified grant.

Works with an API key, an access token (use /v3/grants/me/ in place of the grant ID), or an IAM API key with the workflows.read permission.

Parameters

Path parameters

grant_id*string

ID of the grant to access. You can also use the email address associated with the grant, or use /me/ to refer to the grant associated with an access token.

Example: "[email protected]"

Query parameters

limitinteger

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

Default: 50

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.

Responses

request_id*string

The ID of the request.

Example: "9ca1d434-5ac7-4331-b8fb-3749c9a758d3"

data*array<object>

Example:

[{"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}]

Array items:

app_idstringnullable

The ID of the Nylas application associated with the workflow. Returned only if the workflow is configured at the application level.

Example: "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb"

date_created*integer

When the workflow was created, in seconds using the Unix timestamp format.

Example: 1756477389

delay*integer

The number of minutes between a trigger_event being met and the workflow sending a message.

Example: 5

grant_idstringnullable

The ID of the grant associated with the workflow. Returned only if the workflow is configured at the grant level.

Example: "6c45fe5e-0bb6-41b9-9acc-ccb15bfc51eb"

id*string

The ID of the workflow.

Example: "b79c82b2-a51b-4c54-8469-28006a43551a"

is_enabled*boolean

When true, indicates that the workflow is enabled.

Example: true

name*string

The name of the workflow.

Example: "New booking confirmation workflow"

template_id*string

The ID of the email template the workflow uses.

Example: "14c00cc8-648c-4381-ad10-52641d9bac8e"

trigger_event*string

The event which triggers the workflow.

grant.expired and grant.deleted require a from sender address, because the grant that triggered them can no longer send email. Every other trigger accepts a workflow without one.

Workflows have no condition or filter field, so an enabled workflow sends for every matching event in its scope. High-volume triggers such as message.opened fire for every open of every tracked message the workflow covers.

booking.cancelledbooking.createdbooking.pendingbooking.reminderbooking.rescheduledcalendar.createdcalendar.deletedcalendar.updatedcontact.deletedcontact.updatedevent.createdevent.deletedevent.updatedfolder.createdfolder.deletedfolder.updatedgrant.createdgrant.deletedgrant.expiredgrant.imap_sync_completedgrant.updatedmessage.bounce_detectedmessage.link_clickedmessage.openedmessage.send_failedmessage.send_successnotetaker.creatednotetaker.deletednotetaker.medianotetaker.meeting_statenotetaker.updatedthread.replied

Example: "booking.created"

fromobjectnullable

Details of the sender if the workflow uses transactional send.

next_cursor*string

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

Example: "eyJjdXJzb3IiOiJub3RpZmljYXRpb25fd29ya2Zsb3dfYjc5YzgyYjIifQ=="

curl --request GET \ --url "https://api.us.nylas.com/v3/grants/<NYLAS_GRANT_ID>/workflows?limit=10" \ --header 'Accept: application/json' \ --header 'Authorization: Bearer <NYLAS_API_KEY>' \ --header 'Content-Type: application/json'