> For the complete documentation index, see [llms.txt](https://developers.docstudio.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.docstudio.com/api-documentation/api-methods/platform-endpoints.md).

# Platform Endpoints

{% hint style="info" %}
Read [Swagger UI](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/swagger-ui) to inspect endpoints and test requests.
{% endhint %}

{% hint style="warning" %}
This page does not include every available endpoint. If you need a complete API reference or more endpoint details, use [Swagger UI](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/swagger-ui).
{% endhint %}

### Authorization endpoints

| Method | URL         | Description                                                                                                                        |
| ------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| POST   | `api/login` | [Authorization](https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/authorization) |

### Template endpoints

<table><thead><tr><th width="222">Method</th><th>URL</th><th>Description</th></tr></thead><tbody><tr><td>POST</td><td><code>/api/v1/template</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/create-template">Create template</a></td></tr></tbody></table>

### Envelope endpoints

<table><thead><tr><th width="98.79995727539062">Method</th><th width="304">URL</th><th>Description</th></tr></thead><tbody><tr><td>PUT</td><td><code>/api/v1/envelope/send</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope/fill-envelope">Fill envelope</a></td></tr><tr><td>POST</td><td><code>/api/v1/envelope/send</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/envelope/send-envelope">Send envelope</a></td></tr><tr><td>POST</td><td><code>/api/v1/envelope/attachment</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/upload-attachment-external-documents-method">Upload attachment or external documents</a></td></tr><tr><td>GET</td><td><code>/api/v1/envelope/{envelopeUuid}/for-sign</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/get-document-s-for-sign">Get document(s) for sign</a></td></tr><tr><td>GET</td><td><code>/api/v1/envelope/{envelopeUuid}/zip</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/download-envelope-documents-archive">Download documents</a></td></tr><tr><td>POST</td><td><code>/api/v1/envelope/{envelopeUuid}/for-print</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/swagger-ui">Get document for print. Document should be completed.</a></td></tr></tbody></table>

### Audit trail endpoints

<table><thead><tr><th width="98.79998779296875">Method</th><th>URL</th><th>Description</th></tr></thead><tbody><tr><td>PUT</td><td><code>/api/v1/audittrail/envelope/{uuid}</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/audit-trail-record/create-audit-trail-record">Create audit trail record</a></td></tr><tr><td>GET</td><td><code>/api/v1/audittrail/envelope/{uuid}</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/audit-trail-record/get-envelope-audit-trail">Get envelope audit trail</a></td></tr><tr><td>GET</td><td><code>/api/v1/audittrail/pdf/{uuid}</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/audit-trail-record/export-envelope-audit-trail-pdf-file">Export envelope audit trail PDF file</a></td></tr></tbody></table>

### Mailbox endpoints

<table><thead><tr><th width="98.60003662109375">Method</th><th>URL</th><th>Description</th></tr></thead><tbody><tr><td>GET</td><td><code>/api/v1/mailbox/search</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/search-mailbox">Search mailbox</a></td></tr><tr><td>GET</td><td><code>/api/v1/mailbox/{uuid}</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/check-envelope-status">Check envelope status</a></td></tr></tbody></table>

### Account endpoints

<table><thead><tr><th width="100">Method</th><th width="424">URL</th><th>Description</th></tr></thead><tbody><tr><td>POST</td><td><code>/api/v1/account/{accountUuid}/domain</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/add-account-domain">Add new account domain</a></td></tr><tr><td>PATCH</td><td><code>/api/v1/account/{accountUuid}/domain/{domainUuid}/verify</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/verify-account-domain">Verify domain</a></td></tr><tr><td>PATCH</td><td><code>/api/v1/account/{accountUuid}/domain/{domainUuid}/confirm</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/confirm-account-domain-verification">Confirm domain verification</a></td></tr><tr><td>PATCH</td><td><code>/api/v1/account/{accountUuid}/domain/{domainUuid}/activate</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/activate-deactivate-account-domain">Activate domain</a></td></tr><tr><td>PATCH</td><td><code>/api/v1/account/{accountUuid}/domain/{domainUuid}/deactivate</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/activate-deactivate-account-domain">Deactivate domain</a></td></tr><tr><td>PATCH</td><td><code>/api/v1/account/{accountUuid}/domain/{domainUuid}/check</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/check-account-domain">Check domain</a></td></tr><tr><td>DELETE</td><td><code>/api/v1/account/{accountUuid}/domain/{domainUuid}</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/delete-account-domain">Delete domain</a></td></tr><tr><td>GET</td><td><code>/api/v1/account/{accountUuid}/domain</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-domains/search-account-domains">Search domains</a></td></tr><tr><td>GET</td><td><code>/api/v1/account/{accountUuid}/users/example</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-corporate-users/download-example-file">Get example file</a></td></tr><tr><td>POST</td><td><code>/api/v1/account/{accountUuid}/users</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/api-methods/account-corporate-users/mass-create-users">Mass create users</a></td></tr></tbody></table>

### User/Profile endpoints

<table><thead><tr><th width="99.4000244140625">Method</th><th>URL</th><th>Description</th></tr></thead><tbody><tr><td>POST</td><td><code>/api/v1/account/{accountUuid}/user</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/swagger-ui">Create new corporate user in domain which has to be verified and activated.</a></td></tr><tr><td>DELETE</td><td><code>/api/v1/account/{accountUuid}/user</code></td><td><a href="https://support.docstudio.com/docstudio-docs/docstudio-for-developers/api-documentation/swagger-ui">Account admin can delete many corporate users at once. In case of exception, no user will be deleted.</a></td></tr></tbody></table>