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 Custom Fields API

Custom field definition management for workspaces, templates, and signing requests

Firma.dev Custom Fields 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 5 JSON Schema definitions.

Tagged areas include Custom Fields. The published artifact set on APIs.io includes an OpenAPI specification and 5 JSON Schemas.

This API exposes 10 operations across 6 paths, and defines 6 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.

10 operations 6 paths 6 schemas 3 DELETE3 GET3 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 Custom Fields 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 10

Across 6 paths, the API surfaces 10 operations — 3 DELETE, 3 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Custom Fields 10

Custom field definition management for workspaces, templates, and signing requests

GET
/workspace/{workspace_id}/custom-fields
List workspace custom fields
listWorkspaceCustomFields 1 param → 200401404
POST
/workspace/{workspace_id}/custom-fields
Create workspace custom field
createWorkspaceCustomField 1 param body → 201400401409
PUT
/workspace/{workspace_id}/custom-fields/{field_id}
Update workspace custom field
updateWorkspaceCustomField 2 params body → 200400401404409
DELETE
/workspace/{workspace_id}/custom-fields/{field_id}
Delete workspace custom field
deleteWorkspaceCustomField 2 params → 200401404
GET
/templates/{template_id}/custom-fields
List template custom fields
listTemplateCustomFields 1 param → 200401404
POST
/templates/{template_id}/custom-fields
Create template custom field
createTemplateCustomField 1 param body → 201400401404409
DELETE
/templates/{template_id}/custom-fields/{field_id}
Delete template custom field
deleteTemplateCustomField 2 params → 200401404
GET
/signing-requests/{request_id}/custom-fields
List signing request custom fields
listSigningRequestCustomFields 1 param → 200401404
POST
/signing-requests/{request_id}/custom-fields
Create signing request custom field
createSigningRequestCustomField 1 param body → 201400401404409
DELETE
/signing-requests/{request_id}/custom-fields/{field_id}
Delete signing request custom field
deleteSigningRequestCustomField 2 params → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are WorkspaceCustomField (7 properties), SigningRequestCustomField (6 properties), Error (5 properties), TemplateCustomField (5 properties). Each schema is shown below with its type and property counts.

WorkspaceCustomField
object
A custom field definition for a workspace
7 properties 3 required
MessageResponse
object
Simple success response with a message
1 property 1 required
TemplateCustomField
object
A custom field definition for a template
5 properties 2 required
Error
object
Organization Seal error codes: SEALSDISABLED, SEALALREADYREVOKED, SEALCREATIONDISABLEDEDGE, SEALERASENOTELIGIBLE, SEALIMAGEINVALID, SEALMUTATIONNOTALLOWED, SEA…
5 properties 1 required
CustomFieldListResponse
object
List of custom fields
1 property 1 required
SigningRequestCustomField
object
A custom field definition for a signing request
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firma-dev-custom-fields-api-openapi.yml Raw ↑

Other APIs Firma.dev publishes across the network.

Firma.dev Company 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
Firma.dev Workspaces API
Where this information came from

This is an independent, third-party profile of Firma.dev Custom Fields 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.