Workspaces

Get a workspace

Retrieve a specific workspace by ID including its API key

get/workspaces/{id}

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/workspaces/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Workspace ID

Response

Workspace retrieved successfully

idstring uuid required

Unique identifier for the workspace

namestring required

Workspace name

protectedboolean

Protected workspaces cannot be deleted

api_keystring nullable

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

test_api_keystring nullable

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

created_datestring date-time required

Workspace creation timestamp

updated_datestring date-time

Workspace last update timestamp

webhook_enabledboolean

Whether workspace-level webhooks are enabled

webhook_secretstring nullable

Webhook signing secret for this workspace

webhook_secret_rotated_atstring date-time nullable

Timestamp of the last webhook secret rotation

webhook_secret_created_atstring date-time nullable

Timestamp when the webhook secret was first created

ignore_company_webhooksboolean

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

icon_urlstring uri nullable

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 response

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

Changes

No recorded changes to this operation across all 13 revisions of this API.