Skip to main content
GET
/
workspaces
/
{id}
Get a workspace
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspaces/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "789e4567-e89b-12d3-a456-426614174000",
  "name": "Sales Workspace",
  "protected": false,
  "api_key": "fk_a1b2c3d4e5f6g7h8i9j0",
  "created_date": "2024-01-20T09:00:00Z",
  "updated_date": "2024-01-20T09:00:00Z",
  "webhook_enabled": false,
  "webhook_secret": null,
  "webhook_secret_rotated_at": null,
  "webhook_secret_created_at": null,
  "ignore_company_webhooks": false
}

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

​
id
string<uuid>
required

Workspace ID

Response

Workspace retrieved successfully

​
id
string<uuid>

Unique identifier for the workspace

​
name
string

Workspace name

Maximum string length: 255
​
protected
boolean

Protected workspaces cannot be deleted

​
api_key
string | null

Live-mode API key for this workspace. Used for authenticating API requests scoped to this workspace.

​
test_api_key
string | null

Test-mode API key for this workspace. Requests authenticated with this key do not consume credits and produce test-flagged, watermarked signing requests.

​
created_date
string<date-time>

Workspace creation timestamp

​
updated_date
string<date-time>

Workspace last update timestamp

​
webhook_enabled
boolean

Whether workspace-level webhooks are enabled

​
webhook_secret
string | null

Webhook signing secret for this workspace

​
webhook_secret_rotated_at
string<date-time> | null

Timestamp of the last webhook secret rotation

​
webhook_secret_created_at
string<date-time> | null

Timestamp when the webhook secret was first created

​
ignore_company_webhooks
boolean

When true, company-level webhooks do not fire for events in this workspace

​
icon_url
string<uri> | null

Publicly accessible URL to the workspace logo image. Returns the workspace-specific logo, or null if not set (company logo is NOT included as fallback in this field).

Example:

"https://ielmshcswdhuacyjlpiy.supabase.co/functions/v1/logo/workspace/company-id/workspace-id"