Workspace Settings API

Workspace settings store your organization's profile information -- company name, industry, timezone, and other metadata. These settings are used across the dashboard and in email templates (e.g., the company name in footer compliance blocks).

Note

For a user guide on configuring workspace settings in the dashboard, see Workspace Settings.

Endpoints

Method	Path	Description
`GET`	`/v1/workspace/settings`	Get workspace settings
`PUT`	`/v1/workspace/settings`	Update workspace settings

Get Workspace Settings

Returns the current workspace settings including company profile, timezone, and branding metadata.

bash

curl https://synapse-api.pyrx.tech/v1/workspace/settings \

-H "Authorization: Bearer <jwt>"

Auth: JWT (dashboard). Requires settings:read permission.

Response

json

{

"name": "Acme Corp",

"industry": "SaaS",

"company_size": "51-200",

"country": "SG",

"timezone": "Asia/Singapore",

"slug": "acme-corp",

"logo_url": "https://cdn.pyrx.tech/logos/acme-corp.png",

"company_website": "https://acme.com",

"created_at": "2026-01-10T08:00:00Z"

}

Response Fields

Field	Type	Description
`name`	string	Workspace display name
`industry`	string or null	Industry category (e.g., `"SaaS"`, `"E-commerce"`, `"Healthcare"`)
`company_size`	string or null	Employee count range (e.g., `"1-10"`, `"11-50"`, `"51-200"`, `"201-1000"`, `"1000+"`)
`country`	string or null	ISO 3166-1 alpha-2 or alpha-3 country code (e.g., `"SG"`, `"US"`, `"VN"`)
`timezone`	string	IANA timezone identifier (e.g., `"Asia/Singapore"`, `"America/New_York"`)
`slug`	string	URL-safe workspace identifier, auto-generated from the workspace name
`logo_url`	string or null	URL to the workspace logo image
`company_website`	string or null	Company website URL
`created_at`	datetime	When the workspace was created

Update Workspace Settings

Updates one or more workspace settings fields. Only provided fields are updated -- omitted fields remain unchanged.

bash

curl -X PUT https://synapse-api.pyrx.tech/v1/workspace/settings \

-H "Authorization: Bearer <jwt>" \

-H "Content-Type: application/json" \

-d '{

"name": "Acme Corp International",

"industry": "SaaS",

"company_size": "201-1000",

"country": "US",

"timezone": "America/New_York"

Auth: JWT (dashboard). Requires settings:write permission.

Request Body

Field	Type	Required	Description
`name`	string	No	Workspace name (1-255 characters)
`industry`	string	No	Industry category (max 100 characters)
`company_size`	string	No	Employee count range (max 50 characters)
`country`	string	No	Country code (max 3 characters)
`timezone`	string	No	IANA timezone identifier (max 50 characters)

All fields are optional. Pass only the fields you want to change.

Response (200 OK)

Returns the full updated settings object:

json

{

"name": "Acme Corp International",

"industry": "SaaS",

"company_size": "201-1000",

"country": "US",

"timezone": "America/New_York",

"slug": "acme-corp",

"logo_url": "https://cdn.pyrx.tech/logos/acme-corp.png",

"company_website": "https://acme.com",

"created_at": "2026-01-10T08:00:00Z"

}

Note

The slug, logo_url, company_website, and created_at fields are read-only and cannot be changed through this endpoint. The slug is derived from the workspace name when the workspace is first created.

Error: Permission Denied (403 Forbidden)

json

{

"detail": "Missing permission: settings:write"

}

Permissions by Role

Role	Read settings	Write settings
Owner	Yes	Yes
Admin	Yes	Yes
Developer	Yes	No
Marketing	Yes	No
Operations	Yes	No
Viewer	No	No