---
title: "Get a project's support settings"
method: GET
path: "/v1/projects/{project}/support/settings"
tags: ["Support Inbox"]
---

# Get a project's support settings

`GET /v1/projects/{project}/support/settings`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/support/settings`
- Auth: HTTP bearer

```bash
curl https://api.subscriby.net/v1/projects/$PROJECT_ID/support/settings \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN"
```

| Field          | Type           | Notes                                                                                                                                          |
| -------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `enabled`      | boolean        | Whether a member's unrecognised message to the bot opens a conversation. Off stops **new** threads reaching the inbox; existing ones are kept. |
| `relay_mode`   | string         | `owner_dm`: the platform bot messages the project owner with an inline Reply button. `forum_group`: each conversation is mirrored into its own topic of a group the bot administers. `none`: the dashboard inbox is the only surface. |
| `agent_name`   | string or null | The name outbound replies are prefixed with so they read as coming from a person. `null` falls back to the project's default.                  |
| `auto_reply`   | string or null | Sent to a member on their first message in a thread. `null` sends nothing.                                                                     |
| `notify_email` | boolean        | Whether the creator is emailed about new support activity.                                                                                     |

The keys drop the `support_` prefix the columns carry: on this endpoint everything is about support.

> **The relay chat id is never exposed.** The chat the `owner_dm` relay posts to, and the group `forum_group` mirrors into, are identifiers the bot handshake writes, not settings. They do not appear here and cannot be set from here.

## Path parameters

- `project` string, uuid, required

## Response `200`

The settings.

- object
  - `data` SupportSettingsResource, required: A project's support inbox settings: whether members can open a conversation, how the creator is relayed, the agent name, the auto-reply and email notifications.
    - `project_id` string, required: The project the settings belong to.
    - `enabled` boolean, required: Whether a member's unrecognised message to the bot opens a conversation. Off stops **new** threads reaching the inbox; existing ones are kept.
    - `relay_mode` string, required: `owner_dm` (the platform bot messages the project owner with an inline Reply button), `forum_group` (each conversation mirrored into its own topic of a group the bot administers) or `none` (the dashboard inbox is the only surface).
    - `agent_name` string, nullable, required: The name outbound replies are prefixed with so they read as coming from a person; null falls back to the project's default.
    - `auto_reply` string, nullable, required: Sent to a member on their first message in a thread; null sends nothing.
    - `notify_email` boolean, required: Whether the creator is emailed about new support activity.
    - `updated_at` string, nullable, required: When the project last changed, ISO 8601.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)