Get workspace settings

Fetch workspace-level configuration: name, domains, SLA, timezone, and inbound email. Requires the admin scope.

GET

/api/v2/settings/workspace

GET

/settings/workspace

curl -X GET "https://productlane.com/api/v2/settings/workspace" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY"

Authorization

Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

application/json

Successful response

id
string
required
name
string
required
domain
string
required
custom_domain
string | null
required
logo_url
string | null
required
timezone
string | null
required
sla_enabled
boolean
required
sla_use_business_hours
boolean
required
max_response_time_hours
number | null
required
office_hours
any
email_integration_enabled
boolean
required
email_integration_address
string | null
required
domain_company_assignment_enabled
boolean
required
auto_switch_contact_to_latest_sender
boolean
required
auto_create_linear_customers
boolean
required
revenue_currency
string
required
revenue_formatting
string
required
dark_mode
boolean | null
required
true forces dark mode, false forces light mode, null follows the visitor's system setting.
accent_color
string
required
accent_text_color
string
required
button_text_color
string
required
dark_mode_accent_color
string
required
dark_mode_accent_text_color
string
required
dark_mode_button_text_color
string
required
portal_embed_image_url
string | null
required
created_at
string
required
updated_at
string
required

{
  "id": "string",
  "name": "string",
  "domain": "string",
  "custom_domain": "string",
  "logo_url": "string",
  "timezone": "string",
  "sla_enabled": true,
  "sla_use_business_hours": true,
  "max_response_time_hours": 0,
  "office_hours": null,
  "email_integration_enabled": true,
  "email_integration_address": "string",
  "domain_company_assignment_enabled": true,
  "auto_switch_contact_to_latest_sender": true,
  "auto_create_linear_customers": true,
  "revenue_currency": "string",
  "revenue_formatting": "string",
  "dark_mode": true,
  "accent_color": "string",
  "accent_text_color": "string",
  "button_text_color": "string",
  "dark_mode_accent_color": "string",
  "dark_mode_accent_text_color": "string",
  "dark_mode_button_text_color": "string",
  "portal_embed_image_url": "string",
  "created_at": "string",
  "updated_at": "string"
}

GET

/settings/workspace

curl -X GET "https://productlane.com/api/v2/settings/workspace" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY"

{
  "id": "string",
  "name": "string",
  "domain": "string",
  "custom_domain": "string",
  "logo_url": "string",
  "timezone": "string",
  "sla_enabled": true,
  "sla_use_business_hours": true,
  "max_response_time_hours": 0,
  "office_hours": null,
  "email_integration_enabled": true,
  "email_integration_address": "string",
  "domain_company_assignment_enabled": true,
  "auto_switch_contact_to_latest_sender": true,
  "auto_create_linear_customers": true,
  "revenue_currency": "string",
  "revenue_formatting": "string",
  "dark_mode": true,
  "accent_color": "string",
  "accent_text_color": "string",
  "button_text_color": "string",
  "dark_mode_accent_color": "string",
  "dark_mode_accent_text_color": "string",
  "dark_mode_button_text_color": "string",
  "portal_embed_image_url": "string",
  "created_at": "string",
  "updated_at": "string"
}

- Introduction
- Authentication
- MCP Server
- Errors
- Rate limits
- Pagination
- Article content
- Webhooks
- Migrating from API v1 to v2

APISettings

Get workspace settings

Fetch workspace-level configuration: name, domains, SLA, timezone, and inbound email. Requires the admin scope.

GET

/api/v2/settings/workspace

GET

/settings/workspace

curl -X GET "https://productlane.com/api/v2/settings/workspace" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY"

Authorization

Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

application/json

Successful response

id
string
required
name
string
required
domain
string
required
custom_domain
string | null
required
logo_url
string | null
required
timezone
string | null
required
sla_enabled
boolean
required
sla_use_business_hours
boolean
required
max_response_time_hours
number | null
required
office_hours
any
email_integration_enabled
boolean
required
email_integration_address
string | null
required
domain_company_assignment_enabled
boolean
required
auto_switch_contact_to_latest_sender
boolean
required
auto_create_linear_customers
boolean
required
revenue_currency
string
required
revenue_formatting
string
required
dark_mode
boolean | null
required
true forces dark mode, false forces light mode, null follows the visitor's system setting.
accent_color
string
required
accent_text_color
string
required
button_text_color
string
required
dark_mode_accent_color
string
required
dark_mode_accent_text_color
string
required
dark_mode_button_text_color
string
required
portal_embed_image_url
string | null
required
created_at
string
required
updated_at
string
required

{
  "id": "string",
  "name": "string",
  "domain": "string",
  "custom_domain": "string",
  "logo_url": "string",
  "timezone": "string",
  "sla_enabled": true,
  "sla_use_business_hours": true,
  "max_response_time_hours": 0,
  "office_hours": null,
  "email_integration_enabled": true,
  "email_integration_address": "string",
  "domain_company_assignment_enabled": true,
  "auto_switch_contact_to_latest_sender": true,
  "auto_create_linear_customers": true,
  "revenue_currency": "string",
  "revenue_formatting": "string",
  "dark_mode": true,
  "accent_color": "string",
  "accent_text_color": "string",
  "button_text_color": "string",
  "dark_mode_accent_color": "string",
  "dark_mode_accent_text_color": "string",
  "dark_mode_button_text_color": "string",
  "portal_embed_image_url": "string",
  "created_at": "string",
  "updated_at": "string"
}

GET

/settings/workspace

curl -X GET "https://productlane.com/api/v2/settings/workspace" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY"

{
  "id": "string",
  "name": "string",
  "domain": "string",
  "custom_domain": "string",
  "logo_url": "string",
  "timezone": "string",
  "sla_enabled": true,
  "sla_use_business_hours": true,
  "max_response_time_hours": 0,
  "office_hours": null,
  "email_integration_enabled": true,
  "email_integration_address": "string",
  "domain_company_assignment_enabled": true,
  "auto_switch_contact_to_latest_sender": true,
  "auto_create_linear_customers": true,
  "revenue_currency": "string",
  "revenue_formatting": "string",
  "dark_mode": true,
  "accent_color": "string",
  "accent_text_color": "string",
  "button_text_color": "string",
  "dark_mode_accent_color": "string",
  "dark_mode_accent_text_color": "string",
  "dark_mode_button_text_color": "string",
  "portal_embed_image_url": "string",
  "created_at": "string",
  "updated_at": "string"
}