# API Documentation - [Envelope](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope.md) - [Envelope Structure](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope/envelope-structure.md): This document contains an envelope data block, about all fields that you can add to document body. - [Envelope Forms](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope/envelope-forms.md): This document contains an overview of envelope forms, including what they are used for and what you can configure via the API. - [Send Envelope](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope/send-envelope.md): This document contains details for the /api/v1/envelope/send endpoint, including the request body format, example payloads, and the response UUID. - [Envelope MetaData](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope/envelope-metadata.md): This document contains an overview of envelope metadata, including how to add, update, and delete metadata for envelopes and envelope forms. - [Fill Envelope](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope/fill-envelope.md): This document contains details for filling an envelope via the API, including the request method, payload format, and example body. - [Widgets](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/widgets.md) - [Simple File Send Widget](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/widgets/simple-file-send-widget.md): This document contains instructions for using and embedding the Simple File Send Widget, including the file submission flow, integration steps, and size limits. - [API Methods](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods.md) - [Platform Endpoints](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/platform-endpoints.md): This document contains a categorized list of platform API endpoints, including the base URL and common authorization, template, envelope, and account routes. - [Authorization](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/authorization.md): This document contains details for the /api/login authorization endpoint, including the request format, response example, and status codes. - [Create Template](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/create-template.md): This document contains the /api/v1/template endpoint details, including required headers, a request body example, and a response example. - [Upload Attachment/External Documents Method](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/upload-attachment-external-documents-method.md): This document contains details for the /api/v1/envelope/attachment endpoint, including how to upload a binary file and the response fields. - [Get Document(s) For Sign](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/get-document-s-for-sign.md): This document contains details for the /api/v1/envelope/{envelopeUuid}/for-sign endpoint, including request parameters and the response format for documents available for signing. - [Download Envelope Documents Archive](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/download-envelope-documents-archive.md): This document contains details for the /api/v1/envelope/{envelopeUuid}/zip endpoint, including query parameters and how ZIP contents vary by document state. - [Audit Trail Record](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/audit-trail-record.md) - [Create Audit Trail Record](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/audit-trail-record/create-audit-trail-record.md): This document contains details for the PUT /api/v1/audittrail/envelope/{uuid} endpoint, including the request method and response status codes. - [Get Envelope Audit Trail](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/audit-trail-record/get-envelope-audit-trail.md): This document contains details for the GET /api/v1/audittrail/envelope/{uuid} endpoint, including the request method and response status codes. - [Export Envelope Audit Trail PDF File](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/audit-trail-record/export-envelope-audit-trail-pdf-file.md): This document contains details for the GET /api/v1/audittrail/pdf/{uuid} endpoint, including the request method and response status codes. - [Search mailbox](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/search-mailbox.md): This document contains details for the /api/v1/mailbox/search endpoint, including required headers and the q query parameter. - [Check Envelope Status](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/check-envelope-status.md): This document contains details for the /api/v1/mailbox/{uuid} endpoint, including filter parameters, request examples, response examples, and status codes. - [Account Corporate Users](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-corporate-users.md): This document contains the corporate users API endpoints for an account, including downloading an example XLSX file and mass creating users. - [Account Domains](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains.md) - [Add Account Domain](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/add-account-domain.md): This document contains details for adding a domain to an account via the /api/v1/account/{accountUuid}/domain endpoint, including requirements and request/response examples. - [Verify Account Domain](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/verify-account-domain.md): This document contains details for the /api/v1/account/{accountUuid}/domain/{domainUuid}/verify endpoint, including the request body and response example for domain verification. - [Confirm Account Domain Verification](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/confirm-account-domain-verification.md): This document contains details for the /api/v1/account/{accountUuid}/domain/{domainUuid}/confirm endpoint, including how to confirm domain verification and the response example. - [Activate/Deactivate Account Domain](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/activate-deactivate-account-domain.md): This document contains details for activating and deactivating an account domain via the /activate and /deactivate endpoints, including response examples and domain statuses. - [Check Account Domain](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/check-account-domain.md): This document contains details for the /api/v1/account/{accountUuid}/domain/{domainUuid}/check endpoint, including check limits and a response example. - [Delete Account Domain](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/delete-account-domain.md): This document contains details for deleting an account domain via the DELETE /api/v1/account/{accountUuid}/domain/{domainUuid} endpoint. - [Search Account Domains](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/search-account-domains.md): This document contains details for the GET /api/v1/account/{accountUuid}/domain endpoint, including pagination, search filters, and a response example. - [Download Example File](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/download-example-file.md): This document contains details for the GET /api/v1/account/{accountUuid}/users/example endpoint, including the request URL, headers, and returned XLSX example file. - [Mass create users](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/mass-create-users.md): This document contains details for the POST /api/v1/account/{accountUuid}/users endpoint, including the required headers, XLSX upload format, and target account parameter. - [Domain Statuses & Verify Methods](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/domain-statuses-and-verify-methods.md): This document contains an overview of domain statuses and supported verification methods for account domains. - [Template API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api.md): This document contains links to the Template API reference pages, including template structure, static elements, dynamic fields, and PDF fields. - [Template Structure API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-structure-api.md): This document contains the template object structure, including the template information block and the XML stored in the data field. - [Template Static Elements API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-static-elements-api.md): This document contains details on static template elements, focusing on image tags, required hash attributes, and the image upload/download API endpoints. - [Template Dynamic Fields API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api.md) - [Text Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/text-field-api.md): This document contains the Text field API format and a list of supported attributes. - [Number Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/number-field-api.md): This document contains the Number field API format and a list of supported attributes. - [Currency Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/currency-field-api.md): This document contains the Currency field API format and a list of supported attributes. - [Date Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/date-field-api.md): This document contains the Date field API format and a list of supported attributes. - [Dropdown Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/dropdown-field-api.md): This document contains the Dropdown field API format, attributes, and option value rules. - [Choice Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/choice-field-api.md): This document contains the Choice (radio button) field API format and a list of supported attributes. - [Checkbox Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/checkbox-field-api.md): This document contains the Checkbox field API format and a list of supported attributes. - [File Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/file-field-api.md): This document contains the File field API format, supported attributes, and attachment type rules. - [Dictionary Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/dictionary-field-api.md): This document contains the Dictionary field API format, attributes, and filterQuery examples. - [Lookup Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/lookup-field-api.md): This document contains the Lookup field API format and a list of supported attributes. - [Dynamic Table API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/dynamic-table-api.md): This document contains the Dynamic table field API format, attributes, and an example. - [Duplicate Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/duplicate-field-api.md): This document contains the Duplicate field API format and a list of supported attributes. - [Formula Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/formula-field-api.md): This document contains the Formula field API format, supported attributes, operations, and examples. - [Autonumber Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/autonumber-field-api.md): This document contains the Autonumber field API format and a list of supported attributes. - [Signature Field API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/template-dynamic-fields-api/signature-field-api.md): This document contains the Signature field API format and a list of supported attributes. - [PDF Fields in Template](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/template-api/pdf-fields-in-template.md): This document contains details on using dynamic fields with uploaded PDF templates, including required PDF field attributes. - [Common API Error Codes](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/common-api-error-codes.md): This document contains common API error codes and what each code typically means in DocStudio. - [Dictionaries API](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/dictionaries-api.md) - [How to Import Dictionary CSV](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/dictionaries-api/how-to-import-dictionary-csv.md): This document explains how to import a dictionary CSV file, including the upload step and the import confirmation request. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.