---
title: "List maintenance templates"
method: GET
path: "/api/v2/statuspages/{page_id}/maintenance_templates"
tags: ["Status Pages"]
---

# List maintenance templates

`GET /api/v2/statuspages/{page_id}/maintenance_templates`

## Request

- Base URL: `https://api.datadoghq.com`
- URL: `https://api.datadoghq.com/api/v2/statuspages/{page_id}/maintenance_templates`
- Auth: one of:
  - API key in header `DD-API-KEY` and API key in header `DD-APPLICATION-KEY`
  - OAuth 2
    - Authorization code: `/oauth2/v1/authorize`
    - Token URL: `/oauth2/v1/token` scopes: `status_pages_settings_read`
- TypeScript: <https://skmtc.dev/datadog/apis/datadog-api-v2-collection/docs/api/v2/statuspages/:page_id/maintenance_templates/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists all maintenance templates for a status page.

## Path parameters

- `page_id` string, uuid, required

## Query parameters

- `include` string

## Response `200`

OK

- MaintenanceTemplateArray: Response object for a list of maintenance templates.
  - `data` MaintenanceTemplateData[], required: A list of maintenance template data objects.
    - `attributes` MaintenanceTemplateDataAttributes: The attributes of a maintenance template.
      - `completed_description` string: The description shown when a maintenance created from this template is completed.
      - `component_ids` string[]: The IDs of the components affected by a maintenance created from this template.
      - `created_at` string, date-time: Timestamp of when the maintenance template was created.
      - `in_progress_description` string: The description shown while a maintenance created from this template is in progress.
      - `maintenance_title` string: The title used for a maintenance created from this template.
      - `modified_at` string, date-time: Timestamp of when the maintenance template was last modified.
      - `name` string: The name of the maintenance template.
      - `scheduled_description` string: The description shown when a maintenance created from this template is scheduled.
    - `id` string: The ID of the maintenance template.
    - `relationships` MaintenanceTemplateDataRelationships: The relationships of a maintenance template.
      - `created_by_user` MaintenanceTemplateDataRelationshipsCreatedByUser: The Datadog user who created the maintenance template.
        - `data` MaintenanceTemplateDataRelationshipsCreatedByUserData, required: The data object identifying the Datadog user who created the maintenance template.
          - `id` string, required: The ID of the Datadog user who created the maintenance template.
          - `type` 'users', required: Users resource type.
      - `last_modified_by_user` MaintenanceTemplateDataRelationshipsLastModifiedByUser: The Datadog user who last modified the maintenance template.
        - `data` MaintenanceTemplateDataRelationshipsLastModifiedByUserData, required: The data object identifying the Datadog user who last modified the maintenance template.
          - `id` string, required: The ID of the Datadog user who last modified the maintenance template.
          - `type` 'users', required: Users resource type.
      - `status_page` MaintenanceTemplateDataRelationshipsStatusPage: The status page the maintenance template belongs to.
        - `data` MaintenanceTemplateDataRelationshipsStatusPageData, required: The data object identifying the status page associated with a maintenance template.
          - `id` string, required: The ID of the status page.
          - `type` 'status_pages', required: Status pages resource type.
    - `type` 'maintenance_templates', required: Maintenance templates resource type.
  - `included` DegradationIncluded[]: The included related resources of a maintenance template. Client must explicitly request these resources by name in the `include` query parameter.
    - union: An included resource related to a degradation or maintenance.
      - StatusPagesUser: The included Datadog user resource.
        - `attributes` StatusPagesUserAttributes: Attributes of the Datadog user.
          - `email` string: The email of the Datadog user.
          - `handle` string: The handle of the Datadog user.
          - `icon` string: The icon of the Datadog user.
          - `name` string: The name of the Datadog user.
          - `uuid` string: The UUID of the Datadog user.
        - `id` string, uuid: The ID of the Datadog user.
        - `type` 'users', required: Users resource type.
      - StatusPageAsIncluded: The included status page resource.
        - `attributes` StatusPageAsIncludedAttributes: The attributes of a status page.
          - `company_logo` string: The base64-encoded image data displayed in the company logo.
          - `components` StatusPageAsIncludedAttributesComponentsItems[]: Components displayed on the status page.
            - `components` StatusPageAsIncludedAttributesComponentsItemsComponentsItems[]: If the component is of type `group`, the components within the group.
              - …
            - `id` string, uuid: The ID of the component.
            - `name` string: The name of the component.
            - `position` integer: The zero-indexed position of the component.
            - `status` 'operational' | 'degraded' | 'partial_outage' | 'major_outage' | 'maintenance': The status of the component.
            - `type` 'component' | 'group': The type of the component.
          - `created_at` string, date-time: Timestamp of when the status page was created.
          - `custom_domain` string: If configured, the url that the status page is accessible at.
          - `custom_domain_enabled` boolean: Whether the custom domain is configured.
          - `domain_prefix` string: The subdomain of the status page's url taking the form `https://{domain_prefix}.statuspage.datadoghq.com`. Globally unique across Datadog Status Pages.
          - `email_header_image` string: Base64-encoded image data included in email notifications sent to status page subscribers.
          - `enabled` boolean: Whether the status page is enabled.
          - `favicon` string: Base64-encoded image data displayed in the browser tab.
          - `modified_at` string, date-time: Timestamp of when the status page was last modified.
          - `name` string: The name of the status page.
          - `page_url` string: The url that the status page is accessible at.
          - `rss_feed_enabled` boolean: Whether the RSS feed is enabled for the status page.
          - `slack_app_icon` string: The Slack app icon URL for the status page.
          - `slack_subscriptions_enabled` boolean: Whether Slack subscriptions are enabled for the status page.
          - `subscriptions_enabled` boolean: Whether users can subscribe to the status page.
          - `type` 'public' | 'internal': The type of the status page controlling how the status page is accessed.
          - `visualization_layout` 'list' | 'grid': The layout of components on the status page. Defaults to `list`. `grid` requires `visualization_type` to be `component_name_only`; changing `visualization_type` to any other value resets the layout to `list`.
          - `visualization_type` 'bars_and_uptime_percentage' | 'bars_only' | 'component_name_only': The visualization type of the status page.
        - `id` string, uuid: The ID of the status page.
        - `relationships` StatusPageAsIncludedRelationships: The relationships of a status page.
          - `created_by_user` StatusPageAsIncludedRelationshipsCreatedByUser: The Datadog user who created the status page.
            - `data` StatusPageAsIncludedRelationshipsCreatedByUserData, required: The data object identifying the Datadog user who created the status page.
              - …
          - `last_modified_by_user` StatusPageAsIncludedRelationshipsLastModifiedByUser: The Datadog user who last modified the status page.
            - `data` StatusPageAsIncludedRelationshipsLastModifiedByUserData, required: The data object identifying the Datadog user who last modified the status page.
              - …
        - `type` 'status_pages', required: Status pages resource type.

## Other responses

- `429`: Too many requests

---

[API](https://skmtc.dev/datadog/apis/datadog-api-v2-collection.md) - [All operations](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/llms.txt) - [OpenAPI document](https://skmtc.dev/datadog/apis/datadog-api-v2-collection/revisions/3f70db624329?raw)
