Skip to content
Skip to main content
GET
/v3/grants/{grant_id}/workflows/{workflow_id}

Get a workflow

Returns the specified grant-level workflow.

NYLAS API KEYACCESS TOKEN

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: "nyla@example.com"
workflow_id*string

The ID of the workflow to access.

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

Responses

request_id*string

The ID of the request.

data*object

A custom workflow that sends messages from a template when certain events are triggered.

GEThttps://api.us.nylas.com/v3/grants/nyla%40example.com/workflows/b79c82b2-a51b-4c54-8469-28006a43551a

Find your API key in the Nylas Dashboard under API Keys in your application settings.

grant_idrequiredstring

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.

workflow_idrequiredstring

The ID of the workflow to access.