--- title: "Get information about a scheduled email" method: GET path: "/gdc/md/{project_id}/obj/{scheduled_email_id}" tags: ["automatic-emailing"] --- # Get information about a scheduled email `GET /gdc/md/{project_id}/obj/{scheduled_email_id}` ## Request - Base URL: `https://secure.gooddata.com` - URL: `https://secure.gooddata.com/gdc/md/{project_id}/obj/{scheduled_email_id}` - Auth: none declared Get information about an existing scheduled email in your project. **Response body parameters** * `deprecated` (boolean) specifies whether the scheduled email is hidden from the GoodData Portal (`1`) or visible and listed in the existed scheduled emails (`0`). * `recurrency` (string) specifies the schedule for the email to be sent in [Date::Manip format](https://metacpan.org/pod/release/SBECK/Date-Manip-6.59/lib/Date/Manip/Recur.pm). Example: `0:0:0:1*12:0:0` * `timezone` (string) specifies the canonical name of the time zone for the email schedule. Example: `Europe/Prague` * `pageOrientation` (string, optional) specifies page orientation of the PDF file produced. Can be set to `portrait` (default) or `landscape`. * `optimalColumnWidth` (boolean, optional) specifies whether the column width should be uniform (`no`; default) or adjusted according to the actual column data (`yes`). Applies to both portrait and landscape orientations. * `pageScalePercentage` (number, optional) specifies a percentage to scale the output PDF file for a report. Applies to both portrait and landscape orientations. Cannot be used with the `scaleToPages`, `scaleToPagesX`, and `scaleToPagesY` parameters. If not set, defaults to 100. * `scaleToPages` (number, optional) specifies a maximum number of pages for the output PDF file for a report. Applies to both portrait and landscape orientations. Cannot be used with the `pageScalePercentage`, `scaleToPagesX` and `scaleToPagesY` parameters. * `scaleToPagesX` (number, optional) shrinks the horizontal content of the output PDF file for a report to a maximum of this number of pages. Often used with the `scaleToPagesY` parameter. Applies to both portrait and landscape orientations. Cannot be used with the `pageScalePercentage` or `scaleToPages` parameters. * `scaleToPagesY` (number, optional) shrinks the vertical content of the output PDF file for a report to a maximum of this number of pages. Often used with the `scaleToPagesX` parameter. Applies to both portrait and landscape orientations. Cannot be used with the `pageScalePercentage` or `scaleToPages` parameters. * `allTabs` (boolean, optional) specifies whether to export all tabs of a dashboard (`1`) or just specific ones (`0`). * `tabs` (only when `allTabs` set to `0`, array of strings) specifies the identifiers of the dashboard tabs to export. Example: `[ "l1upg65jgp0je","f7qgm4m3dmb8v" ]` * `executionContext` (string, optional) applies a predefined set of filters (execution context) to the dashboard to export. ## Path parameters - `project_id` string, required - `scheduled_email_id` string, required ## Response `200` _ - ScheduledMail1 - `scheduledMail` object, required - `meta` MetaResponse, required - `title` string, required: Title of this metadata object. Mustn't contain only whitespace characters - `category` string: Category of this metadata object - `tags` string: List of tags for this metadata object separated by spaces - `author` string, uri: URI of the user's profile - `created` string: Date and time string in the format `YYYY-MM-DD hh:mm:ss` - `contributor` string, uri: URI of the user's profile - `updated` string: Date and time string in the format `YYYY-MM-DD hh:mm:ss` - `identifier` string: Global identifier of a metadata object - `flags` string[]: List of flags specified for this metadata object - `summary` string: A short description of this metadata object - `uri` string: Link to this metadata object - `deprecated` '0' | '1': Flag that the metadata object is deprecated - `locked` 0 | 1: Flag that the metadata object is locked - `unlisted` 0 | 1: Flag that the metadata object is unlisted - `isProduction` 0 | 1: Flag that the metadata object is production - `sharedWithSomeone` 0 | 1: Is the linked object shared with someone via ACLs? - `content` object, required - `when` object, required - `recurrency` string, required - `startDate` string, required - `timeZone` string, required - `endDate` string - `body` unknown, required - `lastSuccessfull` string: Date and time string in the format `YYYY-MM-DD hh:mm:ss` - `attachments` union[], required - union - ReportAttachment - `exportOptions` ExportOptions: Options that can modify the default export behavior. The options vary for each export format. - … - `formats` string[], required - `uri` string, uri, required: uri string pointed to report - DashboardAttachment - `uri` string, uri, required - `allTabs` integer, required - `tabs` string[], required - `executionContext` string - KpiDashboardAttachment1 - `filterContext` FilterContext1 - … - `formats` string[], required - `uri` string, uri, required: The URI string that points to the object. - VisualizationWidgetAttachment1 - `exportOptions` ExportOptions: Options that can modify the default export behavior. The options vary for each export format. - … - `filterContext` FilterContext1 - … - `uri` string, uri, required: The URI of the visualization widget. - `dashboardUri` string, required: The URI of the dashboard. - `formats` string[] - VisualizationObjectAttachment - `uri` string, uri, required - `exportOptions` ExportOptions: Options that can modify the default export behavior. The options vary for each export format. - … - `formats` string[] - `to` string[], required: list of logins - `bcc` string[]: list of e-mails - `unsubscribed` string[]: list of e-mails - `subject` string, required --- [API](https://skmtc.dev/gooddata/apis/gooddata-api-documentation.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-api-documentation/revisions/e5dc0ee6ab00?raw)