Skip to content
Skip to main content
GET
https://api.us.nylas.com/v3/grants/{grant_id}/messages/schedules/{scheduleId}

Return a scheduled message

Returns the specified scheduled message. You can retrieve both sent and unsent messages.

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 scheduled_messages.read permission.

Parameters

Path parameters

scheduleId*string

The ID of the scheduled message that you want to retrieve.

grant_id*string

ID of the grant to access. Use /me/ to refer to the grant associated with an access token.

Responses

schedule_id*string

The ID of the scheduled message.

status*object

The status of the specified scheduled message.

close_timeinteger

The time that the message was sent, or failed to send, in seconds using the Unix timestamp format.

GEThttps://api.us.nylas.com/v3/grants/{grant_id}/messages/schedules/{scheduleId}

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

scheduleIdrequiredstring

The ID of the scheduled message that you want to retrieve.

grant_idrequiredstring

ID of the grant to access. Use /me/ to refer to the grant associated with an access token.