Skip to main content
POST
/
workspaces
Create a new workspace
curl --request POST \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspaces \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Marketing Workspace"
}
'
{
  "id": "abc12345-e89b-12d3-a456-426614174000",
  "name": "Marketing Workspace",
  "protected": false,
  "api_key": "fk_m1n2o3p4q5r6s7t8u9v0",
  "date_created": "2024-01-25T14:00:00Z",
  "date_changed": "2024-01-25T14:00:00Z"
}

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.

Body

application/json
​
name
string
required

Workspace name

Maximum string length: 255

Response

Workspace created 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

Unique API key for this workspace. Used for authenticating API requests scoped to this workspace.

​
date_created
string<date-time>

Workspace creation timestamp

​
date_changed
string<date-time>

Workspace last update timestamp