How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Firma.dev Workspaces API

Workspace management operations

Firma.dev Workspaces API is one of 12 APIs that Firma.dev publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Workspace. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 9 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 01.38.00.

Requests are made against 2 base URLs: https://api.firma.dev/functions/v1/signing-request-api, https://api.firma.dev/api/v1.

9 operations 5 paths 8 schemas 1 DELETE2 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
01.38.00
Servers
https://api.firma.dev/functions/v1/signing-request-api
https://api.firma.dev/api/v1
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Firma.dev Workspaces API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

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

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Workspaces 9

Workspace management operations

GET
/workspaces
List workspaces
listWorkspaces 8 params → 200400401429
POST
/workspaces
Create a new workspace
createWorkspace body → 201400401429
GET
/workspaces/{id}
Get a workspace
getWorkspace 1 param → 200401404429
PUT
/workspaces/{id}
Update a workspace
updateWorkspace 1 param body → 200400401404429
PATCH
/workspaces/{id}
Partially update a workspace
patchWorkspace 1 param body → 200400401404429
POST
/workspaces/{id}/api-key/regenerate
Regenerate workspace API key
regenerateWorkspaceApiKey 1 param body → 201400401403404429
POST
/workspaces/{id}/api-key/expire
Expire pending API keys
expireWorkspaceApiKey 1 param body → 200400401403404429
POST
/workspaces/{id}/logo
Upload Workspace Logo
uploadWorkspaceLogo 1 param body → 200400
DELETE
/workspaces/{id}/logo
Remove Workspace Logo
deleteWorkspaceLogo 1 param → 200

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Workspace (13 properties), Error (5 properties), ApiKeyRegenerateResponse (4 properties), Pagination (4 properties). Each schema is shown below with its type and property counts.

ApiKeyExpireResponse
object
API key expiration result
4 properties 2 required
LogoDeleteResponse
object
Logo deletion confirmation
1 property 1 required
Pagination
object
Pagination metadata for list responses
4 properties 4 required
Workspace
object
13 properties 3 required
Error
object
Organization Seal error codes: SEALSDISABLED, SEALALREADYREVOKED, SEALCREATIONDISABLEDEDGE, SEALERASENOTELIGIBLE, SEALIMAGEINVALID, SEALMUTATIONNOTALLOWED, SEA…
5 properties 1 required
ApiKeyRegenerateResponse
object
API key regeneration result
4 properties 3 required
LogoUploadResponse
object
Logo upload confirmation with URL
2 properties 2 required
WorkspaceListResponse
object
Paginated list of workspaces
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firma-dev-workspaces-api-openapi.yml Raw ↑

Other APIs Firma.dev publishes across the network.

Firma.dev Company API
Firma.dev Custom Fields API
Firma.dev Email Domains API
Firma.dev Email Templates API
Firma.dev JWT Management API
Firma.dev Organization Seals API
Firma.dev Signer Terms API
Firma.dev Signing Requests API
Firma.dev Templates API
Firma.dev Webhooks API
Firma.dev Workspace Settings API
Where this information came from

This is an independent, third-party profile of Firma.dev Workspaces API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.