# Namirial Sign Enterprise API

Namirial Sign Enterprise API

Version: v1

## Security

### Bearer

Insert your JWT Bearer token from MyNamirial

Type: http
Scheme: bearer
Bearer Format: JWT

### PersonalAccessToken

Personal Access Token authentication. Provide a token prefixed with 'nse_pat_'.

Type: apiKey
In: header
Name: Personal-Access-Token

## Download OpenAPI description

 - [Namirial Sign Enterprise API](https://docs.namirial.app/_bundle/products/namirialsignenterprise/openapi3.yaml)

## Application Reference Data

 - [GET /api/v1/languages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/application-reference-data/listlanguages.md): Returns the languages supported by the application. Use the `code` values returned here when setting the languages of an organization.
 - [GET /api/v1/countries](https://docs.namirial.app/products/namirialsignenterprise/openapi3/application-reference-data/listcountries.md): Returns the countries available for selection.
 - [GET /api/v1/timezones](https://docs.namirial.app/products/namirialsignenterprise/openapi3/application-reference-data/listtimezones.md): Returns the time zones available for selection.
 - [GET /api/v1/datetime-formats](https://docs.namirial.app/products/namirialsignenterprise/openapi3/application-reference-data/listdatetimeformats.md): Returns the date-time formats available for selection.
## Bulk Envelope

 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope/listbulkenvelopes.md): Returns a paginated list of bulk envelope parents for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/bulk-envelopes](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope/createbulkenvelope.md): Creates a new bulk envelope parent in draft status within the specified organization.
 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope/getbulkenvelope.md): Returns a specific bulk envelope parent.
 - [PUT /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope/updatebulkenvelope.md): Updates a specific bulk envelope parent.
 - [DELETE /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope/deletebulkenvelope.md): Deletes a specific bulk envelope parent and its related child envelopes.
## Bulk Envelope Action

 - [POST /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/send](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-action/sendbulkenvelope.md): Sends the bulk envelope.
## Bulk Envelope Detail

 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/envelopes](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-detail/listbulkenvelopechildenvelopes.md): Returns a paginated list of the child envelopes generated by sending the specified bulk envelope.
## Bulk Envelope File

 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file/listbulkenvelopefiles.md): Returns the files of the specified bulk-envelope.
 - [POST /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file/uploadbulkenvelopefile.md): Adds a new file to the specified bulk-envelope. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document
 - [PATCH /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file/reorderbulkenvelopefiles.md): Reorders the files of the specified bulk-envelope.
 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file/getbulkenvelopefiledetail.md): Returns the properties of a specific bulk-envelope file, including the assigned document class and its metadata values. Does not include the file content.
 - [PUT /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file/updatebulkenvelopefiledetail.md): Updates the properties of a specific bulk-envelope file. Currently supports assigning a document class with metadata values. Does not modify the file content.
 - [DELETE /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file/deletebulkenvelopefile.md): Deletes a specific file from the specified bulk-envelope.
## Bulk Envelope File Task

 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file-task/listbulkenvelopefiletasks.md): Returns the tasks of a specific bulk-envelope file.
 - [PUT /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/files/{fileId}/tasks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-file-task/updatebulkenvelopefiletasks.md): Replaces the tasks of a specific bulk-envelope file.
## Bulk Envelope Stage

 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage/listbulkenvelopestages.md): Returns the stages of the specified bulk envelope.
 - [POST /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage/createbulkenvelopestage.md): Creates a new stage for the specified bulk envelope.
 - [PATCH /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage/reorderbulkenvelopestages.md): Reorders the stages of the specified bulk envelope.
 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage/getbulkenvelopestage.md): Returns a specific bulk envelope stage.
 - [PUT /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage/updatebulkenvelopestage.md): Updates a specific bulk envelope stage.
 - [DELETE /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage/deletebulkenvelopestage.md): Deletes a specific bulk envelope stage.
## Bulk Envelope Stage Recipient

 - [POST /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/createbulkenvelopestagerecipient.md): Creates a new recipient for the specified bulk envelope stage. Standard-mode stages accept both Standard and Automatic recipients; Bulk-mode stages accept Standard recipients only and reject Automatic
 - [GET /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/getbulkenvelopestagerecipient.md): Returns a specific bulk envelope stage recipient.
 - [PUT /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/updatebulkenvelopestagerecipient.md): Updates a specific bulk envelope stage recipient. Standard-mode stages accept both Standard and Automatic recipients; Bulk-mode stages accept Standard recipients only and reject Automatic recipients w
 - [DELETE /api/v1/organizations/{organizationId}/bulk-envelopes/{bulkEnvelopeId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/bulk-envelope-stage-recipient/deletebulkenvelopestagerecipient.md): Deletes a specific bulk envelope stage recipient.
## Document Class

 - [GET /api/v1/organizations/{organizationId}/document-classes](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-class/listdocumentclasses.md): Returns a paginated list of document classes for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/document-classes](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-class/createdocumentclass.md): Creates a new document class with the specified name, optional description, and metadata references. Metadata definitions are managed through the document metadata endpoints.
 - [GET /api/v1/organizations/{organizationId}/document-classes/{documentClassId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-class/getdocumentclass.md): Returns the name, description, and full metadata field data of the specified document class.
 - [PUT /api/v1/organizations/{organizationId}/document-classes/{documentClassId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-class/updatedocumentclass.md): Updates the name, description, and metadata references of the specified document class. Metadata definitions are managed through the document metadata endpoints.
 - [DELETE /api/v1/organizations/{organizationId}/document-classes/{documentClassId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-class/deletedocumentclass.md): Deletes the specified document class.
## Document Metadata

 - [GET /api/v1/organizations/{organizationId}/document-metadata](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-metadata/listdocumentmetadata.md): Returns a paginated list of document metadata fields for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/document-metadata](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-metadata/createdocumentmetadata.md): Creates a new document metadata field for the specified organization.
 - [GET /api/v1/organizations/{organizationId}/document-metadata/{metadataId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-metadata/getdocumentmetadata.md): Returns the specified document metadata field.
 - [PUT /api/v1/organizations/{organizationId}/document-metadata/{metadataId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-metadata/updatedocumentmetadata.md): Updates the specified document metadata field.
 - [DELETE /api/v1/organizations/{organizationId}/document-metadata/{metadataId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-metadata/deletedocumentmetadata.md): Deletes the specified document metadata field.
 - [GET /api/v1/organizations/{organizationId}/document-metadata/{metadataId}/eligible-parents](https://docs.namirial.app/products/namirialsignenterprise/openapi3/document-metadata/getdocumentmetadataeligibleparents.md): Returns the list-option document metadata fields eligible to be set as the parent of the specified field (excludes the field itself and its own children, to avoid cyclic dependencies).
## Envelope

 - [GET /api/v1/organizations/{organizationId}/envelopes](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope/listenvelopes.md): Returns a paginated list of envelopes for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/envelopes](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope/createenvelope.md): Creates a new envelope in draft status within the specified organization.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope/getenvelope.md): Returns a specific envelope.
 - [PUT /api/v1/organizations/{organizationId}/envelopes/{envelopeId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope/updateenvelope.md): Updates a specific envelope.
 - [DELETE /api/v1/organizations/{organizationId}/envelopes/{envelopeId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope/deleteenvelope.md): Deletes a specific envelope.
## Envelope Action

 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-action/sendenvelope.md): Sends the envelope.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/send-reminder](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-action/sendenvelopereminder.md): Sends a reminder notification to pending recipients.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/resume](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-action/resumeenvelope.md): Resumes an envelope that was previously in an expired state.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/cancel](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-action/cancelenvelope.md): Cancels an in-progress envelope, stopping the signing workflow.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/clone](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-action/cloneenvelope.md): Creates a new draft envelope by cloning an existing envelope.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/apply-policies](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-action/applypoliciesonenvelope.md): Applies policies on an existing envelope.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/verify-policies](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-action/verifyenvelopepolicies.md): Checks whether the envelope satisfies all applicable document class policies without modifying its state.
## Envelope Detail

 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/events](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-detail/listenvelopeevents.md): Returns the events of the specified envelope.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/next-recipient-links](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-detail/listnextrecipientlinks.md): Returns the next recipients in the signing workflow with their action links.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-detail/listenvelopeartifacts.md): Returns the artifacts of the specified envelope.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/artifacts/{artifactId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-detail/getenvelopeartifact.md): Returns a specific envelope artifact.
## Envelope File

 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file/listenvelopefiles.md): Returns the files of the specified envelope.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file/uploadenvelopefile.md): Adds a new file to the specified envelope. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document clas
 - [PATCH /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file/reorderenvelopefiles.md): Reorders the files of the specified envelope.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file/getenvelopefiledetail.md): Returns the properties of a specific envelope file, including the assigned document class and its metadata values. Does not include the file content.
 - [PUT /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file/updateenvelopefiledetail.md): Updates the properties of a specific envelope file. Currently supports assigning a document class with metadata values. Does not modify the file content.
 - [DELETE /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file/deleteenvelopefile.md): Deletes a specific file from the specified envelope.
## Envelope File Task

 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file-task/listenvelopefiletasks.md): Returns the tasks of a specific envelope file.
 - [PUT /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/files/{fileId}/tasks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-file-task/updateenvelopefiletasks.md): Replaces the tasks of a specific envelope file.
## Envelope Stage

 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage/listenvelopestages.md): Returns the stages of the specified envelope.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage/createenvelopestage.md): Creates a new stage for the specified envelope.
 - [PATCH /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage/reorderenvelopestages.md): Reorders the stages of the specified envelope.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage/getenvelopestage.md): Returns a specific envelope stage.
 - [PUT /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage/updateenvelopestage.md): Updates a specific envelope stage.
 - [DELETE /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage/deleteenvelopestage.md): Deletes a specific envelope stage.
## Envelope Stage Recipient

 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage-recipient/createenvelopestagerecipient.md): Creates a new recipient for the specified stage.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage-recipient/getenvelopestagerecipient.md): Returns a specific stage recipient.
 - [PUT /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage-recipient/updateenvelopestagerecipient.md): Updates a specific stage recipient.
 - [DELETE /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/envelope-stage-recipient/deleteenvelopestagerecipient.md): Deletes a specific stage recipient.
## Organization Settings Envelope

 - [GET /api/v1/organizations/{organizationId}/settings/envelope/agreement](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-envelope/getagreementsettings.md): Returns the envelope agreement configuration for the specified organization.
 - [PUT /api/v1/organizations/{organizationId}/settings/envelope/agreement](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-envelope/updateagreementsettings.md): Replaces the envelope agreement configuration for the specified organization.
## Organization Settings General

 - [GET /api/v1/organizations/{organizationId}/settings/general](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-general/getgeneralsettings.md): Returns the general configuration for the specified organization.
 - [PATCH /api/v1/organizations/{organizationId}/settings/general](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-general/updategeneralsettings.md): Updates the general configuration for the specified organization.
 - [GET /api/v1/organizations/{organizationId}/settings/general/languages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-general/getlanguagesettings.md): Returns the languages enabled for the specified organization, in alphabetical order.
 - [PUT /api/v1/organizations/{organizationId}/settings/general/languages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-general/updatelanguagesettings.md): Replaces the languages enabled for the specified organization.
 - [GET /api/v1/organizations/{organizationId}/settings/general/regional](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-general/getregionaldefaultssettings.md): Returns the default language, time zone and date-time format for the specified organization.
 - [PUT /api/v1/organizations/{organizationId}/settings/general/regional](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-general/updateregionaldefaultssettings.md): Replaces the default language, time zone and date-time format for the specified organization.
## Organization Settings Recipient

 - [GET /api/v1/organizations/{organizationId}/settings/recipient](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-recipient/getrecipientsettings.md): Returns the recipient configuration for the specified organization.
 - [PATCH /api/v1/organizations/{organizationId}/settings/recipient](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-recipient/updaterecipientsettings.md): Updates the recipient configuration for the specified organization.
 - [GET /api/v1/organizations/{organizationId}/settings/recipient/oauth-providers](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-recipient/listoauthproviders.md): Returns a paginated list of OAuth providers configured for the specified organization.
## Organization Settings Signature

 - [GET /api/v1/organizations/{organizationId}/settings/signature](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-signature/getsignaturesettings.md): Returns the signature configuration for the specified organization.
 - [PATCH /api/v1/organizations/{organizationId}/settings/signature](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-signature/updatesignaturesettings.md): Updates the signature configuration for the specified organization.
 - [GET /api/v1/organizations/{organizationId}/settings/signature/layouts](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-signature/listsignaturelayouts.md): Returns the identifier and name of the signature layouts of the specified organization.
 - [POST /api/v1/organizations/{organizationId}/settings/signature/layouts](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-signature/createsignaturelayout.md): Creates a signature layout for the specified organization and returns its identifier. The `name` is a slug of 1-50 characters (letters, digits and hyphens, not starting or ending with a hyphen), uniqu
 - [GET /api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-signature/getsignaturelayout.md): Returns the full configuration of a signature layout of the specified organization: the fields shown in the signature appearance and the optional image. In the response, `localTimezone` is always set
 - [PUT /api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-signature/updatesignaturelayout.md): Replaces the whole signature layout, image included: omitting `image` removes it. The same rules of the creation apply. The layout named `default` cannot be renamed.
 - [DELETE /api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-signature/deletesignaturelayout.md): Deletes a signature layout of the specified organization. The layout named `default` cannot be deleted.
## Organization Settings User

 - [GET /api/v1/organizations/{organizationId}/settings/user/business-roles](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/listbusinessroles.md): Returns a paginated list of business roles for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/settings/user/business-roles](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/createbusinessrole.md): Creates a new business role with the specified name and optional description.
 - [GET /api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/getbusinessrole.md): Returns the details of the specified business role.
 - [PUT /api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/updatebusinessrole.md): Replaces the name and description of the specified business role.
 - [DELETE /api/v1/organizations/{organizationId}/settings/user/business-roles/{businessRoleId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/deletebusinessrole.md): Deletes the specified business role.
 - [GET /api/v1/organizations/{organizationId}/settings/user/application-roles](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/listapplicationroles.md): Returns a paginated list of application roles for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/settings/user/application-roles](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/createapplicationrole.md): Creates a new custom application role with the specified name, optional description, and permissions.
 - [GET /api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/getapplicationrole.md): Returns the full details of the specified application role.
 - [PUT /api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/updateapplicationrole.md): Replaces the name, description, and permissions of the specified application role.
 - [DELETE /api/v1/organizations/{organizationId}/settings/user/application-roles/{applicationRoleId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/organization-settings-user/deleteapplicationrole.md): Deletes the specified custom application role.
## Policy

 - [GET /api/v1/organizations/{organizationId}/policies](https://docs.namirial.app/products/namirialsignenterprise/openapi3/policy/listpolicies.md): Returns a paginated list of policies for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/policies](https://docs.namirial.app/products/namirialsignenterprise/openapi3/policy/createpolicy.md): Creates a new policy with the specified conditions and actions for the specified organization.
 - [GET /api/v1/organizations/{organizationId}/policies/{policyId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/policy/getpolicy.md): Returns the full policy, including its conditions and actions, for the specified organization.
 - [PUT /api/v1/organizations/{organizationId}/policies/{policyId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/policy/updatepolicy.md): Updates a specific policy.
 - [DELETE /api/v1/organizations/{organizationId}/policies/{policyId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/policy/deletepolicy.md): Deletes the specified policy.
## Template

 - [GET /api/v1/organizations/{organizationId}/templates](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template/listtemplates.md): Returns a paginated list of templates for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/templates](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template/createtemplate.md): Creates a new template within the specified organization.
 - [GET /api/v1/organizations/{organizationId}/templates/{templateId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template/gettemplate.md): Returns a specific template.
 - [PUT /api/v1/organizations/{organizationId}/templates/{templateId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template/updatetemplate.md): Updates a specific template.
 - [DELETE /api/v1/organizations/{organizationId}/templates/{templateId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template/deletetemplate.md): Deletes a specific template.
## Template Action

 - [POST /api/v1/organizations/{organizationId}/templates/{templateId}/create-envelope](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-action/createenvelopefromtemplate.md): Creates a new draft envelope from the specified template.
## Template File

 - [GET /api/v1/organizations/{organizationId}/templates/{templateId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file/listtemplatefiles.md): Returns the files of the specified template.
 - [POST /api/v1/organizations/{organizationId}/templates/{templateId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file/uploadtemplatefile.md): Adds a new file to the specified template. The request body provides the file content (multipart/form-data) and, optionally, an initial document class assignment. Metadata values for the document clas
 - [PATCH /api/v1/organizations/{organizationId}/templates/{templateId}/files](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file/reordertemplatefiles.md): Reorders the files of the specified template.
 - [GET /api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file/gettemplatefiledetail.md): Returns the properties of a specific template file, including the assigned document class and its metadata values. Does not include the file content.
 - [PUT /api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file/updatetemplatefiledetail.md): Updates the properties of a specific template file. Currently supports assigning a document class with metadata values. Does not modify the file content.
 - [DELETE /api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file/deletetemplatefile.md): Deletes a specific file from the specified template.
## Template File Task

 - [GET /api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file-task/listtemplatefiletasks.md): Returns the tasks of a specific template file.
 - [PUT /api/v1/organizations/{organizationId}/templates/{templateId}/files/{fileId}/tasks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-file-task/updatetemplatefiletasks.md): Replaces the tasks of a specific template file.
## Template Stage

 - [GET /api/v1/organizations/{organizationId}/templates/{templateId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage/listtemplatestages.md): Returns the stages of the specified template.
 - [POST /api/v1/organizations/{organizationId}/templates/{templateId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage/createtemplatestage.md): Creates a new stage for the specified template.
 - [PATCH /api/v1/organizations/{organizationId}/templates/{templateId}/stages](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage/reordertemplatestages.md): Reorders the stages of the specified template.
 - [GET /api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage/gettemplatestage.md): Returns a specific template stage.
 - [PUT /api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage/updatetemplatestage.md): Updates a specific template stage.
 - [DELETE /api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage/deletetemplatestage.md): Deletes a specific template stage.
## Template Stage Recipient

 - [POST /api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage-recipient/createtemplatestagerecipient.md): Creates a new recipient for the specified template stage.
 - [GET /api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage-recipient/gettemplatestagerecipient.md): Returns a specific template stage recipient.
 - [PUT /api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage-recipient/updatetemplatestagerecipient.md): Updates a specific template stage recipient.
 - [DELETE /api/v1/organizations/{organizationId}/templates/{templateId}/stages/{stageId}/recipients/{recipientId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/template-stage-recipient/deletetemplatestagerecipient.md): Deletes a specific template stage recipient.
## User

 - [GET /api/v1/organizations/{organizationId}/users](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user/listusers.md): Returns a paginated list of users within the specified organization.
 - [POST /api/v1/organizations/{organizationId}/users](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user/createuser.md): Creates a new user within the specified organization.
 - [GET /api/v1/organizations/{organizationId}/users/{userId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user/getuser.md): Returns a specific user
 - [PUT /api/v1/organizations/{organizationId}/users/{userId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user/updateuser.md): Updates a specific user.
 - [DELETE /api/v1/organizations/{organizationId}/users/{userId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user/deleteuser.md): Deletes a user within the specified organization.
 - [PUT /api/v1/organizations/{organizationId}/users/{userId}/application-roles](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user/updateuserapplicationroles.md): Replaces the full set of application roles assigned to a user within the specified organization.
## User Group

 - [GET /api/v1/organizations/{organizationId}/user-groups](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/listusergroups.md): Returns a paginated list of user groups for the specified organization.
 - [POST /api/v1/organizations/{organizationId}/user-groups](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/createusergroup.md): Creates a new user group with the specified name.
 - [PUT /api/v1/organizations/{organizationId}/user-groups/{userGroupId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/updateusergroup.md): Replaces the name of the specified user group.
 - [DELETE /api/v1/organizations/{organizationId}/user-groups/{userGroupId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/deleteusergroup.md): Deletes the specified user group.
 - [GET /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/listgroupcontactcustomfields.md): Returns the custom fields defined for the contacts of the group. Use their ids to read the custom field values of a contact.
 - [GET /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/listusergroupusers.md): Returns a paginated list of users in the group.
 - [POST /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/addusertogroup.md): Adds a user to the group with optional permissions and business role.
 - [GET /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/getgroupuser.md): Returns details about a specific user in the group.
 - [PATCH /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/updategroupuser.md): Updates a user's permissions and/or business role in the group.
 - [DELETE /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/users/{userId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/deletegroupuser.md): Removes a user from the group.
 - [GET /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/listgroupcontacts.md): Returns a paginated list of the contacts shared in the group, including their custom field values.
 - [POST /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/creategroupcontact.md): Creates a contact in the group. The values of the group's custom fields are sent as additional properties next to the standard fields, keyed by custom field name; a property that is neither a standard
 - [GET /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/getgroupcontact.md): Returns a single contact shared in the group, including its custom field values.
 - [PUT /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/updategroupcontact.md): Replaces a contact of the group as a whole: a standard field or a custom field that is not sent is cleared. The values of the group's custom fields are sent as additional properties next to the standa
 - [DELETE /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contacts/{contactId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/deletegroupcontact.md): Deletes a contact from the group.
 - [GET /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/getgroupcontactcustomfield.md): Returns the custom field identified by fieldId.
 - [PUT /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/updategroupcontactcustomfield.md): Replaces the name of the custom field identified by fieldId.
 - [DELETE /api/v1/organizations/{organizationId}/user-groups/{userGroupId}/contact-custom-fields/{fieldId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/user-group/deletegroupcontactcustomfield.md): Deletes the custom field identified by fieldId.
## Webhook

 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/listenvelopewebhooks.md): Returns the webhooks of the specified envelope.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/createenvelopewebhook.md): Creates a new webhook for the specified envelope.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/getenvelopewebhook.md): Returns a specific envelope webhook.
 - [PUT /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/updateenvelopewebhook.md): Replaces a specific envelope webhook.
 - [DELETE /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhooks/{webhookId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/deleteenvelopewebhook.md): Deletes a specific envelope webhook.
 - [GET /api/v1/organizations/{organizationId}/webhooks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/listorganizationwebhooks.md): Returns the webhooks of the specified organization.
 - [POST /api/v1/organizations/{organizationId}/webhooks](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/createorganizationwebhook.md): Creates a new webhook for the specified organization. Only the EnvelopeCompleted event is supported.
 - [GET /api/v1/organizations/{organizationId}/webhooks/{webhookId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/getorganizationwebhook.md): Returns a specific organization webhook.
 - [PUT /api/v1/organizations/{organizationId}/webhooks/{webhookId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/updateorganizationwebhook.md): Replaces a specific organization webhook. Only the EnvelopeCompleted event is supported.
 - [DELETE /api/v1/organizations/{organizationId}/webhooks/{webhookId}](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/deleteorganizationwebhook.md): Deletes a specific organization webhook.
 - [GET /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/getwebhooksubscription.md): DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Returns the webhook subscription for the specified envelope.
 - [POST /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/createwebhooksubscription.md): DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Creates a webhook subscription for the specified envelope.
 - [DELETE /api/v1/organizations/{organizationId}/envelopes/{envelopeId}/webhook-subscription](https://docs.namirial.app/products/namirialsignenterprise/openapi3/webhook/deletewebhooksubscription.md): DEPRECATED: this endpoint will be removed on 31 October 2026. Use the envelope webhooks endpoints ({envelopeId}/webhooks) instead. Deletes the webhook subscription for the specified envelope.
