Skip to main content
GET
/
workspace
/
{workspace_id}
/
settings
Get workspace settings
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings \
  --header 'Authorization: <api-key>'
{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "signing_request_email_header": "<string>",
  "signing_request_email_body": "<string>",
  "team_email": "jsmith@example.com",
  "timezone": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.firma.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

workspace_id
string<uuid>
required

Response

Workspace settings retrieved successfully

workspace_id
string<uuid>
signing_request_email_header
string

Custom email header text

signing_request_email_body
string

Custom HTML email body

team_email
string<email>

Workspace contact email

timezone
string

Workspace timezone