---
title: "Read workspace defaults"
method: GET
path: "/settings"
tags: ["Team & settings"]
---

# Read workspace defaults

`GET /settings`

## Request

- Base URL: `https://gtmswag.com/api/v1`
- URL: `https://gtmswag.com/api/v1/settings`
- Auth: HTTP bearer

The default sender name, company, meeting URL, website and brand color new campaigns use.

## Response `200`

Success: `{"data": WorkspaceSettings}`.

- WorkspaceSettingsResponse: The success body: `{"data": WorkspaceSettings}`.
  - `data` WorkspaceSettings, required: The defaults new campaigns use.
    - `company` string, required
    - `name` string, required
    - `meetingUrl` string, required
    - `website` string, required
    - `brandColor` string, required
    - `webhookUrl` string, required

## Other responses

- `401`: Not authenticated: `AUTH_REQUIRED`. no credentials, or an OAuth token on a route that only takes workspace keys; the key is malformed, unknown or revoked.
- `429`: Too many requests: `RATE_LIMIT`. more than 240 requests in the current minute for this workspace (REST and MCP share the limit); wait `retryAfterMs`.
- `default`: Any other refusal or failure, such as 403 CSRF (a cross-origin `Origin` header), 403 HTTPS_REQUIRED or 500 INTERNAL_ERROR, with what to do next.

---

[API](https://skmtc.dev/gtmswag/apis/gtm-swag-api.md) · [All operations](https://skmtc.dev/gtmswag/apis/gtm-swag-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gtmswag/apis/gtm-swag-api/revisions/9ff86fa99afe?raw)