# Get support config

Retrieve the support page configuration for a dashboard.

Source: https://statusdashboard.com/docs/api/status-dashboards/dashboards/support/get

`GET /app/dashboards/{id}/support`

Returns the current support page configuration for a dashboard.

***

## Path parameters
| Parameter | Description                |
| --------- | -------------------------- |
| `id`      | The UUID of the dashboard. |

***

## Request
See [API Basics](/docs/api) for required headers.

This endpoint takes no request body.

***

## Sample request
```bash
curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/support \
  -H "Authorization: Bearer bcf847abf5c6:def456"
```

## Sample response
**Status: `200 OK`**

```json
{
  "enabled": true,
  "paragraph": "<p>Contact our team using the escalation path below.</p>",
  "contacts": [
    {
      "type": "process",
      "name": "Submit a support ticket",
      "url": "https://support.example.com/new-ticket",
      "instructions": "Open a ticket at the link above. If you don't hear back in 10 minutes, escalate to the next step."
    },
    {
      "type": "person",
      "name": "Help Desk",
      "title": "First response",
      "email": "helpdesk@example.com",
      "phone": "+1 800 555 0100",
      "url": "https://support.example.com",
      "instructions": "Call the helpdesk first, then email if no response.",
      "hidden": false
    }
  ],
  "faq": [
    {
      "question": "How do I report an issue not shown here?",
      "answer": "<p>Email helpdesk@example.com with a description of the problem.</p>"
    }
  ]
}
```

When no support configuration has been saved yet, the response still returns `200` with only `enabled: false`:

```json
{
  "enabled": false
}
```

***

## Response fields
| Field       | Type                | Description                                                                                                                                                |
| ----------- | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enabled`   | boolean             | Whether the support page is publicly accessible.                                                                                                           |
| `paragraph` | string \| undefined | Introductory paragraph for the support page. Rich text field. See [Rich text fields](/docs/api#rich-text-fields). Max 1,000 characters. Absent if not set. |
| `contacts`  | array \| undefined  | Up to 5 contact cards in escalation order. Absent if not set.                                                                                              |
| `faq`       | array \| undefined  | Up to 10 FAQ items. Absent if not set.                                                                                                                     |

### Contact card object
| Field          | Type                      | Description                                                                                             |
| -------------- | ------------------------- | ------------------------------------------------------------------------------------------------------- |
| `type`         | `"person"` \| `"process"` | Entry type. Always present.                                                                             |
| `name`         | string                    | Display name (person) or process step label. Always present.                                            |
| `title`        | string \| undefined       | Job title or role. Present on person entries only.                                                      |
| `email`        | string \| undefined       | Email address. Present on person entries only.                                                          |
| `phone`        | string \| undefined       | Phone number. Present on person entries only.                                                           |
| `url`          | string \| undefined       | URL — support portal link or Slack channel.                                                             |
| `instructions` | string \| undefined       | Optional plain-text note shown below the contact details.                                               |
| `hidden`       | boolean \| undefined      | When `true`, this entry is omitted from the support page response. Only visible in admin API responses. |

### FAQ item object
| Field      | Type   | Description                                                                                            |
| ---------- | ------ | ------------------------------------------------------------------------------------------------------ |
| `question` | string | The question text.                                                                                     |
| `answer`   | string | FAQ answer. Rich text field. See [Rich text fields](/docs/api#rich-text-fields). Max 1,000 characters. |

***

## Error responses
| Status | When                                                                 |
| ------ | -------------------------------------------------------------------- |
| `404`  | Dashboard not found or does not belong to the caller's organization. |