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 Templates API

Template management operations

Firma.dev Templates 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 Templates. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 12 operations across 8 paths, and defines 20 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.

12 operations 8 paths 20 schemas 1 DELETE5 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 Templates 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 12

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

Templates 12

Template management operations

GET
/templates
List Templates
listTemplates 7 params → 200401429
POST
/templates
Create Template
createTemplate body → 201400401429
GET
/templates/{id}
Get Template
getTemplate 1 param → 200401404429
PATCH
/templates/{id}
Partially Update Template
patchTemplate 1 param body → 200400401404429
PUT
/templates/{id}
Comprehensive Template Update
updateTemplate 1 param body → 200400401404429
DELETE
/templates/{id}
Delete a template
deleteTemplate 1 param → 200401404429
GET
/templates/{id}/users
Get template users
listTemplateUsers 1 param → 200401404429
GET
/templates/{id}/fields
Get template fields
listTemplateFields 1 param → 200401404429
GET
/templates/{id}/reminders
Get template reminders
listTemplateReminders 1 param → 200401404429
POST
/templates/{id}/replace-document
Replace template document
replaceTemplateDocument 1 param body → 200400401404429
POST
/templates/{id}/duplicate
Duplicate template into signing request
duplicateTemplate 1 param body → 201401403404429
POST
/templates/{id}/copy
Copy template to another workspace
postTemplatesByIdCopy 1 param body → 201400401403404429

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are TemplateUser (19 properties), TemplateField (16 properties), SigningRequestSettings (15 properties), Template (13 properties). Each schema is shown below with its type and property counts.

MessageResponse
object
Simple success response with a message
1 property 1 required
Condition
object
A single condition that evaluates a field's value.
3 properties 2 required
TemplateFieldListResponse
object
List of template fields
1 property 1 required
TemplatePatchResponse
object
Template partial update result
3 properties 2 required
TemplateListResponse
object
Paginated list of templates
2 properties 2 required
Error
object
Organization Seal error codes: SEALSDISABLED, SEALALREADYREVOKED, SEALCREATIONDISABLEDEDGE, SEALERASENOTELIGIBLE, SEALIMAGEINVALID, SEALMUTATIONNOTALLOWED, SEA…
5 properties 1 required
FieldValidationRules
objectnull
Validation rules for field values. Reserved for future use - currently not enforced for any field types.
TemplateUserListResponse
object
List of template users
1 property 1 required
Template
object
13 properties 3 required
TemplateCopyResponse
object
Template copy response
4 properties 4 required
Reminder
object
10 properties 4 required
ErrorResponse
object
Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a cl…
TemplateUser
object
19 properties 5 required
Pagination
object
Pagination metadata for list responses
4 properties 4 required
ConditionGroup
object
1 property 1 required
ConditionSet
object
A set of condition groups with nested logic. The outer 'logic' operator combines groups, while each group's conditions use the opposite operator. Example: logi…
2 properties 2 required
DateFormatRules
object
Formatting rules for date fields. Specifies how date values should be displayed and formatted.
2 properties
TemplateDuplicateResponse
object
Duplicated template details
6 properties 4 required
TemplateField
object
A field placed on a template document
16 properties 3 required
SigningRequestSettings
object
Settings returned by the signing request list and detail endpoints. Templates use the TemplateSettings schema (no identity fields).
15 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

firma-dev-templates-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 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 Templates 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.