# Nitro APIs

## Docs

- [Get Access Token](https://developers.gonitro.com/docs/api-reference/authentication/get-access-token.md): The Get Access Token endpoint exchanges client credentials for an access token using the OAuth 2.0 client credentials flow.
- [Changelog](https://developers.gonitro.com/docs/api-reference/changelog.md): Product updates and announcements
- [Image to PDF](https://developers.gonitro.com/docs/api-reference/platform/conversions/imgtopdf.md): Image file to PDF
- [Miscelaneous to PDF](https://developers.gonitro.com/docs/api-reference/platform/conversions/misctopdf.md): Convert Miscelaneous formats to PDF
- [MS Office to PDF](https://developers.gonitro.com/docs/api-reference/platform/conversions/mstopdf.md): Convert PDF to MS Office file
- [PDF to Image](https://developers.gonitro.com/docs/api-reference/platform/conversions/pdftoimg.md): Convert PDF file to Image
- [PDF to MS Office](https://developers.gonitro.com/docs/api-reference/platform/conversions/pdftoms.md): Convert MS Office files to PDF
- [Forms](https://developers.gonitro.com/docs/api-reference/platform/extractions/forms.md): Extract Form Fields from PDF document
- [PII Bounding Boxes](https://developers.gonitro.com/docs/api-reference/platform/extractions/pii.md): Extract PII from PDF document
- [Properties](https://developers.gonitro.com/docs/api-reference/platform/extractions/properties.md): Get Properties from PDF document
- [Tables](https://developers.gonitro.com/docs/api-reference/platform/extractions/tables.md): Extract Tables from PDF document
- [Text](https://developers.gonitro.com/docs/api-reference/platform/extractions/text.md): Extract Text from PDF document
- [Text Bounding Boxes](https://developers.gonitro.com/docs/api-reference/platform/extractions/text-box.md): Extract PII from PDF document
- [Job Results](https://developers.gonitro.com/docs/api-reference/platform/jobs/result.md): Get result of asynchronous Job.
- [Job Status](https://developers.gonitro.com/docs/api-reference/platform/jobs/status.md): Get status of asynchronous Job.
- [Compress](https://developers.gonitro.com/docs/api-reference/platform/transformations/compress.md): Compress PDF document
- [Delete Pages](https://developers.gonitro.com/docs/api-reference/platform/transformations/delete.md)
- [Flatten](https://developers.gonitro.com/docs/api-reference/platform/transformations/flatten.md): Flatten PDF document
- [Merge](https://developers.gonitro.com/docs/api-reference/platform/transformations/merge.md): Merge PDF documents
- [Set Properties](https://developers.gonitro.com/docs/api-reference/platform/transformations/properties.md): Set PDF Properties
- [Protect](https://developers.gonitro.com/docs/api-reference/platform/transformations/protect.md): Password Protect PDF documents
- [Redact](https://developers.gonitro.com/docs/api-reference/platform/transformations/redact.md): Redact PDF pages
- [Rotate](https://developers.gonitro.com/docs/api-reference/platform/transformations/rotate.md): Rotate PDF documents
- [Split](https://developers.gonitro.com/docs/api-reference/platform/transformations/split.md): Split PDF document
- [Unprotect](https://developers.gonitro.com/docs/api-reference/platform/transformations/unprotect.md): Unprotect PDF documents
- [Cancel Envelope by ID](https://developers.gonitro.com/docs/api-reference/sign/cancel-envelope-by-id.md): The **Cancel Envelope by ID** endpoint cancels the signing request for the envelope specified by its UUIDv4 identifier. This endpoint allows you to cancel an envelope and changes its status to Cancelled but keeps it available for reference and reuse after updates. In Cancelled status, no further sig…
- [Convert File to PDF](https://developers.gonitro.com/docs/api-reference/sign/convert-file-to-pdf.md): *This endpoint was deprecated* on March 24, 2026, and will be sunset on July 1, 2026. Please migrate your existing functionality to the current endpoint: https://developers.gonitro.com/docs/api-reference/sign/create-document-by-envelope-id , which already supports multiple file types.
- [Create Document by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/create-document-by-envelope-id.md): In Nitro, a *Document* is a file that participants in an eSignature Envelope will read and sign. This could be an employment contract, NDA, legal agreement, banking form, or any other file required in your signature workflow.
- [Create Envelope](https://developers.gonitro.com/docs/api-reference/sign/create-envelope.md): The **Create Envelope** endpoint creates a new **sign envelope** in Nitro.
- [Create Field(s) by Document ID](https://developers.gonitro.com/docs/api-reference/sign/create-fields-by-document-id.md): The **Create Field(s) by Document ID** endpoint creates one or more fields on a document and assigns it to a participant. Accepts either a single field object or a bulk request with an 'items' array containing multiple field objects.
- [Create Participant(s) by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/create-participants-by-envelope-id.md): The **Create Participant(s) by Envelope ID** endpoint adds one or more participants to a specified envelope. Accepts either a single participant object or a bulk request with an 'items' array. Participants are associated to the parent Envelope and can sign multiple fields in different documents.
- [Delete Document by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-document-by-id.md): The **Delete Document by ID** endpoint deletes permanently removes a document from an envelope.
- [Delete Envelope by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-envelope-by-id.md): The **Delete Envelope by ID** endpoint permanently deletes the envelope.
- [Delete Field by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-field-by-id.md): The **Delete Field by ID** endpoint permanently deletes a field from a document within an envelope.
- [Delete Fields by Field IDs](https://developers.gonitro.com/docs/api-reference/sign/delete-fields-by-field-ids.md): The **Delete Fields** endpoint permanently deletes multiple fields from a document within an envelope.
- [Delete Participant by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-participant-by-id.md): The **Delete Participant by ID** endpoint permanently deletes a participant from an envelope.
- [Delete Participants by Participant IDs](https://developers.gonitro.com/docs/api-reference/sign/delete-participants-by-participant-ids.md): The **Delete Participants** endpoint permanently deletes multiple participants from an envelope.
- [Download Audit Trail of Envelope](https://developers.gonitro.com/docs/api-reference/sign/download-audit-trail-of-envelope.md): Downloads the PDF file containing the full audit trail for the selected envelope.
- [Download Original Envelope](https://developers.gonitro.com/docs/api-reference/sign/download-original-envelope.md): The **Download Original Envelope** downloads an envelope's original (unsigned) documents in a ZIP archive.
- [Download Sealed Document by ID](https://developers.gonitro.com/docs/api-reference/sign/download-sealed-document-by-id.md): The **Download Sealed Document by ID** downloads a single sealed (signed) document as a PDF from a sealed envelope.
- [Download Sealed Envelope](https://developers.gonitro.com/docs/api-reference/sign/download-sealed-envelope.md): The **Download Sealed Envelope** downloads a sealed (signed) envelope's documents along with audit trail in a ZIP archive.
- [Get Conversion Job Status](https://developers.gonitro.com/docs/api-reference/sign/get-conversion-job-status.md): *This endpoint was deprecated* on March 24, 2026, and will be sunset on July 1, 2026. Please migrate your existing functionality to the current endpoint: https://developers.gonitro.com/docs/api-reference/sign/create-document-by-envelope-id , which already supports multiple file types.
- [Get Converted File by Job ID](https://developers.gonitro.com/docs/api-reference/sign/get-converted-file-by-job-id.md): *This endpoint was deprecated* on March 24, 2026, and will be sunset on July 1, 2026. Please migrate your existing functionality to the current endpoint: https://developers.gonitro.com/docs/api-reference/sign/create-document-by-envelope-id , which already supports multiple file types.
- [Get Document by ID](https://developers.gonitro.com/docs/api-reference/sign/get-document-by-id.md): The **Get Document by ID** endpoint retrieves the details of a single document using its identifier within a specific envelope.
- [Get Envelope by ID](https://developers.gonitro.com/docs/api-reference/sign/get-envelope-by-id.md): The **Get Envelope by ID** endpoint retrieves the details of a single envelope using its UUIDv4 identifier.
- [List Documents by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/list-documents-by-envelope-id.md): The **List Documents by Envelope ID** endpoint retrieves all documents associated with a specific envelope. Documents are returned in an `items` array within the JSON response. The request must include the envelope ID to ensure the complete set of documents is retrieved for the correct envelope.
- [List Envelopes](https://developers.gonitro.com/docs/api-reference/sign/list-envelopes.md): The **List Envelopes** endpoint returns all envelopes associated with an application in an account.
- [List Fields by Document ID](https://developers.gonitro.com/docs/api-reference/sign/list-fields-by-document-id.md): The **List Fields by Document ID** endpoint retrieves all fields associated with a specific document within an envelope. The request must include the envelope and document ID to ensure the complete set of fields is retrieved for the correct document.
- [List Participants by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/list-participants-by-envelope-id.md): The **List Participant by Envelope ID** endpoint returns all participants associated with a specific envelope. The request must include the envelope ID to ensure the complete set of participants is retrieved for the correct envelope.
- [Reorder Documents by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/reorder-documents-by-envelope-id.md): The **Reorder Documents by Envelope ID** endpoint reorders all documents associated with a specific envelope based on the order specified in the request body. Documents are returned in an `items` array within the JSON response reflecting the new order.
- [Send Envelope for Signing](https://developers.gonitro.com/docs/api-reference/sign/send-envelope-for-signing.md): The **Send Envelope for Signing** endpoint sends an envelope to participants for signature collection.
- [Send Reminders for Envelope](https://developers.gonitro.com/docs/api-reference/sign/send-reminders-for-envelope.md): The **Send Reminders for Envelope** endpoint triggers reminder notifications to pending participants of a specified envelope using its UUIDv4 identifier.
- [Update Document by ID](https://developers.gonitro.com/docs/api-reference/sign/update-document-by-id.md): The **Update Document by ID** endpoint allows you to update an existing document's metadata within an envelope. This endpoint performs a partial update on the document, changing only the provided fields while preserving all other properties. Currently, only the document name can be updated.
- [Update Envelope](https://developers.gonitro.com/docs/api-reference/sign/update-envelope.md): The **Update Envelope** endpoint modifies an envelope’s name, notification settings, or signing mode. All parameters are optional, so you can update any combination of these fields without affecting the others.
- [Update Field by ID](https://developers.gonitro.com/docs/api-reference/sign/update-field-by-id.md): The **Update Field by ID** endpoint modifies the properties of an existing field. The Field type cannot be updated. All parameters are optional.
- [Update Participant by ID](https://developers.gonitro.com/docs/api-reference/sign/update-participant-by-id.md): The **Update Participant by ID** endpoint modifies a participant's authentication settings. The participant's email cannot be updated. All parameters are optional.
- [Rotate Credentials Immediately](https://developers.gonitro.com/docs/authentication/credential-rotation.md)
- [Get API Credentials](https://developers.gonitro.com/docs/authentication/credentials.md)
- [Generate Access Tokens](https://developers.gonitro.com/docs/authentication/token-renew.md): How to create and renew access tokens
- [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box.md): Understanding and calculating the position of a field within a document.
- [Create Envelope Tutorial](https://developers.gonitro.com/docs/build-nitro/create-envelope.md)
- [API Error Codes](https://developers.gonitro.com/docs/build-nitro/errors.md): Common Nitro API error responses and what they mean
- [Good Development Practices](https://developers.gonitro.com/docs/build-nitro/good-practices.md): Guidelines to follow when integrating with the Nitro APIs
- [Postman Collection](https://developers.gonitro.com/docs/build-nitro/postman-collection.md)
- [Webhooks Guide](https://developers.gonitro.com/docs/build-nitro/webhook.md)
- [Access the Nitro APIs](https://developers.gonitro.com/docs/getting-started/basic-setup.md)
- [Make your first 'Get Envelopes' API call](https://developers.gonitro.com/docs/getting-started/first-api-call.md)

## OpenAPI Specs

- [openapi](https://api.gonitro.dev/openapi.json)
- [tables](https://developers.gonitro.com/docs/api-reference/platform/output/tables.json)
- [unprotect](https://developers.gonitro.com/docs/api-reference/platform/output/unprotect.json)
- [text](https://developers.gonitro.com/docs/api-reference/platform/output/text.json)
- [text-box](https://developers.gonitro.com/docs/api-reference/platform/output/text-box.json)
- [split](https://developers.gonitro.com/docs/api-reference/platform/output/split.json)
- [set-properties](https://developers.gonitro.com/docs/api-reference/platform/output/set-properties.json)
- [rotate](https://developers.gonitro.com/docs/api-reference/platform/output/rotate.json)
- [redact](https://developers.gonitro.com/docs/api-reference/platform/output/redact.json)
- [protect](https://developers.gonitro.com/docs/api-reference/platform/output/protect.json)
- [pii](https://developers.gonitro.com/docs/api-reference/platform/output/pii.json)
- [pdftoms](https://developers.gonitro.com/docs/api-reference/platform/output/pdftoms.json)
- [pdftoimg](https://developers.gonitro.com/docs/api-reference/platform/output/pdftoimg.json)
- [mstopdf](https://developers.gonitro.com/docs/api-reference/platform/output/mstopdf.json)
- [misctopdf](https://developers.gonitro.com/docs/api-reference/platform/output/misctopdf.json)
- [merge](https://developers.gonitro.com/docs/api-reference/platform/output/merge.json)
- [job](https://developers.gonitro.com/docs/api-reference/platform/output/job.json)
- [imgtopdf](https://developers.gonitro.com/docs/api-reference/platform/output/imgtopdf.json)
- [get-properties](https://developers.gonitro.com/docs/api-reference/platform/output/get-properties.json)
- [forms](https://developers.gonitro.com/docs/api-reference/platform/output/forms.json)
- [flatten](https://developers.gonitro.com/docs/api-reference/platform/output/flatten.json)
- [delete](https://developers.gonitro.com/docs/api-reference/platform/output/delete.json)
- [compress](https://developers.gonitro.com/docs/api-reference/platform/output/compress.json)