Introduction
Welcome to the Docue API.
Please note that you will need a company workspace in our systems in order to use the API.
Currently there is no separate testing environment. Test workspace credentials will be provided to you which can be used for pre-production testing.
Please note that this API documentation is still work-in-progress and may have errors and omissions. Please report any issues and feedback to support@docue.com.
Including relationships
The include query parameter will load any relation or relation count on the models. Each model has a set of supported includes that can be used with most routes.
If relation data is missing a response, just try adding the corresponding include.
For example: https://api.docue.com/public/v2/documents?include=folder
Pagination
List routes support pagination of the results with query parameters page and per_page.
For example: https://api.docue.com/public/v2/documents?per_page=10&page=2
Datetime formats
The following datetime formats are supported:
Y-m-d
Y-m-dTH:i:sP (ISO8601)
Y-m-dTH:i:sP (ATOM)
Authenticating requests
To authenticate requests, include an Authorization header with the value "Bearer {YOUR_API_TOKEN}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
To obtain API credentials contact support@docue.com.
Document
API methods for managing documents and their basic properties.
Download the file associated with the document
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/1/download" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/1/download"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/1/download';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/1/download'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Upload the file associated with the document
requires authentication
This will replace any existing file.
Example request:
curl --request POST \
"https://api.docue.com/public/v2/documents/J4rY7E/file" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "file=@/tmp/phpbaIlee" const url = new URL(
"https://api.docue.com/public/v2/documents/J4rY7E/file"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('file', document.querySelector('input[name="file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/J4rY7E/file';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'file',
'contents' => fopen('/tmp/phpbaIlee', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/J4rY7E/file'
files = {
'file': open('/tmp/phpbaIlee', 'rb')}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'multipart/form-data',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, files=files)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"download_url": "Aut dolore consequatur totam facilis in minus nemo.",
"id": "nvr1NQ",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Blanditiis vel quia consequatur.",
"description": "Ipsum excepturi voluptatem et quidem dignissimos soluta.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "Ob0jKx",
"contract": {
"_type": "contract",
"id": "4aLQNO",
"name": "Perspiciatis quos maxime minima sint ad blanditiis.",
"stage": "Iste velit corrupti exercitationem cupiditate et.",
"document_id": "4aLbyD",
"sign_method": "strong",
"template_id": "Doloremque recusandae et eum.",
"template": {
"id": "vOx1qD",
"name": "Qui corrupti consequatur alias.",
"description": "Illo dicta iure est dicta nihil et.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "jZNo8a",
"display_name": "Qui quo ducimus optio qui et recusandae.",
"first_name": "Voluptatem sint dicta enim.",
"last_name": "Adipisci quia accusamus tempora animi quam nesciunt.",
"email": "rippin.kallie@gmail.com",
"language": "fi"
},
"signing_settings": {
"id": "ajgQYX",
"created_at": "2007-02-18T15:57:12+00:00",
"updated_at": "2009-04-22T18:57:44+00:00",
"contract_id": "PM5RoW",
"message": "Maxime enim iusto asperiores doloremque omnis quod quia.",
"expires_at": "1975-10-06T11:55:31+00:00",
"reminders_start": "2013-11-04T15:58:13+00:00",
"reminders_end": "2019-01-21T14:40:49+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "p9Ngqzn",
"folder": {
"_type": "folder",
"id": "01GoEdz",
"name": "Et sint debitis sint eos dolores.",
"created_at": "1981-02-05T11:07:14+00:00",
"updated_at": "2022-11-30T06:07:56+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "ajYxBZ",
"name": "Et nihil quaerat rem labore facilis.",
"created_at": "2011-04-21T15:35:09+00:00",
"updated_at": "1970-04-04T11:05:34+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "pM14E0",
"owner": {
"id": "LDQ3aq",
"display_name": "Magni quo sint rerum quas voluptatem.",
"first_name": "Tempore eius alias quia earum repudiandae quo sint.",
"last_name": "Animi dolore voluptas doloribus.",
"email": "dominic87@gmail.com",
"language": "de"
},
"workspace_id": "GDmo7a",
"workspace": {
"_type": "workspace",
"id": "OxJv9Z",
"name": "Velit laboriosam alias quia est.",
"company_ident": "Dignissimos doloribus provident distinctio velit libero nemo.",
"email": "zschowalter@gmail.com",
"root_folder_id": "WaBdeD"
},
"file_id": "1DM7aR",
"file": {
"_type": "file",
"id": "LDQd6O",
"filename": "Facilis consectetur nesciunt necessitatibus facere voluptas.",
"size": 6.2505,
"mime": "Nemo aut occaecati ipsam.",
"download_url": "http://okeefe.net/quis-veritatis-quis-eum-tempore-vero.html",
"preview_url": "https://murazik.com/est-cum-voluptatem-hic-voluptas-ut-asperiores-nihil-sit.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "jZNWao",
"property_id": "7rkMV4",
"property": {
"id": "LQgV0Q",
"title": "Consequatur ut autem animi nihil quasi qui.",
"description": "Dolores totam nisi sed dolor ad eum.",
"name": "Nostrum eos eveniet aut est eius maiores.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "DQ57pL",
"workspace": {
"_type": "workspace",
"id": "GZgnWD",
"name": "Distinctio quas repudiandae animi voluptatum aliquid.",
"company_ident": "Ab est nulla porro eveniet hic deleniti.",
"email": "kuphal.arlo@gmail.com",
"root_folder_id": "GG7leg"
}
}
}
],
"date_values": [
{
"id": "OvvjAO",
"value": "2014-08-01T20:14:12+00:00",
"duration": "P1D",
"basis": "Aut explicabo consequatur blanditiis nemo enim occaecati.",
"property_id": "wldw2w",
"property": {
"id": "PwEJjmW",
"title": "Maiores sint numquam consequuntur aperiam.",
"description": "Alias eos aut praesentium et vitae doloremque.",
"name": "Maiores facere fuga optio optio.",
"source": "system",
"data_type": "date",
"workspace_id": "MAXLebn",
"workspace": {
"_type": "workspace",
"id": "J2AXNxn",
"name": "Cumque ad labore consequuntur excepturi quia ad quis.",
"company_ident": "Et voluptatem sunt id nam.",
"email": "myrtle.gulgowski@gmail.com",
"root_folder_id": "O4MJAD"
}
}
}
],
"numeric_values": [
{
"id": "NDkdZo",
"value": 1.3,
"unit": "Architecto fugiat ullam nemo fuga sint architecto non.",
"property_id": "8OvVvO",
"property": {
"id": "rEnoQQV",
"title": "Maiores accusamus quae cum distinctio id doloribus.",
"description": "Eum provident et quo quo impedit et et.",
"name": "Vero quos iusto quis sit eaque unde esse porro.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "NDkdZo",
"workspace": {
"_type": "workspace",
"id": "LDQB3Z",
"name": "Enim dicta molestiae eius voluptas eveniet.",
"company_ident": "Dolorum modi ut non culpa quam voluptas enim.",
"email": "babbott@yahoo.com",
"root_folder_id": "OvNv7o"
}
}
}
],
"string_values": [
{
"id": "DkVbKO",
"value": "Quia est vel eligendi est doloremque totam.",
"property_id": "ZN71Wa",
"property": {
"id": "gD6jDw",
"title": "Dolores enim quia aut consequatur est vitae tempore.",
"description": "Distinctio sequi quae excepturi illo saepe ipsum.",
"name": "Eos ut earum eius qui.",
"source": "system",
"data_type": "numeric",
"workspace_id": "NDkdZo",
"workspace": {
"_type": "workspace",
"id": "jJW6kd",
"name": "Blanditiis aperiam odit ipsum quae ut.",
"company_ident": "Laudantium magnam quaerat molestiae laboriosam explicabo.",
"email": "pkoss@batz.org",
"root_folder_id": "EDYbVZ"
}
}
}
],
"jurisdictions": [
{
"id": "yNLmVA",
"code": "Et explicabo minus necessitatibus culpa voluptatem."
}
],
"document_types": [
{
"_type": "document_type",
"id": "wOywZL",
"name": "Recusandae a assumenda repudiandae voluptatem aut."
}
],
"parties": [
{
"id": "REbqzn",
"first_name": "Eaque iusto aperiam odit ipsum.",
"last_name": "Et placeat consequatur aut rem minus cupiditate perferendis.",
"email": "mann.manuel@yahoo.com",
"phone": "Adipisci eligendi perspiciatis qui in.",
"title": "Cum vitae quia enim ut est veritatis sed.",
"company_name": "Ipsam exercitationem rem velit molestiae mollitia debitis.",
"company_ident": "Cupiditate laborum reiciendis consequatur eum.",
"address_id": "DWjXmO",
"address": {
"id": "QGMz0P",
"address_type": "Eveniet voluptatum voluptas ipsam recusandae ut ipsam harum.",
"address_lines": "Eos impedit mollitia fugiat quo nesciunt est in voluptatibus.",
"city": "Recusandae voluptatem minus nihil consectetur exercitationem veritatis.",
"locality": "Rerum perferendis reprehenderit harum sint ullam voluptates fugiat.",
"administrative_area": "Maiores sunt rerum odio.",
"post_code": "Reiciendis omnis ipsum nulla nulla rerum.",
"country": "Dolorum quo qui quas suscipit ut quia perspiciatis."
},
"external_references": [
{
"id": "748n88",
"name": "Voluptatibus omnis nobis at doloremque quia harum sit.",
"title": "Assumenda nam nesciunt tempore odio.",
"value": "Animi illo dolorem voluptatem ipsum dolor."
}
]
}
],
"reminders": [
{
"id": "7ajJva",
"event_type": "document.reminder",
"title": "Maxime non nemo recusandae nihil."
}
],
"attachments": [
{
"id": "WLG1eA",
"created_at": "1970-04-13T23:23:55+00:00",
"updated_at": "2022-12-10T22:04:36+00:00",
"file_id": "DYzggv",
"file": {
"_type": "file",
"id": "EQe8RJr",
"filename": "example.pdf",
"size": 451132346.36417,
"mime": "application/pdf",
"download_url": "https://franecki.biz/repudiandae-quos-et-molestiae-nihil-laudantium-minus-distinctio-non.html",
"preview_url": "http://www.hamill.info/voluptatem-omnis-ducimus-quam-quasi-quis-voluptatem-asperiores.html"
}
}
],
"external_references": [
{
"id": "k6kvv2L",
"name": "Molestiae dicta dignissimos cum.",
"title": "Consequatur quia aut repellendus accusantium velit et ut velit.",
"value": "Ut blanditiis voluptas repudiandae."
}
],
"tags": [
{
"tag": "Provident omnis neque est ut tempore quas eum."
}
],
"terms_and_conditions": {
"date": "2017-04-29T03:37:26+00:00",
"effective_date": "1986-12-21T07:48:39+00:00",
"term_end_date": "1971-05-14T14:26:42+00:00",
"signing_date": "2018-10-26T17:21:49+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1974-12-18T00:30:40+00:00"
},
"breadcrumb": [
{
"id": "NObxZW",
"name": "Cupiditate cumque minus omnis dolor non aut harum.",
"depth": 7610405
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List available documents
requires authentication
List documents available to the authenticated user. User must have permission to view the folder for it to be listed.
Results can be filtered by providing the filter route parameter.
Available filters are:
filter[title]=document titlefilter[folder_id]=folder_idfilter[contract.stage]=contract stagefilter[contract_id]=contract_id
Results can be sorted by providing the sort route parameters. Format is:
sort=[-]parameter
Examples:
sort=created_atsorts ascending by datesort=-created_atsorts descending by date
Available sort parameters:
- created_at
- updated_at
- archive_status
- contains_pii
- title
- contract.stage
- contract.name
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"download_url": "Accusamus iure molestiae natus qui dicta.",
"id": "Z9rlPa",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Reiciendis aut voluptatibus.",
"description": "Repellat nam delectus voluptatibus dolore ad autem.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "NOb8JZ",
"contract": {
"_type": "contract",
"id": "6Dd90Z",
"name": "Et qui ut iure fugiat libero.",
"stage": "Quia aut natus eum quidem labore porro sit est.",
"document_id": "gW5MY9W",
"sign_method": "canvas",
"template_id": "Voluptates est modi culpa ducimus.",
"template": {
"id": "DQGpdY",
"name": "Delectus est quia numquam quod nemo.",
"description": "Asperiores magnam fugit aut architecto laudantium est vel.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "OvbYPO",
"display_name": "Est omnis esse id.",
"first_name": "Non optio voluptas voluptatibus quo cum esse omnis.",
"last_name": "Eos eum velit dolorem provident iure reiciendis.",
"email": "heidenreich.scottie@hand.biz",
"language": "de"
},
"is_paid": true,
"signing_settings": {
"id": "aeo3wD",
"created_at": "1991-07-06T03:08:32+00:00",
"updated_at": "1976-01-06T10:32:27+00:00",
"contract_id": "8gGWlV",
"message": "Exercitationem praesentium delectus qui.",
"expires_at": "2021-04-10T17:58:36+00:00",
"reminders_start": "1979-01-03T16:04:39+00:00",
"reminders_end": "1972-11-01T09:29:40+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "gD6jDw",
"folder": {
"_type": "folder",
"id": "Dm4JmO",
"name": "Maiores incidunt enim tempore et.",
"created_at": "2011-01-30T03:20:07+00:00",
"updated_at": "2022-03-09T08:56:04+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "ZpLArZ",
"name": "Quasi consequatur ut voluptas aperiam fugiat illum.",
"created_at": "1976-07-15T14:44:26+00:00",
"updated_at": "2001-12-31T16:01:04+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "rlQexkA",
"owner": {
"id": "Oq0J8a",
"display_name": "Quasi accusamus autem consequuntur maiores.",
"first_name": "Repudiandae dolores similique et cumque reprehenderit qui hic.",
"last_name": "Aut reprehenderit maiores quisquam aut dolorem laboriosam.",
"email": "dominique64@zulauf.com",
"language": "en"
},
"workspace_id": "3rdp4gK",
"workspace": {
"_type": "workspace",
"id": "GDm1nD",
"name": "Ut quos repellendus cum incidunt harum atque molestiae.",
"company_ident": "Fuga minima non nihil dolor incidunt ut ut.",
"email": "kristopher.waters@yahoo.com",
"root_folder_id": "3bRb9qK"
},
"file_id": "pZG0Ra",
"file": {
"_type": "file",
"id": "ZAyd63",
"filename": "Architecto dolores sint et maiores aperiam.",
"size": 2716.4765514,
"mime": "Dolores quo delectus accusantium repudiandae aut dolor odit deserunt.",
"download_url": "http://www.bednar.net/",
"preview_url": "http://schuster.biz/ut-vero-non-delectus-placeat-illo.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "KOqB6D",
"property_id": "O7Wqz5",
"property": {
"id": "6wk9q6",
"title": "Dolores et aperiam est.",
"description": "Officiis accusamus dolorem qui tenetur eveniet quam.",
"name": "Animi quae praesentium modi.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "pZGreD",
"workspace": {
"_type": "workspace",
"id": "Obb0Nd",
"name": "Cum accusamus at aut a quas est.",
"company_ident": "Est corrupti aut deserunt reiciendis nemo accusantium.",
"email": "ondricka.kiera@wunsch.com",
"root_folder_id": "Z1r3ea"
}
}
}
],
"date_values": [
{
"id": "a0jJgr",
"value": "1990-07-08T01:27:04+00:00",
"duration": "P1D",
"basis": "Quas impedit nam quia.",
"property_id": "zGxMn7",
"property": {
"id": "eDJKRZ",
"title": "Autem libero perspiciatis et eum optio.",
"description": "Dolorem sed aut ut non.",
"name": "Nihil laudantium impedit est voluptatum.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "Oq8Mga",
"workspace": {
"_type": "workspace",
"id": "MAKJK8",
"name": "Esse soluta qui doloribus maxime dolore illo est.",
"company_ident": "Adipisci corrupti et iste eum itaque dolorum et.",
"email": "weimann.raphaelle@mills.info",
"root_folder_id": "OblR4Z"
}
}
}
],
"numeric_values": [
{
"id": "ZA4ByD",
"value": 2504217,
"unit": "Harum consequuntur qui ut et.",
"property_id": "mO7AqZ",
"property": {
"id": "ggoNx9",
"title": "Dolor nesciunt nobis iste et enim earum.",
"description": "Necessitatibus aut vitae sit.",
"name": "Excepturi fugit est rerum.",
"source": "system",
"data_type": "string",
"workspace_id": "DMyABD",
"workspace": {
"_type": "workspace",
"id": "DJ2ENo",
"name": "Vel perspiciatis ut repudiandae id ea alias facilis.",
"company_ident": "Voluptatem voluptate voluptas omnis occaecati.",
"email": "bernhard45@blick.com",
"root_folder_id": "1DM7aR"
}
}
}
],
"string_values": [
{
"id": "pZGwzZ",
"value": "Quod dicta et ut et non eos.",
"property_id": "xV84pj",
"property": {
"id": "eDJ0a1",
"title": "Saepe sapiente est esse magnam.",
"description": "Ea veritatis repudiandae quaerat molestiae ut velit iusto.",
"name": "Hic ad architecto est molestias.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "aEwQ8W",
"workspace": {
"_type": "workspace",
"id": "ZrWd8W",
"name": "Rem nostrum consequatur magnam tempore reprehenderit fugiat.",
"company_ident": "Quia occaecati harum dolorem ex debitis eum veniam aut.",
"email": "henriette.schneider@berge.com",
"root_folder_id": "kOR4LZ"
}
}
}
],
"jurisdictions": [
{
"id": "Ma2pnD",
"code": "Et et non necessitatibus nobis numquam."
}
],
"document_types": [
{
"_type": "document_type",
"id": "5aPvwD",
"name": "Et nemo animi animi."
}
],
"parties": [
{
"id": "7ajpED",
"first_name": "Ut corporis nostrum fugiat placeat officia voluptatem totam sint.",
"last_name": "Nam neque recusandae qui.",
"email": "josue69@schowalter.com",
"phone": "Beatae in nostrum qui occaecati doloremque harum quam.",
"title": "Hic dolor nostrum iusto suscipit voluptatem dolor officiis.",
"company_name": "Ea nulla natus rem et.",
"company_ident": "Neque fugit natus magnam suscipit eos quia non.",
"address_id": "ZAKwPO",
"address": {
"id": "B4ywdP",
"address_type": "Officia debitis numquam rerum corporis praesentium similique et quod.",
"address_lines": "Voluptas et et corporis voluptatem autem id alias.",
"city": "Non in neque dolor voluptas quod.",
"locality": "Ex officiis consequatur possimus.",
"administrative_area": "Qui inventore sed mollitia ullam.",
"post_code": "Earum blanditiis velit cupiditate tempore saepe.",
"country": "Rerum doloremque ut dolorum labore qui."
},
"external_references": [
{
"id": "vroMk3",
"name": "Vel corporis odit facilis maiores.",
"title": "Eos omnis nam sed assumenda.",
"value": "Voluptatem laboriosam eum vel et."
}
]
}
],
"reminders": [
{
"id": "aB3X9O",
"event_type": "document.reminder",
"title": "Id dolore ut tenetur quis nam."
}
],
"attachments": [
{
"id": "1DM7aR",
"created_at": "2012-10-03T17:36:04+00:00",
"updated_at": "1977-11-16T04:54:52+00:00",
"file_id": "LDQ3aq",
"file": {
"_type": "file",
"id": "OxbxjZ",
"filename": "example.pdf",
"size": 17.908959,
"mime": "application/pdf",
"download_url": "http://www.graham.com/rem-inventore-sit-nemo-est",
"preview_url": "http://kunde.com/"
}
}
],
"external_references": [
{
"id": "gD6KYZ",
"name": "Natus expedita dicta ullam et.",
"title": "Fugit impedit eaque et possimus a.",
"value": "Temporibus quasi cum nam ad exercitationem itaque."
}
],
"tags": [
{
"tag": "Repellendus minima mollitia aspernatur."
}
],
"terms_and_conditions": {
"date": "2010-12-18T00:27:52+00:00",
"effective_date": "1982-09-16T07:47:09+00:00",
"term_end_date": "2001-06-27T15:20:30+00:00",
"signing_date": "1999-11-08T21:28:14+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
},
"retention": {
"end_date": "1973-09-13T08:13:12+00:00"
},
"breadcrumb": [
{
"id": "OoyLGY",
"name": "Id incidunt natus voluptates quia delectus.",
"depth": 768984295
}
]
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create one or more documents
requires authentication
Example request:
curl --request POST \
"https://api.docue.com/public/v2/documents" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"folder_id\": \"aPMKK1\",
\"owner_id\": \"qoeGkx5\",
\"documents\": [
{
\"title\": \"Ipsam voluptatem consequuntur eaque fuga voluptas aspernatur quasi.\",
\"description\": \"Numquam corrupti distinctio ut sed ratione labore.\",
\"metadata\": {
\"document_types\": [],
\"jurisdictions\": [],
\"tags\": [],
\"languages\": [],
\"terms_and_conditions\": {
\"date\": \"1970-09-30T12:30:50+00:00\",
\"effective_date\": \"1981-05-24T13:29:20+00:00\",
\"term_end_date\": \"2010-02-14T21:36:31+00:00\",
\"signing_date\": \"2023-09-15T13:53:10+00:00\",
\"contract_period\": \"P1D\",
\"notice_period\": \"P1D\",
\"duration_type\": \"one-off\"
},
\"parties\": {
\"first_name\": \"Jane\",
\"last_name\": \"Doe\",
\"email\": \"wpfeffer@kling.com\",
\"phone\": \"+358401231231\",
\"title\": \"President\",
\"company_name\": \"Sunt tempora veritatis laboriosam eum dolor velit.\",
\"company_ident\": \"FI123456789\",
\"address\": {
\"address_type\": \"20341 Whitworth Institute\",
\"address_lines\": \"405\",
\"city\": \"Seattle\",
\"locality\": \"Whitworth\",
\"administrative_area\": \"WA\",
\"post_code\": \"98052\",
\"country\": \"United States of America\"
},
\"external_references\": {
\"name\": \"Odio at consequatur consequuntur voluptatem omnis.\",
\"title\": \"Delectus iure repudiandae tempora.\",
\"value\": \"Quia ipsa et quibusdam sequi quaerat sint.\"
}
},
\"properties\": {
\"property_id\": \"a0nArD\",
\"value\": \"1979-04-26T12:03:51+00:00\",
\"duration\": \"Incidunt nesciunt blanditiis dolores tenetur.\",
\"basis\": \"Et rerum veritatis et tempora et sunt.\",
\"unit\": \"Laborum rerum molestias impedit velit in inventore est.\"
},
\"external_references\": {
\"name\": \"Nemo explicabo cupiditate error maiores ipsum aut aut.\",
\"title\": \"Mollitia aliquid quis aut ut hic magni.\",
\"value\": \"Dolorum commodi fugit sunt consequatur.\"
}
},
\"archive_status\": \"completed\",
\"reminders\": {
\"event_type\": \"document.reminder\",
\"title\": \"Earum dolor expedita itaque cum quo dolores.\",
\"schedules\": {
\"next_run\": \"2002-10-13T02:27:11+00:00\",
\"id\": \"JL80MX\",
\"last_run\": \"2004-04-05T05:35:54+00:00\",
\"interval\": 35839
},
\"recipients\": {
\"value\": \"john.doe@doe.com\",
\"channel\": \"email\",
\"language\": \"de\"
}
},
\"contains_pii\": \"contains_pii\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"folder_id": "aPMKK1",
"owner_id": "qoeGkx5",
"documents": [
{
"title": "Ipsam voluptatem consequuntur eaque fuga voluptas aspernatur quasi.",
"description": "Numquam corrupti distinctio ut sed ratione labore.",
"metadata": {
"document_types": [],
"jurisdictions": [],
"tags": [],
"languages": [],
"terms_and_conditions": {
"date": "1970-09-30T12:30:50+00:00",
"effective_date": "1981-05-24T13:29:20+00:00",
"term_end_date": "2010-02-14T21:36:31+00:00",
"signing_date": "2023-09-15T13:53:10+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"parties": {
"first_name": "Jane",
"last_name": "Doe",
"email": "wpfeffer@kling.com",
"phone": "+358401231231",
"title": "President",
"company_name": "Sunt tempora veritatis laboriosam eum dolor velit.",
"company_ident": "FI123456789",
"address": {
"address_type": "20341 Whitworth Institute",
"address_lines": "405",
"city": "Seattle",
"locality": "Whitworth",
"administrative_area": "WA",
"post_code": "98052",
"country": "United States of America"
},
"external_references": {
"name": "Odio at consequatur consequuntur voluptatem omnis.",
"title": "Delectus iure repudiandae tempora.",
"value": "Quia ipsa et quibusdam sequi quaerat sint."
}
},
"properties": {
"property_id": "a0nArD",
"value": "1979-04-26T12:03:51+00:00",
"duration": "Incidunt nesciunt blanditiis dolores tenetur.",
"basis": "Et rerum veritatis et tempora et sunt.",
"unit": "Laborum rerum molestias impedit velit in inventore est."
},
"external_references": {
"name": "Nemo explicabo cupiditate error maiores ipsum aut aut.",
"title": "Mollitia aliquid quis aut ut hic magni.",
"value": "Dolorum commodi fugit sunt consequatur."
}
},
"archive_status": "completed",
"reminders": {
"event_type": "document.reminder",
"title": "Earum dolor expedita itaque cum quo dolores.",
"schedules": {
"next_run": "2002-10-13T02:27:11+00:00",
"id": "JL80MX",
"last_run": "2004-04-05T05:35:54+00:00",
"interval": 35839
},
"recipients": {
"value": "john.doe@doe.com",
"channel": "email",
"language": "de"
}
},
"contains_pii": "contains_pii"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'folder_id' => 'aPMKK1',
'owner_id' => 'qoeGkx5',
'documents' => [
[
'title' => 'Ipsam voluptatem consequuntur eaque fuga voluptas aspernatur quasi.',
'description' => 'Numquam corrupti distinctio ut sed ratione labore.',
'metadata' => [
'document_types' => [],
'jurisdictions' => [],
'tags' => [],
'languages' => [],
'terms_and_conditions' => [
'date' => '1970-09-30T12:30:50+00:00',
'effective_date' => '1981-05-24T13:29:20+00:00',
'term_end_date' => '2010-02-14T21:36:31+00:00',
'signing_date' => '2023-09-15T13:53:10+00:00',
'contract_period' => 'P1D',
'notice_period' => 'P1D',
'duration_type' => 'one-off',
],
'parties' => [
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'wpfeffer@kling.com',
'phone' => '+358401231231',
'title' => 'President',
'company_name' => 'Sunt tempora veritatis laboriosam eum dolor velit.',
'company_ident' => 'FI123456789',
'address' => [
'address_type' => '20341 Whitworth Institute',
'address_lines' => '405',
'city' => 'Seattle',
'locality' => 'Whitworth',
'administrative_area' => 'WA',
'post_code' => '98052',
'country' => 'United States of America',
],
'external_references' => [
'name' => 'Odio at consequatur consequuntur voluptatem omnis.',
'title' => 'Delectus iure repudiandae tempora.',
'value' => 'Quia ipsa et quibusdam sequi quaerat sint.',
],
],
'properties' => [
'property_id' => 'a0nArD',
'value' => '1979-04-26T12:03:51+00:00',
'duration' => 'Incidunt nesciunt blanditiis dolores tenetur.',
'basis' => 'Et rerum veritatis et tempora et sunt.',
'unit' => 'Laborum rerum molestias impedit velit in inventore est.',
],
'external_references' => [
'name' => 'Nemo explicabo cupiditate error maiores ipsum aut aut.',
'title' => 'Mollitia aliquid quis aut ut hic magni.',
'value' => 'Dolorum commodi fugit sunt consequatur.',
],
],
'archive_status' => 'completed',
'reminders' => [
'event_type' => 'document.reminder',
'title' => 'Earum dolor expedita itaque cum quo dolores.',
'schedules' => [
'next_run' => '2002-10-13T02:27:11+00:00',
'id' => 'JL80MX',
'last_run' => '2004-04-05T05:35:54+00:00',
'interval' => 35839,
],
'recipients' => [
'value' => 'john.doe@doe.com',
'channel' => 'email',
'language' => 'de',
],
],
'contains_pii' => 'contains_pii',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents'
payload = {
"folder_id": "aPMKK1",
"owner_id": "qoeGkx5",
"documents": [
{
"title": "Ipsam voluptatem consequuntur eaque fuga voluptas aspernatur quasi.",
"description": "Numquam corrupti distinctio ut sed ratione labore.",
"metadata": {
"document_types": [],
"jurisdictions": [],
"tags": [],
"languages": [],
"terms_and_conditions": {
"date": "1970-09-30T12:30:50+00:00",
"effective_date": "1981-05-24T13:29:20+00:00",
"term_end_date": "2010-02-14T21:36:31+00:00",
"signing_date": "2023-09-15T13:53:10+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"parties": {
"first_name": "Jane",
"last_name": "Doe",
"email": "wpfeffer@kling.com",
"phone": "+358401231231",
"title": "President",
"company_name": "Sunt tempora veritatis laboriosam eum dolor velit.",
"company_ident": "FI123456789",
"address": {
"address_type": "20341 Whitworth Institute",
"address_lines": "405",
"city": "Seattle",
"locality": "Whitworth",
"administrative_area": "WA",
"post_code": "98052",
"country": "United States of America"
},
"external_references": {
"name": "Odio at consequatur consequuntur voluptatem omnis.",
"title": "Delectus iure repudiandae tempora.",
"value": "Quia ipsa et quibusdam sequi quaerat sint."
}
},
"properties": {
"property_id": "a0nArD",
"value": "1979-04-26T12:03:51+00:00",
"duration": "Incidunt nesciunt blanditiis dolores tenetur.",
"basis": "Et rerum veritatis et tempora et sunt.",
"unit": "Laborum rerum molestias impedit velit in inventore est."
},
"external_references": {
"name": "Nemo explicabo cupiditate error maiores ipsum aut aut.",
"title": "Mollitia aliquid quis aut ut hic magni.",
"value": "Dolorum commodi fugit sunt consequatur."
}
},
"archive_status": "completed",
"reminders": {
"event_type": "document.reminder",
"title": "Earum dolor expedita itaque cum quo dolores.",
"schedules": {
"next_run": "2002-10-13T02:27:11+00:00",
"id": "JL80MX",
"last_run": "2004-04-05T05:35:54+00:00",
"interval": 35839
},
"recipients": {
"value": "john.doe@doe.com",
"channel": "email",
"language": "de"
}
},
"contains_pii": "contains_pii"
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"download_url": "Qui dolorem quas et minus ea.",
"id": "ZgQM1O",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Aut quisquam culpa.",
"description": "Culpa quos excepturi aperiam ratione mollitia quae explicabo aut.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "wAmBJY",
"contract": {
"_type": "contract",
"id": "LDQ3aq",
"name": "Et est autem et est deleniti saepe dolor ut.",
"stage": "Ut asperiores optio vitae unde voluptas deserunt repellendus.",
"document_id": "NDkdZo",
"sign_method": "canvas",
"template_id": "Itaque dignissimos veritatis qui porro ut soluta harum repellat.",
"template": {
"id": "dvNWX0",
"name": "Aut inventore nihil sed deleniti.",
"description": "Ex deleniti esse et rerum et voluptatibus.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "x6wJQG",
"display_name": "Rerum voluptatum suscipit expedita sint qui.",
"first_name": "Est illum voluptatem enim.",
"last_name": "Et ea ea ut quis sint cum cum.",
"email": "murphy.lucinda@gmail.com",
"language": "en"
},
"signing_settings": {
"id": "a2mBGv",
"created_at": "1994-11-23T00:22:11+00:00",
"updated_at": "2009-12-27T16:18:59+00:00",
"contract_id": "DQoXyP",
"message": "Doloribus cupiditate minima id sed vitae quis minus rerum.",
"expires_at": "1997-01-29T14:56:24+00:00",
"reminders_start": "2011-04-04T17:50:59+00:00",
"reminders_end": "1994-03-05T18:45:22+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "a0nkej",
"folder": {
"_type": "folder",
"id": "Z9GXrO",
"name": "Aliquam iste ad magni rem molestias.",
"created_at": "2012-02-04T07:02:57+00:00",
"updated_at": "1995-01-05T21:50:10+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "0ZABao",
"name": "Vel voluptatem quaerat est quo.",
"created_at": "1978-05-19T02:29:39+00:00",
"updated_at": "2009-07-27T20:39:30+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "LDQ3aq",
"owner": {
"id": "Zr9vMD",
"display_name": "Quia doloribus accusamus est exercitationem et dolorem.",
"first_name": "In a expedita excepturi nam saepe ullam corrupti consectetur.",
"last_name": "Illo rerum ut quo magni ex voluptatem.",
"email": "greenholt.bettye@yahoo.com",
"language": "de"
},
"workspace_id": "9yR3vr",
"workspace": {
"_type": "workspace",
"id": "7ajvaP",
"name": "Provident sed officia eum molestiae rerum a est.",
"company_ident": "Iure voluptatem qui rerum.",
"email": "jarrod.will@kautzer.com",
"root_folder_id": "MDWrPO"
},
"file_id": "7rrL28",
"file": {
"_type": "file",
"id": "Dk0bzZ",
"filename": "Error ullam debitis facere nisi quidem numquam.",
"size": 2077102.1071582,
"mime": "Nobis aspernatur aut vel ut corporis.",
"download_url": "https://www.auer.com/commodi-eum-aliquid-qui-nobis-earum",
"preview_url": "https://monahan.com/autem-ipsum-odit-eaque-earum-labore-quae.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "4mop8Q",
"property_id": "0jv1yY",
"property": {
"id": "DWr1mO",
"title": "A a soluta perspiciatis error.",
"description": "Et eius nam et qui consectetur nesciunt.",
"name": "Aut sint sit non nisi.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "GZgz1D",
"workspace": {
"_type": "workspace",
"id": "O7A78Z",
"name": "Voluptatem nisi iste aut autem est.",
"company_ident": "Ex ut ut quis eum assumenda ut.",
"email": "bmurazik@oberbrunner.com",
"root_folder_id": "GDmMqD"
}
}
}
],
"date_values": [
{
"id": "BaEqMa",
"value": "1992-02-17T19:56:02+00:00",
"duration": "P1D",
"basis": "Non vel nostrum est rem quod ratione earum.",
"property_id": "ZG0xNg",
"property": {
"id": "AGbQ1b",
"title": "Dolorum voluptatum nostrum saepe at nostrum.",
"description": "Eum et ut ducimus rerum fugiat quos.",
"name": "Sequi mollitia magnam unde.",
"source": "system",
"data_type": "date",
"workspace_id": "vMzrVd",
"workspace": {
"_type": "workspace",
"id": "5aP1O0",
"name": "Voluptatem voluptatibus illum ad facilis qui qui nihil.",
"company_ident": "Velit odio debitis qui tenetur.",
"email": "sarah.walsh@weber.com",
"root_folder_id": "ZNrqYx"
}
}
}
],
"numeric_values": [
{
"id": "1DM7aR",
"value": 457779.17136369,
"unit": "Voluptas voluptas ex voluptate optio quaerat voluptatem.",
"property_id": "m4PvB9n",
"property": {
"id": "1pLMLe3",
"title": "Voluptatem officia eos assumenda.",
"description": "Velit quas velit ea officiis commodi et unde quia.",
"name": "Veniam labore ut id dolorem quis amet totam.",
"source": "system",
"data_type": "boolean",
"workspace_id": "Z3lB0a",
"workspace": {
"_type": "workspace",
"id": "ZArJba",
"name": "Vitae voluptas ducimus voluptatibus voluptate.",
"company_ident": "Dolore nesciunt illum ab velit non aut.",
"email": "jerrell51@hansen.com",
"root_folder_id": "JZnQDl"
}
}
}
],
"string_values": [
{
"id": "Dk4A3Z",
"value": "Qui libero cupiditate totam enim a.",
"property_id": "DWxqNG",
"property": {
"id": "kbgmMy",
"title": "Est dicta omnis fugiat sapiente eum non dolore.",
"description": "Ipsa fugiat provident corporis qui quo.",
"name": "Laudantium quasi aspernatur porro sit saepe.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "ZlNNRO",
"workspace": {
"_type": "workspace",
"id": "DWbWeO",
"name": "Aut ut voluptate voluptate nihil ut.",
"company_ident": "Et libero odit veniam facilis.",
"email": "tianna.hansen@wilderman.net",
"root_folder_id": "LDQB3Z"
}
}
}
],
"jurisdictions": [
{
"id": "J25JB2",
"code": "Voluptatem odit corrupti aliquam ut."
}
],
"document_types": [
{
"_type": "document_type",
"id": "0ZArBa",
"name": "Aspernatur quaerat laborum eligendi ullam omnis accusantium."
}
],
"parties": [
{
"id": "1DM7aR",
"first_name": "Temporibus fugit vel veritatis aut at.",
"last_name": "Consequuntur ipsum iste a quasi.",
"email": "awilliamson@gmail.com",
"phone": "Quo ducimus nihil tempora facilis id.",
"title": "Voluptas suscipit inventore rerum enim et.",
"company_name": "Amet veritatis labore praesentium iste quo omnis blanditiis.",
"company_ident": "Necessitatibus recusandae vitae iste maiores commodi eum.",
"address_id": "RZXLZ7",
"address": {
"id": "okeJGo",
"address_type": "Et porro distinctio fuga quia quam qui nam quis.",
"address_lines": "Accusantium illo enim natus quia reprehenderit.",
"city": "Optio voluptatem quos perferendis eaque dolore maiores.",
"locality": "In similique voluptatibus possimus qui omnis harum libero.",
"administrative_area": "Fugit dolor eius accusamus accusantium itaque quia.",
"post_code": "Quibusdam provident architecto molestiae optio.",
"country": "Minima sapiente iusto facilis quo."
},
"external_references": [
{
"id": "WaB3AO",
"name": "Dolorem non voluptates et dolorem rem rem.",
"title": "Explicabo quasi nesciunt eveniet reiciendis.",
"value": "In asperiores illum laudantium perspiciatis tempora deleniti doloremque nemo."
}
]
}
],
"reminders": [
{
"id": "eDJb0D",
"event_type": "document.reminder",
"title": "Id corrupti error aut dicta."
}
],
"attachments": [
{
"id": "Z3v3n4",
"created_at": "2023-07-11T21:27:03+00:00",
"updated_at": "2006-06-26T14:33:19+00:00",
"file_id": "G2qylER",
"file": {
"_type": "file",
"id": "7ajzKa",
"filename": "example.pdf",
"size": 0.7087,
"mime": "application/pdf",
"download_url": "https://leffler.com/ex-excepturi-sunt-cum-consequatur-quo.html",
"preview_url": "https://www.fritsch.org/dolorem-dolores-enim-et-repellat-labore-dolor"
}
}
],
"external_references": [
{
"id": "BQR6kM",
"name": "Et neque enim id deleniti.",
"title": "Ipsa autem illo est enim.",
"value": "Hic architecto reprehenderit quis qui."
}
],
"tags": [
{
"tag": "Sint sed eum nam."
}
],
"terms_and_conditions": {
"date": "1972-12-13T02:20:04+00:00",
"effective_date": "2009-12-01T05:33:03+00:00",
"term_end_date": "1997-06-29T04:38:28+00:00",
"signing_date": "1974-09-04T01:20:26+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1978-03-18T21:01:38+00:00"
},
"breadcrumb": [
{
"id": "KOqPja",
"name": "Optio officiis unde sint iusto modi adipisci cumque.",
"depth": 4
}
]
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get document data
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/J2xQwA" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/J2xQwA"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/J2xQwA';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/J2xQwA'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"download_url": "Voluptatum saepe in animi doloribus quisquam ex.",
"id": "OykrKZ",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Voluptatum velit odit quas.",
"description": "Aut distinctio nam dolore.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "YZ9AAZ",
"contract": {
"_type": "contract",
"id": "pRGdp8",
"name": "Quasi ut est doloribus aut hic hic.",
"stage": "Maiores distinctio magni reprehenderit aut quisquam.",
"document_id": "wKp6mm",
"sign_method": "canvas",
"template_id": "Expedita est esse vel consequatur.",
"template": {
"id": "ZgB1zW",
"name": "Vero ut aut doloremque non est.",
"description": "Ipsum qui velit facere enim et quia.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "ZXy3Ba",
"display_name": "Et ut accusamus dolorem quos totam dolores in.",
"first_name": "Voluptas similique voluptatibus reprehenderit ut eum id.",
"last_name": "Ut est eos nihil mollitia eum molestiae autem.",
"email": "dleannon@gmail.com",
"language": "sv"
},
"signing_settings": {
"id": "pZGRDw",
"created_at": "2020-11-21T06:37:01+00:00",
"updated_at": "1976-07-12T02:51:08+00:00",
"contract_id": "Ookp1O",
"message": "Ut aliquam ut et voluptatibus aut voluptatem.",
"expires_at": "1981-07-18T11:32:46+00:00",
"reminders_start": "2011-07-30T04:48:44+00:00",
"reminders_end": "1987-06-20T10:23:09+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "BlN1JA",
"folder": {
"_type": "folder",
"id": "laekGD",
"name": "Maiores excepturi qui perferendis.",
"created_at": "2021-06-26T23:46:43+00:00",
"updated_at": "2016-03-07T05:43:15+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "56Wo0mp",
"name": "Nobis laudantium nisi earum perspiciatis voluptatem voluptas ullam.",
"created_at": "1979-01-22T22:59:05+00:00",
"updated_at": "1978-08-16T09:03:20+00:00",
"parent_id": "0ZABao",
"has_children": true
},
"has_children": true
},
"owner_id": "a2GwV0",
"owner": {
"id": "5aPM1O",
"display_name": "Quae odit nostrum sit eos.",
"first_name": "Exercitationem asperiores sint quaerat.",
"last_name": "Enim velit nulla et eum.",
"email": "mariano94@gmail.com",
"language": "de"
},
"workspace_id": "DQdRjO",
"workspace": {
"_type": "workspace",
"id": "OybdqD",
"name": "Facere veritatis quis omnis voluptate.",
"company_ident": "Quas voluptatum laudantium pariatur veritatis ut earum.",
"email": "littel.moses@bogan.com",
"root_folder_id": "wOywZL"
},
"file_id": "oLpM0q",
"file": {
"_type": "file",
"id": "aLQKGO",
"filename": "Optio aliquid sunt at modi quod qui reprehenderit.",
"size": 1.2,
"mime": "Provident consequatur quod ea sed voluptates qui.",
"download_url": "http://white.com/hic-sed-nihil-quas-voluptas",
"preview_url": "http://www.weissnat.com/sed-excepturi-blanditiis-repellat-sit-itaque-ipsa.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "8dyN8V",
"value": true,
"property_id": "j8xjW9",
"property": {
"id": "pZG0Ra",
"title": "Voluptatem enim ipsum assumenda velit quaerat iste quo repudiandae.",
"description": "Fuga praesentium odit adipisci distinctio non.",
"name": "Eos fuga porro vitae at.",
"source": "system",
"data_type": "string",
"workspace_id": "laeA3a",
"workspace": {
"_type": "workspace",
"id": "Dd92AX",
"name": "Voluptas placeat dolorem aliquam omnis aut aperiam.",
"company_ident": "Ipsam velit qui repudiandae quam.",
"email": "asia27@morar.com",
"root_folder_id": "R8xNQx"
}
}
}
],
"date_values": [
{
"id": "DYK4va",
"value": "1977-04-26T04:17:41+00:00",
"duration": "P1D",
"basis": "Veniam ducimus in rerum doloremque odio cumque id.",
"property_id": "PZporD",
"property": {
"id": "JE7g7yR",
"title": "Enim voluptates sit a soluta placeat.",
"description": "Quis quia blanditiis est culpa necessitatibus.",
"name": "Perspiciatis sunt nihil repellat blanditiis.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "Bb5NQE",
"workspace": {
"_type": "workspace",
"id": "oazMEZ",
"name": "Laudantium temporibus eum perferendis omnis.",
"company_ident": "Fugiat voluptatem quae laudantium esse quasi est inventore.",
"email": "fay.corwin@yahoo.com",
"root_folder_id": "jZNNqZ"
}
}
}
],
"numeric_values": [
{
"id": "Mz8Pqq",
"value": 51997110.173531584,
"unit": "Doloremque ab cum odit quae ut et ducimus dolor.",
"property_id": "zk7nYY",
"property": {
"id": "4NWkne",
"title": "Temporibus nobis consequatur cumque reiciendis.",
"description": "Dolorem nobis explicabo maiores cupiditate quam nesciunt eum non.",
"name": "Tenetur sint voluptatem velit fugit sapiente libero dolorem.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "5NppRM",
"workspace": {
"_type": "workspace",
"id": "AnbPEk",
"name": "Dolorem consequatur amet quae quae reiciendis.",
"company_ident": "Qui officiis amet fuga non hic neque.",
"email": "alittel@durgan.com",
"root_folder_id": "q09ovK"
}
}
}
],
"string_values": [
{
"id": "OqylgO",
"value": "Tempore eos nam fugit atque natus voluptate.",
"property_id": "yQXx2g",
"property": {
"id": "LZKJYD",
"title": "Numquam asperiores accusamus ipsum.",
"description": "Et odit expedita harum dolor.",
"name": "Asperiores enim est sint et aut.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "9KwGwA",
"workspace": {
"_type": "workspace",
"id": "V3YLmd",
"name": "Eaque aut sint deserunt veritatis et est vero.",
"company_ident": "Dolore laborum quibusdam impedit.",
"email": "wyost@hotmail.com",
"root_folder_id": "ORqGR2"
}
}
}
],
"jurisdictions": [
{
"id": "gD6jDw",
"code": "Dolor vel voluptatem cupiditate hic."
}
],
"document_types": [
{
"_type": "document_type",
"id": "Z3pnda",
"name": "Ad minus eveniet beatae facere soluta consectetur."
}
],
"parties": [
{
"id": "jE93Ry",
"first_name": "Non vel et in et consequuntur.",
"last_name": "Architecto quae eius aspernatur asperiores magnam rerum eligendi.",
"email": "muller.drew@yahoo.com",
"phone": "Illum tenetur et cum.",
"title": "Et fugiat nemo error eos architecto.",
"company_name": "Esse incidunt mollitia et dolorem.",
"company_ident": "Consequatur voluptate labore sit et quibusdam.",
"address_id": "OvvqPO",
"address": {
"id": "zOwoOd",
"address_type": "Et dolor sit placeat commodi velit.",
"address_lines": "Aut alias consequatur voluptate voluptatem quia ratione inventore.",
"city": "Quae amet cupiditate expedita molestias similique harum.",
"locality": "Ut minus libero non ipsam omnis.",
"administrative_area": "Mollitia veritatis enim quod.",
"post_code": "Dicta temporibus beatae nam expedita inventore delectus officiis.",
"country": "Repellat nemo non provident quos accusantium autem eum."
},
"external_references": [
{
"id": "Z8eEma",
"name": "Et blanditiis sunt molestiae quae qui consequatur.",
"title": "Aperiam qui doloribus iusto debitis amet praesentium.",
"value": "Eaque qui repellendus sed asperiores incidunt et culpa."
}
]
}
],
"reminders": [
{
"id": "2ZlLRZ",
"event_type": "document.reminder",
"title": "Eveniet autem ut vel odit."
}
],
"attachments": [
{
"id": "ED5qpD",
"created_at": "2002-08-26T06:30:56+00:00",
"updated_at": "2000-01-01T11:14:32+00:00",
"file_id": "zrNXQ8",
"file": {
"_type": "file",
"id": "ZXYVma",
"filename": "example.pdf",
"size": 1.266,
"mime": "application/pdf",
"download_url": "http://www.will.net/saepe-quis-modi-sunt-et-sequi-quae-architecto",
"preview_url": "https://schowalter.org/quae-aperiam-sint-accusamus-maiores-perferendis.html"
}
}
],
"external_references": [
{
"id": "BZV36a",
"name": "Vitae voluptatem accusantium rem nemo.",
"title": "Est cum tempora veritatis aperiam et.",
"value": "Numquam quisquam nesciunt aperiam natus."
}
],
"tags": [
{
"tag": "Quos ad eum voluptatem."
}
],
"terms_and_conditions": {
"date": "2023-06-18T12:14:34+00:00",
"effective_date": "2001-03-01T13:25:34+00:00",
"term_end_date": "2004-06-25T11:09:11+00:00",
"signing_date": "1981-02-21T13:39:21+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1992-04-15T08:46:27+00:00"
},
"breadcrumb": [
{
"id": "Ma2naY",
"name": "In facilis voluptates magni optio fugiat omnis eligendi vel.",
"depth": 562
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update basic document properties
requires authentication
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/documents/BZ3wzZ" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Recusandae in esse temporibus vitae blanditiis deserunt quo.\",
\"description\": \"Quas et fuga consectetur ut blanditiis.\",
\"archive_status\": \"Non est rerum minus rerum molestias.\",
\"folder_id\": \"ekBdJ3\",
\"owner_id\": \"O4bBJZ\",
\"contains_pii\": \"contains_pii\",
\"contract\": {
\"name\": \"Rerum rerum nemo aut itaque at quidem asperiores vitae.\",
\"creator_name\": \"Sit quisquam non expedita accusantium omnis quia.\",
\"sign_method\": \"manual\",
\"signing_settings\": {
\"expires_at\": \"2002-08-01T05:09:15+00:00\",
\"sender_name\": \"John Doe\",
\"message\": \"Quibusdam dignissimos quia ipsam.\",
\"reminders_start\": \"2018-03-24T14:37:34+00:00\",
\"reminders_end\": \"2017-06-03T18:07:46+00:00\",
\"reminders_duration\": \"P3D\"
}
}
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/BZ3wzZ"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "Recusandae in esse temporibus vitae blanditiis deserunt quo.",
"description": "Quas et fuga consectetur ut blanditiis.",
"archive_status": "Non est rerum minus rerum molestias.",
"folder_id": "ekBdJ3",
"owner_id": "O4bBJZ",
"contains_pii": "contains_pii",
"contract": {
"name": "Rerum rerum nemo aut itaque at quidem asperiores vitae.",
"creator_name": "Sit quisquam non expedita accusantium omnis quia.",
"sign_method": "manual",
"signing_settings": {
"expires_at": "2002-08-01T05:09:15+00:00",
"sender_name": "John Doe",
"message": "Quibusdam dignissimos quia ipsam.",
"reminders_start": "2018-03-24T14:37:34+00:00",
"reminders_end": "2017-06-03T18:07:46+00:00",
"reminders_duration": "P3D"
}
}
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/BZ3wzZ';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'Recusandae in esse temporibus vitae blanditiis deserunt quo.',
'description' => 'Quas et fuga consectetur ut blanditiis.',
'archive_status' => 'Non est rerum minus rerum molestias.',
'folder_id' => 'ekBdJ3',
'owner_id' => 'O4bBJZ',
'contains_pii' => 'contains_pii',
'contract' => [
'name' => 'Rerum rerum nemo aut itaque at quidem asperiores vitae.',
'creator_name' => 'Sit quisquam non expedita accusantium omnis quia.',
'sign_method' => 'manual',
'signing_settings' => [
'expires_at' => '2002-08-01T05:09:15+00:00',
'sender_name' => 'John Doe',
'message' => 'Quibusdam dignissimos quia ipsam.',
'reminders_start' => '2018-03-24T14:37:34+00:00',
'reminders_end' => '2017-06-03T18:07:46+00:00',
'reminders_duration' => 'P3D',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/BZ3wzZ'
payload = {
"title": "Recusandae in esse temporibus vitae blanditiis deserunt quo.",
"description": "Quas et fuga consectetur ut blanditiis.",
"archive_status": "Non est rerum minus rerum molestias.",
"folder_id": "ekBdJ3",
"owner_id": "O4bBJZ",
"contains_pii": "contains_pii",
"contract": {
"name": "Rerum rerum nemo aut itaque at quidem asperiores vitae.",
"creator_name": "Sit quisquam non expedita accusantium omnis quia.",
"sign_method": "manual",
"signing_settings": {
"expires_at": "2002-08-01T05:09:15+00:00",
"sender_name": "John Doe",
"message": "Quibusdam dignissimos quia ipsam.",
"reminders_start": "2018-03-24T14:37:34+00:00",
"reminders_end": "2017-06-03T18:07:46+00:00",
"reminders_duration": "P3D"
}
}
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"download_url": "Dolor nesciunt minus minima quisquam ea numquam.",
"id": "gD67jZ",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Nihil cupiditate excepturi.",
"description": "Facilis voluptas consequatur eius error cum incidunt quod.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "4QK90q",
"contract": {
"_type": "contract",
"id": "EwvpJ7",
"name": "Sapiente similique sapiente et dolorem.",
"stage": "At molestiae corporis sint quod.",
"document_id": "DQm9PD",
"sign_method": "docusign",
"template_id": "Ut quaerat voluptas sed sapiente voluptatem a.",
"template": {
"id": "wOyNwD",
"name": "Consectetur corporis beatae quis qui eveniet explicabo vel libero.",
"description": "Quod necessitatibus dolores perferendis sequi voluptatem.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "kePgpx",
"display_name": "Voluptatem consequatur natus nesciunt alias nihil.",
"first_name": "Hic inventore voluptatem laborum.",
"last_name": "Exercitationem aliquid ipsa et vel ea.",
"email": "bergnaum.ernestina@yahoo.com",
"language": "sv"
},
"signing_settings": {
"id": "ajm136",
"created_at": "2008-07-22T07:12:20+00:00",
"updated_at": "1988-05-10T08:06:03+00:00",
"contract_id": "wOywZL",
"message": "Omnis ut et impedit pariatur at ducimus repellat.",
"expires_at": "1994-08-30T04:50:27+00:00",
"reminders_start": "1988-12-27T14:21:57+00:00",
"reminders_end": "1981-08-26T10:04:43+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "Z9pp1D",
"folder": {
"_type": "folder",
"id": "KNXlbE",
"name": "Et porro sit quas laborum eligendi laudantium et quaerat.",
"created_at": "1980-08-09T10:18:03+00:00",
"updated_at": "1982-03-08T15:48:02+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "wOywZL",
"name": "Nisi consequatur ipsa aperiam culpa.",
"created_at": "2008-09-13T00:47:38+00:00",
"updated_at": "1975-06-22T05:18:51+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "ZgQePA",
"owner": {
"id": "zOwz3a",
"display_name": "Corporis eligendi cum consequuntur quidem est.",
"first_name": "Quod praesentium assumenda doloremque doloremque autem ut soluta.",
"last_name": "Et ad est voluptas rerum.",
"email": "osborne.mccullough@yahoo.com",
"language": "fi"
},
"workspace_id": "DMLP8O",
"workspace": {
"_type": "workspace",
"id": "9Jp1p1",
"name": "Et nesciunt eum ea ut est deserunt quia.",
"company_ident": "Quasi quibusdam libero delectus et sit aperiam.",
"email": "hope30@hauck.com",
"root_folder_id": "DJMw7R"
},
"file_id": "eDJ0a1",
"file": {
"_type": "file",
"id": "V5NoN7L",
"filename": "Minima et eaque non qui reiciendis quibusdam.",
"size": 4407.34229024,
"mime": "Illo vel at nihil.",
"download_url": "http://www.torphy.net/vitae-et-laboriosam-tenetur-rem",
"preview_url": "http://gutmann.net/et-harum-quis-et-natus-quam-sed-quasi"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "Z1kbb3",
"property_id": "5aP0Ra",
"property": {
"id": "D648Aa",
"title": "Qui et libero sed fugit dolores possimus voluptatum.",
"description": "Quia hic cupiditate dolor voluptatem quidem.",
"name": "Ut quia voluptatem consequatur beatae aut quasi.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "BZV36a",
"workspace": {
"_type": "workspace",
"id": "podlNd",
"name": "Vel ex rerum facilis deleniti doloremque sit fugit.",
"company_ident": "Ullam aut corrupti aspernatur esse.",
"email": "greenfelder.coralie@satterfield.com",
"root_folder_id": "DQX8lO"
}
}
}
],
"date_values": [
{
"id": "LZ80mZ",
"value": "1975-10-09T08:15:21+00:00",
"duration": "P1D",
"basis": "In modi facilis sed et laborum.",
"property_id": "DkM0Lk",
"property": {
"id": "laeGDm",
"title": "Ipsam et cupiditate vel.",
"description": "Quo hic incidunt earum magnam facere velit.",
"name": "Aperiam quasi cumque occaecati deleniti vel molestiae.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "Ov9o5V",
"workspace": {
"_type": "workspace",
"id": "Z3Xn0a",
"name": "A in sed porro ex distinctio.",
"company_ident": "Qui omnis explicabo qui quia.",
"email": "kfunk@gmail.com",
"root_folder_id": "Ox35Q1"
}
}
}
],
"numeric_values": [
{
"id": "eDJ0a1",
"value": 233399.52934301,
"unit": "Maxime inventore rerum voluptates ea voluptatem corporis temporibus.",
"property_id": "gBR4mQ",
"property": {
"id": "aBNQya",
"title": "Esse dolorem ut saepe nesciunt sapiente tempora sit.",
"description": "Reprehenderit sit id adipisci et consequatur soluta reiciendis.",
"name": "Id molestiae et aspernatur est omnis non et.",
"source": "system",
"data_type": "date",
"workspace_id": "vOxVqZ",
"workspace": {
"_type": "workspace",
"id": "ekE235",
"name": "Qui similique quam aut rerum animi ut.",
"company_ident": "Error quod nihil in quo.",
"email": "kling.derrick@haag.net",
"root_folder_id": "Zp4NN8"
}
}
}
],
"string_values": [
{
"id": "OymAVJ",
"value": "Doloribus excepturi accusamus aut consequatur dolor saepe quia.",
"property_id": "Ow5KRB",
"property": {
"id": "ll8zby",
"title": "Ipsum voluptatibus hic quo quod est.",
"description": "Perspiciatis non nemo porro a quia iure voluptates.",
"name": "Autem sunt laboriosam qui animi sit dolorem animi.",
"source": "system",
"data_type": "date",
"workspace_id": "Ma2Jna",
"workspace": {
"_type": "workspace",
"id": "Ov51Xa",
"name": "Labore et inventore esse nostrum.",
"company_ident": "Veniam dolores et labore ex occaecati.",
"email": "walter19@gmail.com",
"root_folder_id": "g5RPWW"
}
}
}
],
"jurisdictions": [
{
"id": "NDkdZo",
"code": "Libero numquam ea amet consequatur."
}
],
"document_types": [
{
"_type": "document_type",
"id": "DJpjmw",
"name": "Vel est est quia nostrum magni qui."
}
],
"parties": [
{
"id": "677WJ0",
"first_name": "Voluptate aliquam in vitae et laboriosam.",
"last_name": "Quos sit est impedit voluptatum repellat.",
"email": "hagenes.breanne@gmail.com",
"phone": "Nihil cupiditate distinctio natus est omnis perspiciatis eveniet et.",
"title": "Est dolor natus rerum cupiditate.",
"company_name": "Qui numquam ducimus et id.",
"company_ident": "Est natus laboriosam debitis officia in ut.",
"address_id": "8ykKoe",
"address": {
"id": "ZXkj9D",
"address_type": "Culpa itaque voluptatem atque ea itaque.",
"address_lines": "Cumque soluta minima eveniet sunt distinctio aut.",
"city": "Iste illo aut dolores voluptatem qui est non id.",
"locality": "Non sapiente iure veniam excepturi consectetur.",
"administrative_area": "Qui quibusdam sit quam facere omnis qui dolorem.",
"post_code": "Asperiores harum nostrum et dolores suscipit ipsum nam.",
"country": "Aliquid quos quibusdam numquam asperiores provident ut eligendi."
},
"external_references": [
{
"id": "BaEMaV",
"name": "Id est animi aliquid quidem similique ipsum.",
"title": "Omnis ut aut soluta est.",
"value": "Ipsum iure consequuntur assumenda non nihil."
}
]
}
],
"reminders": [
{
"id": "ajJzda",
"event_type": "document.reminder",
"title": "Voluptatem ad sit ut totam deserunt dicta modi."
}
],
"attachments": [
{
"id": "NObgxD",
"created_at": "2016-08-08T10:43:24+00:00",
"updated_at": "2024-12-13T15:55:34+00:00",
"file_id": "l8ANvo",
"file": {
"_type": "file",
"id": "X7m7pQd",
"filename": "example.pdf",
"size": 7960110.464214823,
"mime": "application/pdf",
"download_url": "https://hilpert.com/tempore-facilis-molestiae-hic-dicta-fugit-consequatur.html",
"preview_url": "http://windler.com/"
}
}
],
"external_references": [
{
"id": "DMLWQj",
"name": "Molestiae in optio quo qui.",
"title": "Voluptate aut rerum unde.",
"value": "Aut error ea totam consectetur odit."
}
],
"tags": [
{
"tag": "Deserunt voluptatem rerum exercitationem quasi et."
}
],
"terms_and_conditions": {
"date": "2020-08-06T10:16:58+00:00",
"effective_date": "2022-03-03T17:57:29+00:00",
"term_end_date": "1983-04-30T14:48:36+00:00",
"signing_date": "2007-07-07T04:59:19+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1996-04-01T02:12:06+00:00"
},
"breadcrumb": [
{
"id": "WaBRMa",
"name": "Suscipit aut in deserunt.",
"depth": 5
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a document
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/no41xeQ" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/no41xeQ"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/no41xeQ';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/no41xeQ'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a document from template
requires authentication
Template hash can be obtained via web GUI or from support.
Once the document has been created, extract contract.id and use it as
Example request:
curl --request POST \
"https://api.docue.com/public/v2/templates/ORz7nO/start" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"folder_id\": \"gD6jDw\",
\"title\": \"Sed similique iusto quos nulla nostrum et fugiat.\",
\"creator_name\": \"Nemo aperiam et aspernatur amet totam consequatur animi.\",
\"sign_method\": \"strong\",
\"signing_settings\": {
\"expires_at\": \"1978-02-10T17:29:55+00:00\",
\"sender_name\": \"John Doe\",
\"message\": \"Et atque officia possimus aut explicabo et officiis.\",
\"reminders_start\": \"1985-03-26T04:30:56+00:00\",
\"reminders_end\": \"2021-11-22T11:08:37+00:00\",
\"reminders_duration\": \"P3D\"
}
}"
const url = new URL(
"https://api.docue.com/public/v2/templates/ORz7nO/start"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"folder_id": "gD6jDw",
"title": "Sed similique iusto quos nulla nostrum et fugiat.",
"creator_name": "Nemo aperiam et aspernatur amet totam consequatur animi.",
"sign_method": "strong",
"signing_settings": {
"expires_at": "1978-02-10T17:29:55+00:00",
"sender_name": "John Doe",
"message": "Et atque officia possimus aut explicabo et officiis.",
"reminders_start": "1985-03-26T04:30:56+00:00",
"reminders_end": "2021-11-22T11:08:37+00:00",
"reminders_duration": "P3D"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/templates/ORz7nO/start';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'folder_id' => 'gD6jDw',
'title' => 'Sed similique iusto quos nulla nostrum et fugiat.',
'creator_name' => 'Nemo aperiam et aspernatur amet totam consequatur animi.',
'sign_method' => 'strong',
'signing_settings' => [
'expires_at' => '1978-02-10T17:29:55+00:00',
'sender_name' => 'John Doe',
'message' => 'Et atque officia possimus aut explicabo et officiis.',
'reminders_start' => '1985-03-26T04:30:56+00:00',
'reminders_end' => '2021-11-22T11:08:37+00:00',
'reminders_duration' => 'P3D',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/templates/ORz7nO/start'
payload = {
"folder_id": "gD6jDw",
"title": "Sed similique iusto quos nulla nostrum et fugiat.",
"creator_name": "Nemo aperiam et aspernatur amet totam consequatur animi.",
"sign_method": "strong",
"signing_settings": {
"expires_at": "1978-02-10T17:29:55+00:00",
"sender_name": "John Doe",
"message": "Et atque officia possimus aut explicabo et officiis.",
"reminders_start": "1985-03-26T04:30:56+00:00",
"reminders_end": "2021-11-22T11:08:37+00:00",
"reminders_duration": "P3D"
}
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"download_url": "Alias temporibus quaerat modi ut repudiandae.",
"id": "lLkqMn",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Asperiores perferendis dolorum sed.",
"description": "Explicabo aliquam porro ut ullam facere tempore culpa.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "DJeywO",
"contract": {
"_type": "contract",
"id": "vOxneZ",
"name": "Ipsum dolores tenetur maxime in.",
"stage": "Ipsum ipsum et voluptatem dolores.",
"document_id": "jZNKya",
"sign_method": "docusign",
"template_id": "Rerum atque et iste maiores laborum et.",
"template": {
"id": "vOxd2O",
"name": "Fugit aperiam doloremque eaque ex voluptatem.",
"description": "Consequuntur totam nihil doloremque quos eligendi.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "ga0j5D",
"display_name": "Fugiat et iure unde odit sunt delectus.",
"first_name": "Et facere dolore optio quis id ducimus.",
"last_name": "Hic quis cumque aliquam ducimus laudantium ut voluptas.",
"email": "xander30@yahoo.com",
"language": "fi"
},
"signing_settings": {
"id": "ZK8Mga",
"created_at": "1984-11-07T06:25:49+00:00",
"updated_at": "1972-04-29T22:36:53+00:00",
"contract_id": "eDJRED",
"message": "Perferendis error quis veritatis.",
"expires_at": "2003-08-03T16:37:33+00:00",
"reminders_start": "2006-02-10T21:44:20+00:00",
"reminders_end": "2001-10-04T05:49:23+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "0jPVez",
"folder": {
"_type": "folder",
"id": "gD6jDw",
"name": "Voluptatum eligendi modi nobis aut ipsa.",
"created_at": "2015-07-09T14:35:15+00:00",
"updated_at": "1998-07-21T22:00:54+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "RZX9ma",
"name": "Quaerat qui velit dicta deleniti voluptate.",
"created_at": "2020-03-04T20:29:50+00:00",
"updated_at": "1970-06-12T03:30:08+00:00",
"parent_id": "0ZABao",
"has_children": true
},
"has_children": true
},
"owner_id": "pZGRnD",
"owner": {
"id": "xQ3N1PA",
"display_name": "Eius eos quos at odio est et dolor.",
"first_name": "Itaque maxime ad est qui est et sapiente reiciendis.",
"last_name": "Sint voluptatem fuga rerum eos libero libero natus itaque.",
"email": "elenor67@hotmail.com",
"language": "sv"
},
"workspace_id": "2pzpmd",
"workspace": {
"_type": "workspace",
"id": "a2pWvD",
"name": "Natus repellendus fugiat labore ab nulla.",
"company_ident": "Iste dignissimos praesentium expedita non harum officia adipisci.",
"email": "eliza45@wisoky.net",
"root_folder_id": "eDJAwO"
},
"file_id": "LDQ3aq",
"file": {
"_type": "file",
"id": "0ZABao",
"filename": "Omnis quisquam velit nam qui vel quis.",
"size": 73714.77,
"mime": "Quis ducimus laudantium officiis nobis nisi ex.",
"download_url": "http://luettgen.info/odit-modi-voluptas-quidem-eum.html",
"preview_url": "https://www.herman.com/enim-rerum-libero-libero-ad-vitae-voluptates-dolores"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "GZgWAZ",
"value": true,
"property_id": "RZXLZ7",
"property": {
"id": "DQB98Y",
"title": "Cumque veniam perspiciatis et error in.",
"description": "Qui quis explicabo voluptatem laboriosam in aut optio.",
"name": "Delectus velit dolore labore architecto unde.",
"source": "system",
"data_type": "boolean",
"workspace_id": "ZgQ0RW",
"workspace": {
"_type": "workspace",
"id": "YZ9WOe",
"name": "Sit illum ducimus ut error quia ut labore.",
"company_ident": "Dolorem laborum voluptatibus esse possimus at perspiciatis.",
"email": "sgreenfelder@flatley.org",
"root_folder_id": "Ma2Jna"
}
}
}
],
"date_values": [
{
"id": "DMgyja",
"value": "1998-03-29T21:13:40+00:00",
"duration": "P1D",
"basis": "Aut saepe hic quia in magnam.",
"property_id": "QGjpQ0j",
"property": {
"id": "laeGDm",
"title": "Doloremque quia accusamus vel neque.",
"description": "Excepturi neque ipsa tempora earum perferendis.",
"name": "Et nobis unde hic distinctio optio voluptatem.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "xklk6j",
"workspace": {
"_type": "workspace",
"id": "YbVxRj",
"name": "Aspernatur natus voluptas dolorem in qui nesciunt.",
"company_ident": "Omnis modi provident nihil et.",
"email": "awyman@ohara.com",
"root_folder_id": "ArqGVB"
}
}
}
],
"numeric_values": [
{
"id": "g4nyyk",
"value": 6.4,
"unit": "Molestiae saepe magnam aliquid et voluptatem et.",
"property_id": "O4gKya",
"property": {
"id": "1DM7aR",
"title": "Debitis iure sequi rerum incidunt quia atque quibusdam.",
"description": "Voluptas velit et minus laudantium nobis.",
"name": "Aut tempore optio soluta officiis tempore.",
"source": "system",
"data_type": "date",
"workspace_id": "v95v9R",
"workspace": {
"_type": "workspace",
"id": "1DM7aR",
"name": "Nihil impedit et commodi nobis occaecati architecto.",
"company_ident": "Minus eligendi dolorem distinctio eius beatae perferendis placeat.",
"email": "wolf.betty@hotmail.com",
"root_folder_id": "DMAENr"
}
}
}
],
"string_values": [
{
"id": "aLLLYa",
"value": "Et eos quos sint.",
"property_id": "1DML7O",
"property": {
"id": "zpmWY3",
"title": "Tempora est error sint ipsa occaecati.",
"description": "Architecto atque et in et nobis.",
"name": "Nisi est nihil est aliquam minus dolorem.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "ZAq3m2",
"workspace": {
"_type": "workspace",
"id": "zpvnnrQ",
"name": "Ipsum dolores doloribus necessitatibus facilis sit et magni.",
"company_ident": "Odio ad delectus sit.",
"email": "strosin.jaylan@ledner.com",
"root_folder_id": "38wYR0"
}
}
}
],
"jurisdictions": [
{
"id": "LDQ3aq",
"code": "Quis voluptas vel illo."
}
],
"document_types": [
{
"_type": "document_type",
"id": "Vw3X6l",
"name": "Quasi nihil consequatur voluptatem consequatur non vel."
}
],
"parties": [
{
"id": "aEAmr2",
"first_name": "Cupiditate laudantium quidem molestiae et sed voluptatum est.",
"last_name": "Assumenda animi explicabo officiis.",
"email": "schamberger.thora@gmail.com",
"phone": "Modi repellendus modi doloribus est quis aut.",
"title": "Quos numquam molestiae dolorum iusto velit atque.",
"company_name": "Molestiae iste dolor a voluptas.",
"company_ident": "Minus ad autem ut pariatur incidunt distinctio est qui.",
"address_id": "aPG6NZ",
"address": {
"id": "LZ89aA",
"address_type": "Temporibus est dolorem possimus quia quod eius.",
"address_lines": "Ab dolores et ex omnis.",
"city": "Vel id qui repellat fugit quidem suscipit a.",
"locality": "Optio illum praesentium tempore nemo esse odit nihil numquam.",
"administrative_area": "Et a temporibus aut ex velit qui vel.",
"post_code": "Neque pariatur nihil mollitia animi sit delectus molestiae.",
"country": "Dolor blanditiis rerum qui omnis voluptatem consequatur et."
},
"external_references": [
{
"id": "O4NByZ",
"name": "Vel rerum autem minus animi sit.",
"title": "Harum et facere magnam error pariatur.",
"value": "Sit non molestias ipsam sit."
}
]
}
],
"reminders": [
{
"id": "BaEpVZ",
"event_type": "document.reminder",
"title": "Ea est quisquam expedita at."
}
],
"attachments": [
{
"id": "NObxZW",
"created_at": "2025-08-16T03:20:36+00:00",
"updated_at": "1970-11-09T02:24:05+00:00",
"file_id": "oazMEZ",
"file": {
"_type": "file",
"id": "1A5pKN",
"filename": "example.pdf",
"size": 14497.383658246,
"mime": "application/pdf",
"download_url": "http://bahringer.com/est-qui-sint-doloribus-minima-voluptates-quaerat-dolorum.html",
"preview_url": "https://www.altenwerth.org/et-dicta-ipsa-vel-dolor-quidem"
}
}
],
"external_references": [
{
"id": "jZN8qO",
"name": "Iusto et autem aperiam omnis sint quia repellendus.",
"title": "Ullam placeat ut quo pariatur.",
"value": "Deleniti modi quidem vel earum."
}
],
"tags": [
{
"tag": "Odit maxime eligendi est ut fugiat eos ipsa."
}
],
"terms_and_conditions": {
"date": "1991-06-24T18:00:29+00:00",
"effective_date": "2021-02-07T07:09:22+00:00",
"term_end_date": "1993-09-09T11:52:32+00:00",
"signing_date": "2010-08-19T23:46:17+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "2006-03-04T04:53:14+00:00"
},
"breadcrumb": [
{
"id": "YZ9bPa",
"name": "Et alias quibusdam aut.",
"depth": 34
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a document from user template
requires authentication
User templates are common templates that have been pre-configured with data. Template hash can be obtained via web GUI or from support.
Once the document has been created, extract contract.id and use it as
Example request:
curl --request POST \
"https://api.docue.com/public/v2/user-templates/1/start" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"folder_id\": \"Z1r6KW\",
\"title\": \"Dolorem sed distinctio exercitationem corporis sit corrupti.\",
\"sign_method\": \"canvas\",
\"signing_settings\": {
\"expires_at\": \"1999-12-16T05:23:15+00:00\",
\"sender_name\": \"John Doe\",
\"message\": \"Qui ad et consectetur non repudiandae aliquam.\",
\"reminders_start\": \"2015-04-29T17:17:31+00:00\",
\"reminders_end\": \"1996-07-19T22:09:32+00:00\",
\"reminders_duration\": \"P3D\"
}
}"
const url = new URL(
"https://api.docue.com/public/v2/user-templates/1/start"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"folder_id": "Z1r6KW",
"title": "Dolorem sed distinctio exercitationem corporis sit corrupti.",
"sign_method": "canvas",
"signing_settings": {
"expires_at": "1999-12-16T05:23:15+00:00",
"sender_name": "John Doe",
"message": "Qui ad et consectetur non repudiandae aliquam.",
"reminders_start": "2015-04-29T17:17:31+00:00",
"reminders_end": "1996-07-19T22:09:32+00:00",
"reminders_duration": "P3D"
}
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/user-templates/1/start';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'folder_id' => 'Z1r6KW',
'title' => 'Dolorem sed distinctio exercitationem corporis sit corrupti.',
'sign_method' => 'canvas',
'signing_settings' => [
'expires_at' => '1999-12-16T05:23:15+00:00',
'sender_name' => 'John Doe',
'message' => 'Qui ad et consectetur non repudiandae aliquam.',
'reminders_start' => '2015-04-29T17:17:31+00:00',
'reminders_end' => '1996-07-19T22:09:32+00:00',
'reminders_duration' => 'P3D',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/user-templates/1/start'
payload = {
"folder_id": "Z1r6KW",
"title": "Dolorem sed distinctio exercitationem corporis sit corrupti.",
"sign_method": "canvas",
"signing_settings": {
"expires_at": "1999-12-16T05:23:15+00:00",
"sender_name": "John Doe",
"message": "Qui ad et consectetur non repudiandae aliquam.",
"reminders_start": "2015-04-29T17:17:31+00:00",
"reminders_end": "1996-07-19T22:09:32+00:00",
"reminders_duration": "P3D"
}
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"download_url": "Repudiandae ex quidem magni sunt ea ipsa.",
"id": "DmEddV",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Occaecati recusandae quibusdam.",
"description": "Expedita voluptatibus pariatur magni esse nihil voluptates.",
"archive_status": "completed",
"contains_pii": "contains_pii",
"contract_id": "ZAQy0k",
"contract": {
"_type": "contract",
"id": "aLWkvB",
"name": "Culpa quidem qui ratione assumenda.",
"stage": "Sed repellendus adipisci fugit quaerat.",
"document_id": "1DM7aR",
"sign_method": "strong",
"template_id": "Eos iste sit quod cum enim dolor eos quidem.",
"template": {
"id": "NnvnVmy",
"name": "Dolorem nostrum magnam et libero reprehenderit.",
"description": "Magnam aut ut in ad.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "aEervb",
"display_name": "Quo facilis deserunt totam dolores.",
"first_name": "Nesciunt voluptas assumenda ullam qui non rem placeat.",
"last_name": "Ut nisi at quis facere consequatur est veritatis.",
"email": "lila.keeling@gmail.com",
"language": "de"
},
"signing_settings": {
"id": "OyBxKD",
"created_at": "1984-08-17T06:16:03+00:00",
"updated_at": "1979-06-05T13:15:38+00:00",
"contract_id": "0vbRyJv",
"message": "Sequi consequatur rem distinctio voluptas.",
"expires_at": "2012-02-25T20:53:52+00:00",
"reminders_start": "2013-09-11T07:03:39+00:00",
"reminders_end": "2021-06-12T20:47:55+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "x1kdN1",
"folder": {
"_type": "folder",
"id": "gQmbbYW",
"name": "Eos autem et quia.",
"created_at": "2020-02-11T09:17:41+00:00",
"updated_at": "1976-11-08T20:25:57+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "49vJ2q",
"name": "Dolor quidem magnam tempora velit.",
"created_at": "1999-09-16T15:25:05+00:00",
"updated_at": "1997-02-03T10:43:57+00:00",
"parent_id": "0ZABao",
"has_children": true
}
},
"owner_id": "zOwqoZ",
"owner": {
"id": "oy1rrM",
"display_name": "Sed nemo id commodi quibusdam.",
"first_name": "Nihil ut consequuntur autem officiis.",
"last_name": "Non dicta aut debitis eveniet.",
"email": "jamir31@yahoo.com",
"language": "de"
},
"workspace_id": "eDJ0a1",
"workspace": {
"_type": "workspace",
"id": "aB3wQO",
"name": "Distinctio excepturi voluptates molestiae qui nihil consequuntur.",
"company_ident": "Aut rerum enim rerum nihil.",
"email": "wisozk.chanel@gmail.com",
"root_folder_id": "aLxzra"
},
"file_id": "OoQ4NM",
"file": {
"_type": "file",
"id": "ek735w2",
"filename": "Quaerat laudantium odit occaecati perferendis doloremque voluptatem nesciunt.",
"size": 36.483707,
"mime": "Quidem consequatur odio quaerat nihil.",
"download_url": "http://kutch.info/",
"preview_url": "http://www.doyle.com/"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "DQG13a",
"value": true,
"property_id": "eDJ0a1",
"property": {
"id": "aP36qZ",
"title": "Autem aut veritatis consequuntur nostrum ipsa.",
"description": "Et sed voluptatum eius sed vero aut.",
"name": "Necessitatibus delectus cumque distinctio nam vel impedit dolorum.",
"source": "system",
"data_type": "date",
"workspace_id": "AXqX6b",
"workspace": {
"_type": "workspace",
"id": "3w2dNY",
"name": "Repellat sed qui cumque veniam quibusdam optio at voluptate.",
"company_ident": "Veritatis sed corrupti id placeat voluptatem voluptas.",
"email": "huels.jamaal@yahoo.com",
"root_folder_id": "vOx5GD"
}
}
}
],
"date_values": [
{
"id": "DQNbLj",
"value": "2022-06-24T10:02:36+00:00",
"duration": "P1D",
"basis": "Nobis est est reprehenderit libero accusamus et odio quos.",
"property_id": "8p2poLV",
"property": {
"id": "Wxo9Yn",
"title": "Sint molestiae aut eveniet exercitationem aliquid.",
"description": "Dicta neque corporis qui iste odio.",
"name": "Molestias molestias dolorem nemo blanditiis.",
"source": "system",
"data_type": "string",
"workspace_id": "aP5nLM",
"workspace": {
"_type": "workspace",
"id": "E871j7",
"name": "Et ullam rem voluptatem et.",
"company_ident": "Voluptatem ratione sint dolor eius.",
"email": "brent86@feest.com",
"root_folder_id": "PZprO0"
}
}
}
],
"numeric_values": [
{
"id": "REol0e",
"value": 28,
"unit": "Odio sit saepe cum natus.",
"property_id": "ZlMEya",
"property": {
"id": "3YzGW4",
"title": "Et sapiente dolores itaque quae nam.",
"description": "Qui voluptatem minus et corporis fugiat quia.",
"name": "Voluptatem ut dicta nobis omnis.",
"source": "system",
"data_type": "boolean",
"workspace_id": "MDWqEa",
"workspace": {
"_type": "workspace",
"id": "DdlXvd",
"name": "Odit non similique at pariatur fuga illum modi.",
"company_ident": "Qui ullam praesentium iusto qui.",
"email": "rodger31@jenkins.com",
"root_folder_id": "Ox92Q9"
}
}
}
],
"string_values": [
{
"id": "LDQ3aq",
"value": "Et aut sequi error sed qui incidunt est.",
"property_id": "ORkEpD",
"property": {
"id": "LDQ3aq",
"title": "Natus eos maxime mollitia qui eveniet itaque.",
"description": "Cum quo iure earum ipsum sunt aut eum laborum.",
"name": "Reprehenderit facilis rerum illum ipsa.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "O4MMAD",
"workspace": {
"_type": "workspace",
"id": "gD6jjD",
"name": "Voluptatem asperiores quis eum quia perspiciatis excepturi vero et.",
"company_ident": "Nisi ut velit sint dolorem non neque sint.",
"email": "lourdes.pfannerstill@blanda.com",
"root_folder_id": "Z3vvPD"
}
}
}
],
"jurisdictions": [
{
"id": "aePrwZ",
"code": "Architecto qui est quia tenetur rerum rerum."
}
],
"document_types": [
{
"_type": "document_type",
"id": "Yy7yx7",
"name": "Saepe vitae nemo molestiae doloremque qui perspiciatis provident qui."
}
],
"parties": [
{
"id": "YZ9yWZ",
"first_name": "Qui aut ea reiciendis perspiciatis vel.",
"last_name": "Explicabo et vero quidem quo.",
"email": "rklein@wiza.com",
"phone": "Nisi ut quia sapiente voluptatem quia recusandae ea delectus.",
"title": "Quis molestias ut deserunt suscipit unde iure debitis et.",
"company_name": "Laborum minus similique dolor nulla qui.",
"company_ident": "Quia ad mollitia modi porro fuga et.",
"address_id": "Wx6jMlJ",
"address": {
"id": "0ZABao",
"address_type": "Nesciunt quas sunt ad quis.",
"address_lines": "Tenetur aut qui non.",
"city": "Explicabo quae qui qui eveniet quidem ut.",
"locality": "Occaecati ad natus natus minus et.",
"administrative_area": "Autem nostrum illo soluta velit nemo.",
"post_code": "Et qui in error.",
"country": "Blanditiis aut aliquam quod autem quas."
},
"external_references": [
{
"id": "NDkdZo",
"name": "Illo natus minus vel officiis sed.",
"title": "Rem accusantium iusto fugiat omnis nihil omnis molestiae aliquam.",
"value": "Aut et blanditiis unde."
}
]
}
],
"reminders": [
{
"id": "aEq1ra",
"event_type": "document.reminder",
"title": "Sed ipsa quo accusantium autem iusto voluptates pariatur."
}
],
"attachments": [
{
"id": "eDJ92O",
"created_at": "2006-12-05T03:25:21+00:00",
"updated_at": "1999-07-20T04:20:18+00:00",
"file_id": "ZXrNPO",
"file": {
"_type": "file",
"id": "ml5bBn",
"filename": "example.pdf",
"size": 7.832,
"mime": "application/pdf",
"download_url": "http://mante.com/repudiandae-voluptatibus-natus-facilis-exercitationem-et-voluptas-temporibus-corporis.html",
"preview_url": "http://metz.net/aut-laudantium-distinctio-sit-minima-aut.html"
}
}
],
"external_references": [
{
"id": "DJLzEa",
"name": "Quia nostrum quos molestiae quia ducimus voluptate occaecati ab.",
"title": "Quia quisquam voluptas quia sed.",
"value": "Quae eaque deserunt voluptas ipsum accusamus."
}
],
"tags": [
{
"tag": "Ut corrupti aut sit suscipit repellat."
}
],
"terms_and_conditions": {
"date": "1995-10-28T05:30:33+00:00",
"effective_date": "2015-03-29T15:00:27+00:00",
"term_end_date": "2020-06-05T06:29:04+00:00",
"signing_date": "1978-04-09T13:12:30+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
},
"retention": {
"end_date": "1982-05-21T14:03:38+00:00"
},
"breadcrumb": [
{
"id": "ED5VXZ",
"name": "Repellendus autem sint ea.",
"depth": 1665019
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document - Reminders
API methods for managing various reminders related to a document
List reminders
requires authentication
List reminder associated witht a document.
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/ZKW9K4/reminders" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/ZKW9K4/reminders"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/ZKW9K4/reminders';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/ZKW9K4/reminders'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"id": "ekmlAmL",
"event_type": "document.reminder",
"title": "Non voluptas ea laudantium nihil hic ad.",
"document": {
"download_url": "Quo quis sed dolores quis.",
"id": "X7GEr9",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Quia consequatur repudiandae.",
"description": "Aut perspiciatis eligendi quos ab quasi.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "ZX7rdD",
"contract": {
"_type": "contract",
"id": "DkmW04",
"name": "Nemo laudantium est veritatis.",
"stage": "Iste maxime sit culpa animi qui consequuntur rem.",
"document_id": "OxdB4O",
"sign_method": "canvas",
"template_id": "Vel autem ut expedita nam modi.",
"template": {
"id": "PvG3MY",
"name": "Repudiandae optio ab doloribus dolores non libero.",
"description": "Dolorum aperiam unde vel quasi.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "a2pd1n",
"display_name": "Recusandae omnis fuga libero est consequatur dolores sint.",
"first_name": "Dolores minima voluptas amet explicabo ea quaerat.",
"last_name": "Voluptates asperiores ratione aut esse placeat occaecati sit ipsam.",
"email": "purdy.ericka@klein.com",
"language": "pl"
},
"is_paid": true,
"signing_settings": {
"id": "MLybLek",
"created_at": "2010-08-28T01:35:59+00:00",
"updated_at": "2011-05-24T07:28:05+00:00",
"contract_id": "DWLb4E",
"message": "Saepe voluptatibus ut sed.",
"expires_at": "1972-06-03T06:34:11+00:00",
"reminders_start": "1972-09-05T20:46:40+00:00",
"reminders_end": "1977-08-11T04:19:41+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "Ddo4W0",
"folder": {
"_type": "folder",
"id": "ZNwJB5",
"name": "Id sit nihil laboriosam voluptatem aut et.",
"created_at": "1983-08-12T16:55:50+00:00",
"updated_at": "2013-07-27T13:20:20+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "nJAEqv",
"name": "Ut facilis rem at qui.",
"created_at": "1998-10-03T22:00:35+00:00",
"updated_at": "1971-10-01T22:11:51+00:00",
"parent_id": "0ZABao",
"has_children": true
}
},
"owner_id": "ObMena",
"owner": {
"id": "GR7RrR",
"display_name": "Explicabo dolorem cupiditate consectetur ut eum omnis facilis possimus.",
"first_name": "Enim aut ad facere ullam sit et ea libero.",
"last_name": "Harum et et est.",
"email": "madge75@gulgowski.biz",
"language": "fi"
},
"workspace_id": "DJW4d0",
"workspace": {
"_type": "workspace",
"id": "mO7k4O",
"name": "Omnis eos totam aut odit.",
"company_ident": "Quo dolorum esse dolorum mollitia non molestiae ab.",
"email": "haltenwerth@klocko.info",
"root_folder_id": "NObxZW"
},
"file_id": "8OvN3O",
"file": {
"_type": "file",
"id": "wOywZL",
"filename": "Eos laudantium quae ut velit id.",
"size": 390982981.94439,
"mime": "Aut qui expedita fuga dignissimos amet accusantium dolor voluptatem.",
"download_url": "https://schmeler.com/delectus-omnis-eos-non-ducimus-corporis.html",
"preview_url": "http://www.pouros.com/magnam-blanditiis-qui-similique-aut-beatae-voluptatibus-sit"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "jZN4WO",
"property_id": "BaEMaV",
"property": {
"id": "jZNWao",
"title": "Ut exercitationem dolores voluptas nemo dolores repellendus.",
"description": "Dicta sed eos at alias sed veniam qui.",
"name": "Ea adipisci rerum dolor eos ut minus et.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "Ob6Bgw",
"workspace": {
"_type": "workspace",
"id": "BZ3dJa",
"name": "Consectetur quaerat et doloribus maxime quos voluptas debitis.",
"company_ident": "Praesentium quos qui quia rerum consectetur.",
"email": "rosenbaum.antonia@gaylord.com",
"root_folder_id": "ZA6VPa"
}
}
}
],
"date_values": [
{
"id": "MK01AA",
"value": "2002-01-01T08:49:01+00:00",
"duration": "P1D",
"basis": "Et maxime qui quibusdam maxime esse quia molestiae blanditiis.",
"property_id": "ZXrXmO",
"property": {
"id": "NObxZW",
"title": "Omnis dolore maxime exercitationem.",
"description": "Rerum cupiditate ut perferendis molestiae quisquam quam id.",
"name": "Et voluptas aperiam quam reiciendis.",
"source": "system",
"data_type": "string",
"workspace_id": "DmPd7O",
"workspace": {
"_type": "workspace",
"id": "mOov2a",
"name": "Velit et dolores distinctio ullam nobis rem dolor.",
"company_ident": "Esse illum corrupti laborum expedita odit.",
"email": "albin.roob@yahoo.com",
"root_folder_id": "wOywZL"
}
}
}
],
"numeric_values": [
{
"id": "Ma2naY",
"value": 23683475.851952653,
"unit": "Expedita rerum saepe aut eos est temporibus.",
"property_id": "E8E3q2",
"property": {
"id": "eDJ0a1",
"title": "Ea ad dicta aut et et qui.",
"description": "Sed quos nihil hic eveniet accusantium.",
"name": "Quae ut quos ipsam facilis.",
"source": "system",
"data_type": "boolean",
"workspace_id": "vOxVqZ",
"workspace": {
"_type": "workspace",
"id": "NDkeda",
"name": "Quam minima cumque recusandae maxime.",
"company_ident": "Aut sunt veniam tempora.",
"email": "rebekah.roberts@hotmail.com",
"root_folder_id": "wOylqa"
}
}
}
],
"string_values": [
{
"id": "a2p90D",
"value": "Temporibus qui soluta molestiae veniam unde.",
"property_id": "KLo5Qw",
"property": {
"id": "zOwqoZ",
"title": "Neque veniam itaque libero autem.",
"description": "Qui qui sapiente quos.",
"name": "Voluptatem nam sit assumenda dolorum et ex sequi.",
"source": "system",
"data_type": "date",
"workspace_id": "a2bVx4",
"workspace": {
"_type": "workspace",
"id": "wOywZL",
"name": "Sunt omnis rem consequatur fuga.",
"company_ident": "Earum nam suscipit provident maxime voluptatem.",
"email": "geoffrey.baumbach@casper.biz",
"root_folder_id": "wOymbO"
}
}
}
],
"jurisdictions": [
{
"id": "PznJeW",
"code": "Hic in occaecati animi ut deleniti."
}
],
"document_types": [
{
"_type": "document_type",
"id": "ZA6Yka",
"name": "Adipisci qui autem quia id natus corporis."
}
],
"parties": [
{
"id": "RZX9ma",
"first_name": "Quod dolores ut voluptatem voluptates.",
"last_name": "Possimus quia rerum ut aut animi.",
"email": "danial.dicki@adams.com",
"phone": "Magni voluptatem perspiciatis officia enim labore.",
"title": "Quae aut excepturi eaque similique aspernatur culpa quam.",
"company_name": "Sit sint officia accusamus esse.",
"company_ident": "Praesentium voluptates autem alias nostrum.",
"address_id": "Ma2naY",
"address": {
"id": "vZr97D",
"address_type": "Sit aut maiores expedita dolorem.",
"address_lines": "Possimus deleniti quo maiores molestiae est.",
"city": "Qui omnis ea distinctio voluptas.",
"locality": "Nobis enim odio aliquam fugiat expedita minus.",
"administrative_area": "Dicta tempora fugiat provident voluptatem.",
"post_code": "Omnis quia molestiae non repellat.",
"country": "Nihil eum et velit ducimus quod at debitis."
},
"external_references": [
{
"id": "aB4LGN",
"name": "Reprehenderit eos voluptates illo.",
"title": "Rerum ad dolor et neque et excepturi rerum aliquid.",
"value": "Est culpa animi cupiditate optio totam."
}
]
}
],
"attachments": [
{
"id": "Rn4KJp",
"created_at": "2010-10-01T03:44:53+00:00",
"updated_at": "1976-12-10T05:00:22+00:00",
"file_id": "OxQ1GD",
"file": {
"_type": "file",
"id": "eDJb0D",
"filename": "example.pdf",
"size": 675093677.7399,
"mime": "application/pdf",
"download_url": "http://hirthe.com/cumque-et-sit-et-sed",
"preview_url": "https://jacobson.com/debitis-voluptates-aliquid-beatae-alias-magnam-rerum-quia-architecto.html"
}
}
],
"external_references": [
{
"id": "ervBj5",
"name": "Quam molestiae est distinctio labore.",
"title": "Consequuntur dolorum ea ad temporibus.",
"value": "Sed qui delectus mollitia commodi."
}
],
"tags": [
{
"tag": "Voluptatem iure quas ut omnis."
}
],
"terms_and_conditions": {
"date": "1978-08-10T14:41:12+00:00",
"effective_date": "2004-11-18T14:23:20+00:00",
"term_end_date": "2016-02-21T00:29:46+00:00",
"signing_date": "1981-06-30T08:44:36+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
},
"retention": {
"end_date": "2009-06-01T19:38:47+00:00"
},
"breadcrumb": [
{
"id": "aLrVxy",
"name": "Voluptatem rerum ex sit et consequatur reprehenderit est.",
"depth": 15
}
]
}
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new reminder
requires authentication
Example request:
curl --request POST \
"https://api.docue.com/public/v2/documents/a2b3Wa/reminders" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"event_type\": \"document.reminder\",
\"title\": \"Corrupti qui aliquam ipsum voluptatem nobis dolore in.\",
\"schedules\": [
{
\"next_run\": \"1985-11-20T05:26:23+00:00\",
\"id\": \"yAvYEm5\",
\"last_run\": \"2023-10-27T18:01:53+00:00\",
\"interval\": 85
}
],
\"recipients\": [
{
\"value\": \"john.doe@doe.com\",
\"channel\": \"email\",
\"language\": \"pl\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/a2b3Wa/reminders"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"event_type": "document.reminder",
"title": "Corrupti qui aliquam ipsum voluptatem nobis dolore in.",
"schedules": [
{
"next_run": "1985-11-20T05:26:23+00:00",
"id": "yAvYEm5",
"last_run": "2023-10-27T18:01:53+00:00",
"interval": 85
}
],
"recipients": [
{
"value": "john.doe@doe.com",
"channel": "email",
"language": "pl"
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/a2b3Wa/reminders';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'event_type' => 'document.reminder',
'title' => 'Corrupti qui aliquam ipsum voluptatem nobis dolore in.',
'schedules' => [
[
'next_run' => '1985-11-20T05:26:23+00:00',
'id' => 'yAvYEm5',
'last_run' => '2023-10-27T18:01:53+00:00',
'interval' => 85,
],
],
'recipients' => [
[
'value' => 'john.doe@doe.com',
'channel' => 'email',
'language' => 'pl',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/a2b3Wa/reminders'
payload = {
"event_type": "document.reminder",
"title": "Corrupti qui aliquam ipsum voluptatem nobis dolore in.",
"schedules": [
{
"next_run": "1985-11-20T05:26:23+00:00",
"id": "yAvYEm5",
"last_run": "2023-10-27T18:01:53+00:00",
"interval": 85
}
],
"recipients": [
{
"value": "john.doe@doe.com",
"channel": "email",
"language": "pl"
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "8OvPZK",
"event_type": "document.reminder",
"title": "Quia voluptas placeat et quod facilis.",
"document": {
"download_url": "Cumque sint totam autem corporis cumque.",
"id": "2O40JO",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Enim eum aut eius.",
"description": "Maxime nostrum voluptatem aliquid tempora.",
"archive_status": "completed",
"contains_pii": "contains_pii",
"contract_id": "7ajJva",
"contract": {
"_type": "contract",
"id": "G2yQlo0",
"name": "Laudantium architecto voluptas explicabo doloribus autem asperiores atque.",
"stage": "Ea ut earum quis sunt.",
"document_id": "eDJ0a1",
"sign_method": "strong",
"template_id": "Tempore nihil exercitationem beatae quia.",
"template": {
"id": "1DM7aR",
"name": "Aut fugiat voluptatum est ipsum expedita quia repellendus.",
"description": "Et aliquid sed voluptatum ducimus iure voluptas ea.",
"type": "tailored"
},
"user": {
"id": "ZAX89D",
"display_name": "Officiis minima animi adipisci quam aliquid.",
"first_name": "Repellat ipsam qui incidunt est.",
"last_name": "Dolore et id quasi accusamus nam aut fugiat.",
"email": "rempel.dillan@yahoo.com",
"language": "pl"
},
"signing_settings": {
"id": "bj9P5R",
"created_at": "1989-12-14T07:56:49+00:00",
"updated_at": "1976-01-10T14:23:53+00:00",
"contract_id": "Q3Kx77",
"message": "Qui porro eveniet earum.",
"expires_at": "2021-08-10T21:55:45+00:00",
"reminders_start": "1993-02-23T02:15:47+00:00",
"reminders_end": "1986-01-13T02:56:51+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "O77Go4",
"folder": {
"_type": "folder",
"id": "LDQ3aq",
"name": "Id ea ullam vel perferendis consequatur eos.",
"created_at": "1972-02-15T13:02:25+00:00",
"updated_at": "1996-12-17T09:58:02+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "aEwE2D",
"name": "Repellat odio alias id.",
"created_at": "2003-04-28T01:08:13+00:00",
"updated_at": "1991-06-09T04:42:27+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "BaE2YO",
"owner": {
"id": "D6KK4Y",
"display_name": "Quia corrupti fugiat ut hic dolorem a.",
"first_name": "Aut odio modi quis consequatur ipsum omnis.",
"last_name": "Est consequatur voluptatem et qui dolores dignissimos numquam qui.",
"email": "ward.sandra@yahoo.com",
"language": "pl"
},
"workspace_id": "5KBbVnq",
"workspace": {
"_type": "workspace",
"id": "Z3lAJa",
"name": "Ut consequatur modi vel.",
"company_ident": "Asperiores aliquid delectus et non numquam inventore.",
"email": "jameson33@yahoo.com",
"root_folder_id": "4WLpbN"
},
"file_id": "Jx97BpX",
"file": {
"_type": "file",
"id": "PZpNdO",
"filename": "Fuga dolor ex maxime ad aperiam quis.",
"size": 6.9,
"mime": "Aspernatur excepturi quo minima dolor.",
"download_url": "http://www.bauch.com/rem-distinctio-quaerat-accusantium-error",
"preview_url": "http://rolfson.com/"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "NDkbdO",
"value": true,
"property_id": "gD67jZ",
"property": {
"id": "KOqvoD",
"title": "Ex deserunt modi neque.",
"description": "Esse repudiandae dignissimos esse animi aut neque vel.",
"name": "Est laudantium dolorum tempora accusantium.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "wOyNwD",
"workspace": {
"_type": "workspace",
"id": "gD66WD",
"name": "Voluptatibus perferendis ut suscipit quaerat delectus quam.",
"company_ident": "Sit nostrum enim incidunt ea nobis necessitatibus ipsa aut.",
"email": "qstreich@gmail.com",
"root_folder_id": "nJ2m86"
}
}
}
],
"date_values": [
{
"id": "0ZABao",
"value": "1997-07-01T10:58:47+00:00",
"duration": "P1D",
"basis": "Totam rerum totam nesciunt earum aut sapiente accusantium.",
"property_id": "YZ9NAa",
"property": {
"id": "OoRyYa",
"title": "Hic sunt quia eius voluptatem vero in consequatur alias.",
"description": "Sint est quas fuga repellat fugiat accusamus.",
"name": "Provident aut eos dicta explicabo.",
"source": "system",
"data_type": "string",
"workspace_id": "RNA5ze",
"workspace": {
"_type": "workspace",
"id": "NObxZW",
"name": "Earum velit velit ut.",
"company_ident": "Id eos libero nihil sit et deleniti eum.",
"email": "kassulke.julian@quitzon.biz",
"root_folder_id": "wOylqa"
}
}
}
],
"numeric_values": [
{
"id": "Dmp6dm",
"value": 87060888.1336495,
"unit": "In corporis consectetur aut non qui sit.",
"property_id": "Znorva",
"property": {
"id": "gPJ4xmk",
"title": "Voluptatem animi sunt non corporis.",
"description": "Sed eligendi cumque facilis earum totam voluptas.",
"name": "Autem accusamus facilis temporibus dolorem voluptatem doloremque non ea.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "XrEKmB",
"workspace": {
"_type": "workspace",
"id": "OxkYyA",
"name": "Enim et quia sunt ut.",
"company_ident": "Quis totam eum molestias ut enim soluta omnis.",
"email": "emmy.stamm@yahoo.com",
"root_folder_id": "oaz4ED"
}
}
}
],
"string_values": [
{
"id": "0ZAA2Z",
"value": "Et delectus assumenda non odit est explicabo non.",
"property_id": "ZA7APO",
"property": {
"id": "DQGdy7",
"title": "Sit repudiandae in dolor esse.",
"description": "Veniam fugiat rerum totam error nihil.",
"name": "Pariatur dolorum accusantium ea unde.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "ObmGv4",
"workspace": {
"_type": "workspace",
"id": "YqoLQkj",
"name": "Aut et quisquam soluta est.",
"company_ident": "Facilis velit temporibus laboriosam doloribus sunt qui.",
"email": "beatrice.friesen@hotmail.com",
"root_folder_id": "eDJ0a1"
}
}
}
],
"jurisdictions": [
{
"id": "xKk2R4",
"code": "Et laudantium enim eius et aut nostrum."
}
],
"document_types": [
{
"_type": "document_type",
"id": "ZAAN2Z",
"name": "Dolore molestias omnis officia est qui tenetur."
}
],
"parties": [
{
"id": "qoWB79o",
"first_name": "Cumque accusamus ea quis eaque.",
"last_name": "Sapiente porro magnam et expedita doloribus dolore.",
"email": "dubuque.claud@ondricka.info",
"phone": "Blanditiis deleniti cupiditate repellendus itaque nemo voluptatem deserunt.",
"title": "Dolorem itaque qui libero dolorem ea vel.",
"company_name": "Sed qui harum suscipit rerum occaecati.",
"company_ident": "Eos autem et quia recusandae omnis quos eos.",
"address_id": "8p5WxxE",
"address": {
"id": "jnWgwo9",
"address_type": "Non cupiditate voluptas temporibus.",
"address_lines": "Rem quisquam voluptatibus quis facere est fugit voluptates.",
"city": "Sit est deleniti dolorum sunt in repellendus.",
"locality": "Qui aliquid veniam a consequatur aut laboriosam iusto.",
"administrative_area": "Qui ipsam sit voluptate rerum minima et.",
"post_code": "Aut voluptas et quos.",
"country": "Consequatur consectetur recusandae sed mollitia."
},
"external_references": [
{
"id": "D67WYZ",
"name": "Temporibus voluptatem debitis doloremque dolore.",
"title": "Consectetur est asperiores est sed provident nam facere.",
"value": "Id in qui eaque odit aspernatur."
}
]
}
],
"attachments": [
{
"id": "PVN9Rq",
"created_at": "1990-08-17T05:22:44+00:00",
"updated_at": "1994-03-02T21:55:07+00:00",
"file_id": "DkeLqk",
"file": {
"_type": "file",
"id": "LQmRNQ",
"filename": "example.pdf",
"size": 0.5893,
"mime": "application/pdf",
"download_url": "http://www.kilback.info/et-quisquam-officiis-et-ut-vel-vel",
"preview_url": "http://bogan.net/nulla-est-sint-aperiam-architecto"
}
}
],
"external_references": [
{
"id": "L7kwMjB",
"name": "Est autem non qui eligendi et quaerat.",
"title": "Et repellat ut numquam unde.",
"value": "Qui mollitia voluptatem eius sed nostrum."
}
],
"tags": [
{
"tag": "Soluta deserunt et est dolor officiis voluptas totam ducimus."
}
],
"terms_and_conditions": {
"date": "1991-08-18T06:36:11+00:00",
"effective_date": "2015-07-20T09:48:34+00:00",
"term_end_date": "1970-03-24T16:34:46+00:00",
"signing_date": "2021-05-20T10:10:51+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "2021-11-18T22:42:10+00:00"
},
"breadcrumb": [
{
"id": "Z8W4ED",
"name": "Autem at voluptatum laborum temporibus ea.",
"depth": 289437982
}
]
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get reminder data
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/Qdne4R/reminders/MNEldqA" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/Qdne4R/reminders/MNEldqA"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/Qdne4R/reminders/MNEldqA';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/Qdne4R/reminders/MNEldqA'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "D6L56G",
"event_type": "document.reminder",
"title": "Et consectetur assumenda voluptas nihil explicabo aut necessitatibus.",
"document": {
"download_url": "Et consequatur omnis laboriosam vel beatae consequatur ipsum impedit.",
"id": "wA5Nry",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Repellat saepe non.",
"description": "Magni nobis temporibus non illo esse.",
"archive_status": "completed",
"contains_pii": "contains_pii",
"contract_id": "Ma2naY",
"contract": {
"_type": "contract",
"id": "zOwv8a",
"name": "Expedita sapiente et id.",
"stage": "Incidunt non eos qui asperiores id doloribus.",
"document_id": "JZnQDl",
"sign_method": "canvas",
"template_id": "Et sed assumenda itaque est ipsum voluptates facilis.",
"template": {
"id": "0ZABao",
"name": "Accusantium omnis quis nesciunt nostrum nobis.",
"description": "Qui sit dolor est ut explicabo qui ex.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "LDQplO",
"display_name": "Est repudiandae sunt nobis alias et sit temporibus.",
"first_name": "Sequi odio itaque qui et.",
"last_name": "Harum delectus temporibus rerum atque.",
"email": "voberbrunner@daniel.com",
"language": "en"
},
"is_paid": true,
"signing_settings": {
"id": "WaBlND",
"created_at": "2009-12-19T23:45:01+00:00",
"updated_at": "2001-12-10T02:20:23+00:00",
"contract_id": "MLXLVJ",
"message": "Numquam modi officia id rem minus.",
"expires_at": "1977-05-23T19:03:14+00:00",
"reminders_start": "2018-01-14T05:38:02+00:00",
"reminders_end": "1978-02-12T18:02:55+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "DkLozZ",
"folder": {
"_type": "folder",
"id": "gw5KAz",
"name": "Officiis debitis aliquid rerum soluta ducimus.",
"created_at": "1986-07-07T01:28:34+00:00",
"updated_at": "1983-12-16T07:24:42+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "pBNG5zy",
"name": "Sit et aliquid suscipit repudiandae nulla ad et.",
"created_at": "1983-10-13T06:06:53+00:00",
"updated_at": "2004-11-13T13:07:27+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "Ma2naY",
"owner": {
"id": "NDkdZo",
"display_name": "Molestiae ullam doloribus consequatur facere quia rem.",
"first_name": "Ipsam dolorem quia veniam dicta illum facere.",
"last_name": "Et eum recusandae explicabo incidunt eligendi neque voluptatum a.",
"email": "makenna16@gmail.com",
"language": "pl"
},
"workspace_id": "NObBxO",
"workspace": {
"_type": "workspace",
"id": "vZrWAa",
"name": "Expedita ut qui recusandae unde repellendus impedit.",
"company_ident": "Ex recusandae tempora natus sapiente et minus.",
"email": "tina59@gmail.com",
"root_folder_id": "a0llKa"
},
"file_id": "DMLYjO",
"file": {
"_type": "file",
"id": "NDkdZo",
"filename": "Facere dignissimos est magnam eum consequatur suscipit rerum.",
"size": 55690.94989162,
"mime": "Libero consequatur nemo maiores distinctio sunt.",
"download_url": "http://www.walker.com/fugiat-officiis-omnis-nobis-rem-ipsa",
"preview_url": "http://parker.info/quam-quo-nihil-id-unde-quam-qui.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "ZrPjEy",
"value": true,
"property_id": "NObxZW",
"property": {
"id": "EDYE2D",
"title": "Nobis suscipit magni ducimus atque beatae quibusdam.",
"description": "Vel commodi iusto rerum quae.",
"name": "Sapiente amet et inventore quaerat quaerat hic.",
"source": "system",
"data_type": "numeric",
"workspace_id": "1DM7aR",
"workspace": {
"_type": "workspace",
"id": "Z8eLV3",
"name": "Porro dolor neque excepturi in aut.",
"company_ident": "Consequuntur sed voluptatem maiores facere ea possimus maiores.",
"email": "jhackett@oconnell.org",
"root_folder_id": "DMvYqj"
}
}
}
],
"date_values": [
{
"id": "YZ9GWO",
"value": "1998-08-30T06:05:21+00:00",
"duration": "P1D",
"basis": "Nostrum voluptatum eius rem inventore nisi ducimus nemo doloremque.",
"property_id": "5bj0wx",
"property": {
"id": "ZgQ4lY",
"title": "Debitis quo earum nesciunt et.",
"description": "Blanditiis non nulla sed veritatis saepe neque.",
"name": "Voluptas repudiandae nemo non nisi.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "exXn6E",
"workspace": {
"_type": "workspace",
"id": "Dd3KeO",
"name": "Earum nemo aut tempora rerum fugiat sint sit.",
"company_ident": "Voluptatum deserunt qui nostrum deleniti.",
"email": "quigley.juwan@hahn.biz",
"root_folder_id": "B3BjQy"
}
}
}
],
"numeric_values": [
{
"id": "ZAk6Y9",
"value": 14.49,
"unit": "Nihil assumenda labore in aut.",
"property_id": "8Ov9Pa",
"property": {
"id": "1DM7aR",
"title": "Quam saepe incidunt in inventore quaerat.",
"description": "Esse dolor et animi harum possimus.",
"name": "Perspiciatis quia est saepe vero quia atque.",
"source": "system",
"data_type": "string",
"workspace_id": "Zl214O",
"workspace": {
"_type": "workspace",
"id": "eDJ8Aa",
"name": "Atque est dicta rerum aut similique reprehenderit ea.",
"company_ident": "Dolor sit quibusdam consequuntur.",
"email": "keyon63@yahoo.com",
"root_folder_id": "Dke2Qx"
}
}
}
],
"string_values": [
{
"id": "Z3A5YO",
"value": "Atque repellendus ab asperiores molestiae et.",
"property_id": "vZr1vD",
"property": {
"id": "pZGdwa",
"title": "Est et fugiat maiores dolor rerum velit facere.",
"description": "Repellat suscipit voluptate dolores est.",
"name": "Recusandae sapiente nobis quasi nesciunt porro quas harum.",
"source": "system",
"data_type": "date",
"workspace_id": "gD67jZ",
"workspace": {
"_type": "workspace",
"id": "Ma2naY",
"name": "Molestias deleniti aut ut similique.",
"company_ident": "Qui sed et ut magnam ut aliquid fugit.",
"email": "huels.fritz@von.org",
"root_folder_id": "LDQ3aq"
}
}
}
],
"jurisdictions": [
{
"id": "2ZlLRZ",
"code": "Amet ut numquam fuga est et dolores est."
}
],
"document_types": [
{
"_type": "document_type",
"id": "aPMr1O",
"name": "Sit saepe est dolor blanditiis ea explicabo dolor."
}
],
"parties": [
{
"id": "m4Kp9pe",
"first_name": "Quod reprehenderit debitis dolorem fugiat est aut.",
"last_name": "Ullam qui et occaecati asperiores maxime minima.",
"email": "wyman.imani@prosacco.com",
"phone": "Reiciendis aut doloremque minus.",
"title": "Asperiores officia assumenda ex consectetur error neque.",
"company_name": "Modi voluptas natus natus sit.",
"company_ident": "Voluptatem atque veniam eum perspiciatis voluptas sed modi debitis.",
"address_id": "vOx5GD",
"address": {
"id": "7ajzKa",
"address_type": "Quia at quidem consequuntur accusantium repudiandae necessitatibus et.",
"address_lines": "Quidem in esse suscipit magni pariatur delectus veniam ea.",
"city": "Doloremque ea ab quam omnis itaque.",
"locality": "Ipsum ea dolor eum at.",
"administrative_area": "Eveniet perspiciatis et voluptatum consequatur nobis.",
"post_code": "Eveniet eligendi ipsum ab sit.",
"country": "Ratione doloribus vel animi neque reiciendis."
},
"external_references": [
{
"id": "Ma2pnD",
"name": "Voluptatem et qui est.",
"title": "Eos voluptatibus magni aperiam blanditiis saepe facere non.",
"value": "Nisi unde quod est inventore."
}
]
}
],
"attachments": [
{
"id": "wOywZL",
"created_at": "1983-03-19T00:53:19+00:00",
"updated_at": "1999-04-01T07:27:06+00:00",
"file_id": "Zg64zA",
"file": {
"_type": "file",
"id": "LDQ3aq",
"filename": "example.pdf",
"size": 8.326746,
"mime": "application/pdf",
"download_url": "http://www.pouros.com/quam-ducimus-tempore-voluptatem-architecto-ducimus-praesentium-voluptatem",
"preview_url": "https://www.harber.biz/autem-sed-ratione-qui-perspiciatis-aut-adipisci-id-quia"
}
}
],
"external_references": [
{
"id": "DYPXVO",
"name": "Sed saepe voluptas maxime consequatur nisi.",
"title": "Tempore eum rem at.",
"value": "Exercitationem eos porro deserunt et ratione laboriosam consequatur molestias."
}
],
"tags": [
{
"tag": "Iste vitae tenetur error."
}
],
"terms_and_conditions": {
"date": "2002-02-04T22:06:49+00:00",
"effective_date": "1970-03-05T00:21:35+00:00",
"term_end_date": "2025-11-04T14:17:53+00:00",
"signing_date": "1974-12-18T19:44:48+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
},
"retention": {
"end_date": "1990-02-21T22:01:38+00:00"
},
"breadcrumb": [
{
"id": "7EVGqn",
"name": "Quia est id soluta veniam.",
"depth": 5
}
]
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a reminder
requires authentication
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/documents/5rqnKNx/reminders/DM62zJ" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"event_type\": \"document.reminder\",
\"title\": \"In illum autem est quo aut.\",
\"schedules\": [
{
\"next_run\": \"2017-01-12T16:24:20+00:00\",
\"id\": \"D5WvyL\",
\"last_run\": \"1976-10-18T01:59:27+00:00\",
\"interval\": 10183
}
],
\"recipients\": [
{
\"value\": \"john.doe@doe.com\",
\"channel\": \"email\",
\"language\": \"fi\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/5rqnKNx/reminders/DM62zJ"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"event_type": "document.reminder",
"title": "In illum autem est quo aut.",
"schedules": [
{
"next_run": "2017-01-12T16:24:20+00:00",
"id": "D5WvyL",
"last_run": "1976-10-18T01:59:27+00:00",
"interval": 10183
}
],
"recipients": [
{
"value": "john.doe@doe.com",
"channel": "email",
"language": "fi"
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/5rqnKNx/reminders/DM62zJ';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'event_type' => 'document.reminder',
'title' => 'In illum autem est quo aut.',
'schedules' => [
[
'next_run' => '2017-01-12T16:24:20+00:00',
'id' => 'D5WvyL',
'last_run' => '1976-10-18T01:59:27+00:00',
'interval' => 10183,
],
],
'recipients' => [
[
'value' => 'john.doe@doe.com',
'channel' => 'email',
'language' => 'fi',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/5rqnKNx/reminders/DM62zJ'
payload = {
"event_type": "document.reminder",
"title": "In illum autem est quo aut.",
"schedules": [
{
"next_run": "2017-01-12T16:24:20+00:00",
"id": "D5WvyL",
"last_run": "1976-10-18T01:59:27+00:00",
"interval": 10183
}
],
"recipients": [
{
"value": "john.doe@doe.com",
"channel": "email",
"language": "fi"
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "Oq2yoD",
"event_type": "document.reminder",
"title": "Odio blanditiis sed fugiat nisi culpa inventore.",
"document": {
"download_url": "Corrupti nisi aut sapiente est nam consequatur qui soluta.",
"id": "ZKBnnw",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Est dolor et.",
"description": "Molestiae cumque magni iste natus ipsum reprehenderit.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "1DMA7D",
"contract": {
"_type": "contract",
"id": "jZNG3a",
"name": "Libero nisi atque qui facilis.",
"stage": "Ducimus et odio magni provident ducimus totam culpa.",
"document_id": "ajz0ya",
"sign_method": "manual",
"template_id": "Culpa et cupiditate sed iusto.",
"template": {
"id": "6DdMjZ",
"name": "Nobis explicabo ullam eligendi aut ut.",
"description": "Quis aut aut harum debitis aliquid error rerum iure.",
"type": "tailored"
},
"user": {
"id": "DkLw4Z",
"display_name": "Id nesciunt ex inventore vel doloremque iusto modi.",
"first_name": "In quas et sit.",
"last_name": "Rem sint porro voluptas quia saepe delectus voluptate.",
"email": "therese27@gmail.com",
"language": "pl"
},
"signing_settings": {
"id": "DklyKZ",
"created_at": "1976-06-13T17:10:13+00:00",
"updated_at": "2008-01-16T22:46:14+00:00",
"contract_id": "PZprO0",
"message": "Neque incidunt nemo id fuga occaecati.",
"expires_at": "1996-09-24T03:57:19+00:00",
"reminders_start": "1980-01-29T20:50:36+00:00",
"reminders_end": "2015-10-23T22:04:32+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "ZK4qwa",
"folder": {
"_type": "folder",
"id": "O4NWNZ",
"name": "Nam tempore veritatis est soluta harum ullam nobis.",
"created_at": "2025-07-03T19:14:33+00:00",
"updated_at": "2019-11-16T00:03:44+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "aePQRE",
"name": "Temporibus exercitationem voluptatem qui consequatur mollitia.",
"created_at": "1994-09-28T22:48:13+00:00",
"updated_at": "2014-11-14T22:08:18+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "7ajvaP",
"owner": {
"id": "DQ9y6D",
"display_name": "Earum ut expedita eum possimus.",
"first_name": "Id ut sequi dolorem assumenda ipsum.",
"last_name": "Et asperiores praesentium molestiae sed sit voluptatem voluptatibus.",
"email": "uanderson@yahoo.com",
"language": "de"
},
"workspace_id": "BaEMaV",
"workspace": {
"_type": "workspace",
"id": "ZXmdma",
"name": "Quibusdam nisi dignissimos reiciendis et nisi animi.",
"company_ident": "Qui rem sequi labore debitis et.",
"email": "emmalee75@hotmail.com",
"root_folder_id": "azd8kQ"
},
"file_id": "gD6jDw",
"file": {
"_type": "file",
"id": "Ma2pnD",
"filename": "Aut corrupti velit temporibus molestiae animi impedit.",
"size": 79776.26510963,
"mime": "Impedit corporis animi hic esse.",
"download_url": "https://heidenreich.org/maxime-aut-laboriosam-est-officia-vero-harum-autem.html",
"preview_url": "http://beier.net/quam-qui-adipisci-quaerat-natus-sint-aut-quo"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "aL9rEY",
"property_id": "Z9AbqZ",
"property": {
"id": "aPGMAZ",
"title": "Non neque architecto sed ut suscipit.",
"description": "Voluptas fugiat ab in dignissimos placeat non.",
"name": "Consequatur et minima error in beatae earum.",
"source": "system",
"data_type": "date",
"workspace_id": "MDWqEa",
"workspace": {
"_type": "workspace",
"id": "LDQ3aq",
"name": "Rerum blanditiis assumenda ut aperiam fugit voluptas.",
"company_ident": "Omnis nesciunt sequi ratione ducimus.",
"email": "herta03@barton.com",
"root_folder_id": "DQeojD"
}
}
}
],
"date_values": [
{
"id": "LDQ3aq",
"value": "1971-06-12T18:54:04+00:00",
"duration": "P1D",
"basis": "Provident aut vitae quisquam.",
"property_id": "8rkAWV",
"property": {
"id": "A9V8Jx",
"title": "Fuga tempore optio vero voluptas.",
"description": "Distinctio et quia culpa aut et voluptatum est illum.",
"name": "Et cupiditate reiciendis iste eum exercitationem qui assumenda.",
"source": "system",
"data_type": "date",
"workspace_id": "eDJ20D",
"workspace": {
"_type": "workspace",
"id": "wOywZL",
"name": "Modi minus officiis est adipisci.",
"company_ident": "Id sint rerum praesentium molestias maxime est blanditiis.",
"email": "wnitzsche@kovacek.info",
"root_folder_id": "DJqKKA"
}
}
}
],
"numeric_values": [
{
"id": "Z9rXwa",
"value": 92489767.1,
"unit": "Nisi et rerum repellat sit eos.",
"property_id": "BZ385a",
"property": {
"id": "Ob621w",
"title": "Omnis voluptatem aut voluptate et ipsum iste molestiae.",
"description": "Asperiores assumenda omnis qui illo sint.",
"name": "Consectetur eligendi vero ut et est minus.",
"source": "system",
"data_type": "numeric",
"workspace_id": "O7o6X6",
"workspace": {
"_type": "workspace",
"id": "x6lYr1",
"name": "Eveniet accusamus nostrum illo itaque error saepe.",
"company_ident": "Blanditiis aut velit et eius.",
"email": "wilkinson.maeve@yahoo.com",
"root_folder_id": "1YpR03"
}
}
}
],
"string_values": [
{
"id": "ZgdnWa",
"value": "Error ea et non.",
"property_id": "aPrAgw",
"property": {
"id": "0ZABao",
"title": "Error voluptatum ipsam voluptatem et omnis et sit.",
"description": "Voluptas architecto quos quos quo voluptas et vel ea.",
"name": "Delectus officiis quasi nihil aut ea.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "D67wBZ",
"workspace": {
"_type": "workspace",
"id": "OymNP3",
"name": "Qui et excepturi excepturi soluta.",
"company_ident": "Non libero dolores nihil alias.",
"email": "kub.brooks@gmail.com",
"root_folder_id": "Ma2naY"
}
}
}
],
"jurisdictions": [
{
"id": "7ajJva",
"code": "Architecto quis at sint nostrum id nobis."
}
],
"document_types": [
{
"_type": "document_type",
"id": "aLoJ1B",
"name": "Officiis impedit non rem cupiditate autem occaecati tempore."
}
],
"parties": [
{
"id": "LZ89aA",
"first_name": "Maiores qui et velit vel et ut voluptatem.",
"last_name": "Velit dolorem ipsa aspernatur voluptas sit architecto quia voluptatem.",
"email": "qhowell@hotmail.com",
"phone": "Sint praesentium explicabo quae id quia consectetur.",
"title": "Minima eos quam nesciunt tempore.",
"company_name": "Nobis quia libero sit sed molestias provident dolores voluptas.",
"company_ident": "Dolore reiciendis et soluta nostrum magnam officia quae facere.",
"address_id": "8Ov9Pa",
"address": {
"id": "E8ln85",
"address_type": "Dolor quos impedit ipsa ipsum sint et rerum.",
"address_lines": "Est odio a cumque qui ducimus eius sed.",
"city": "Similique fugit sequi aspernatur necessitatibus aliquam quia vel.",
"locality": "Sint harum rerum est.",
"administrative_area": "Officiis odio a expedita molestiae.",
"post_code": "Non a hic non dignissimos.",
"country": "Et quas assumenda molestiae quasi dolores amet totam."
},
"external_references": [
{
"id": "OblW4Z",
"name": "Dolor quae qui qui ducimus esse.",
"title": "Sed sunt enim vitae beatae earum.",
"value": "Ea enim aliquam nostrum unde provident dolorum."
}
]
}
],
"attachments": [
{
"id": "wOywZL",
"created_at": "1974-01-17T11:00:32+00:00",
"updated_at": "1973-05-22T05:31:56+00:00",
"file_id": "oazEZ4",
"file": {
"_type": "file",
"id": "wOywZL",
"filename": "example.pdf",
"size": 61248.15,
"mime": "application/pdf",
"download_url": "http://effertz.net/",
"preview_url": "http://lemke.com/vero-ad-praesentium-omnis-eaque-dolore"
}
}
],
"external_references": [
{
"id": "laeGDm",
"name": "Praesentium officia assumenda provident sit eos architecto odio et.",
"title": "Et corrupti et atque.",
"value": "Eos consectetur voluptate dicta eaque sunt quia rerum esse."
}
],
"tags": [
{
"tag": "Ut harum nostrum distinctio delectus eum dolor."
}
],
"terms_and_conditions": {
"date": "2012-08-06T15:25:18+00:00",
"effective_date": "2002-05-01T11:58:16+00:00",
"term_end_date": "1997-06-06T16:32:28+00:00",
"signing_date": "1985-04-03T17:00:37+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
},
"retention": {
"end_date": "1997-03-20T03:53:36+00:00"
},
"breadcrumb": [
{
"id": "aEEoBY",
"name": "Iusto sed sapiente id architecto qui voluptas.",
"depth": 88967362
}
]
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a reminder
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/DdAldZ/reminders/Ow2Jza" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/DdAldZ/reminders/Ow2Jza"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/DdAldZ/reminders/Ow2Jza';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/DdAldZ/reminders/Ow2Jza'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document - Tags
API methods for managing document tags
List document's tags
requires authentication
Set document's tags
requires authentication
Document - Types
API methods for managing document types
List document types
requires authentication
List the document types configured for the active workspace
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/metadata/document-types" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/metadata/document-types"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/document-types';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/document-types'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new document type
requires authentication
Confgure a new document type for the workspace.
Example request:
curl --request POST \
"https://api.docue.com/public/v2/metadata/document-types" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"translations\": {
\"en\": \"translation\"
},
\"name\": \"Et dolor molestias qui quis ut.\"
}"
const url = new URL(
"https://api.docue.com/public/v2/metadata/document-types"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"translations": {
"en": "translation"
},
"name": "Et dolor molestias qui quis ut."
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/document-types';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'translations' => [
'en' => 'translation',
],
'name' => 'Et dolor molestias qui quis ut.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/document-types'
payload = {
"translations": {
"en": "translation"
},
"name": "Et dolor molestias qui quis ut."
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"_type": "document_type",
"id": "LDQ33a",
"name": "Et aut sunt autem odio culpa aspernatur."
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get document type details
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/metadata/document-types/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/metadata/document-types/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/document-types/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/document-types/1'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"_type": "document_type",
"id": "6M0rW6",
"name": "Qui est quo temporibus eaque nisi tempore quisquam."
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a document type
requires authentication
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/metadata/document-types/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"translations\": {
\"en\": \"translation\"
}
}"
const url = new URL(
"https://api.docue.com/public/v2/metadata/document-types/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"translations": {
"en": "translation"
}
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/document-types/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'translations' => [
'en' => 'translation',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/document-types/1'
payload = {
"translations": {
"en": "translation"
}
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"_type": "document_type",
"id": "jJ57EPx",
"name": "Aut in ipsam accusamus explicabo voluptatem."
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove a document type
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/metadata/document-types/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/metadata/document-types/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/document-types/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/document-types/1'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get document's types
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/wOywZL/document-types" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/wOywZL/document-types"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/wOywZL/document-types';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/wOywZL/document-types'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"_type": "document_type",
"id": "O7r1k6",
"name": "Tenetur sunt aut blanditiis voluptate accusamus placeat."
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Set document's types
requires authentication
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/documents/x1B97V9/document-types" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"document_types\": [
\"0ZABPa\"
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/x1B97V9/document-types"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"document_types": [
"0ZABPa"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/x1B97V9/document-types';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'document_types' => [
'0ZABPa',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/x1B97V9/document-types'
payload = {
"document_types": [
"0ZABPa"
]
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"_type": "document_type",
"id": "OvdVoZ",
"name": "Distinctio quam aut distinctio eum dolorum numquam."
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document metadata - Attachments
API methods for managing document attachments
List attachments
requires authentication
List attachment associated with the document.
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/ZNekeD/attachments" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/ZNekeD/attachments"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/ZNekeD/attachments';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/ZNekeD/attachments'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"id": "Dkb6PR",
"created_at": "2020-05-03T23:13:11+00:00",
"updated_at": "2017-10-25T17:55:55+00:00",
"file_id": "42GbLA",
"file": {
"_type": "file",
"id": "aEegwy",
"filename": "example.pdf",
"size": 3087459.728001,
"mime": "application/pdf",
"download_url": "http://www.haag.com/",
"preview_url": "http://www.denesik.org/"
},
"documents": [
{
"download_url": "Non veniam qui qui eos explicabo.",
"id": "OxQE4G",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Reprehenderit vel aut.",
"description": "Sapiente rem aliquam in.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "BaEMaV",
"contract": {
"_type": "contract",
"id": "DJbbXD",
"name": "Rerum dicta laborum voluptatem in at.",
"stage": "Voluptatem et nobis expedita vitae.",
"document_id": "pZ1va0",
"sign_method": "canvas",
"template_id": "Ad doloremque ab ut et voluptas dolorum sunt.",
"template": {
"id": "ZKQMvw",
"name": "Hic sit sit quae perspiciatis nesciunt.",
"description": "Consequatur eos eum aut ducimus.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "pMVVx8R",
"display_name": "Velit iusto illo at quia.",
"first_name": "Dolorem mollitia dolores dolor dolores perferendis soluta.",
"last_name": "Beatae repudiandae commodi nostrum aut error enim sit porro.",
"email": "gislason.sarai@yahoo.com",
"language": "de"
},
"signing_settings": {
"id": "8B8qlwE",
"created_at": "2013-11-23T11:48:15+00:00",
"updated_at": "1995-06-13T13:37:46+00:00",
"contract_id": "DW9yGn",
"message": "Quidem aut suscipit nisi velit quia ad velit.",
"expires_at": "1998-01-28T13:09:16+00:00",
"reminders_start": "1991-11-11T20:35:54+00:00",
"reminders_end": "1975-11-18T04:25:33+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "Zrnkl1",
"folder": {
"_type": "folder",
"id": "ZG3k3z",
"name": "Fuga adipisci qui et.",
"created_at": "1970-02-25T03:51:13+00:00",
"updated_at": "1979-02-20T16:56:40+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "VE9K8L",
"name": "Nam eos ut aut qui voluptates dicta.",
"created_at": "1998-10-26T09:28:02+00:00",
"updated_at": "1999-06-13T23:54:50+00:00",
"parent_id": "0ZABao",
"has_children": true
},
"has_children": true
},
"owner_id": "ZABL7a",
"owner": {
"id": "kM5kQ3",
"display_name": "Deserunt hic eos quidem ut odit officia.",
"first_name": "Inventore odit dicta voluptatem tenetur voluptas.",
"last_name": "Ex impedit ut non id ab consectetur.",
"email": "genevieve.franecki@durgan.biz",
"language": "de"
},
"workspace_id": "BaEG2D",
"workspace": {
"_type": "workspace",
"id": "NDkdZo",
"name": "Dolor quos qui et.",
"company_ident": "Nam autem et ut rerum velit aut ea autem.",
"email": "sparisian@legros.biz",
"root_folder_id": "xQ0KAJG"
},
"file_id": "BaEGMD",
"file": {
"_type": "file",
"id": "DWxpPZ",
"filename": "Aut saepe aut rerum est qui sequi quo sed.",
"size": 30969.334308,
"mime": "Expedita laborum nihil non placeat ut id.",
"download_url": "http://cruickshank.com/iure-voluptatem-perspiciatis-aut-eum-porro-non.html",
"preview_url": "https://hilpert.org/aliquid-expedita-dolorum-nobis-beatae-odit-et-nostrum-dolorum.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "MDWMma",
"property_id": "Dd9WXz",
"property": {
"id": "K64vEY",
"title": "Occaecati ab dolores totam ut aut.",
"description": "Voluptate repellendus at vitae excepturi et corporis et.",
"name": "Velit amet tenetur vel ipsa voluptas quia et.",
"source": "system",
"data_type": "string",
"workspace_id": "Z1o9gO",
"workspace": {
"_type": "workspace",
"id": "OoorYO",
"name": "Harum accusantium aliquam rerum minus facilis temporibus veritatis laborum.",
"company_ident": "Ut fugit perspiciatis in quo.",
"email": "ecrist@greenholt.com",
"root_folder_id": "OxQpJD"
}
}
}
],
"date_values": [
{
"id": "ZlLb0Z",
"value": "1982-05-24T22:11:00+00:00",
"duration": "P1D",
"basis": "Deserunt ut nostrum et soluta quo ratione quia.",
"property_id": "GDmqmD",
"property": {
"id": "DWopmD",
"title": "Iste ea nihil et saepe amet et velit molestiae.",
"description": "Odit et ea ut quasi error.",
"name": "Architecto sequi et in totam maxime.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "2V0kdG",
"workspace": {
"_type": "workspace",
"id": "DJzegD",
"name": "Soluta aspernatur nemo est culpa aliquid.",
"company_ident": "Hic et magnam nesciunt quaerat autem.",
"email": "conroy.timothy@thompson.org",
"root_folder_id": "BaEqMa"
}
}
}
],
"numeric_values": [
{
"id": "1DM7aR",
"value": 62854.49063166,
"unit": "Sunt quam ex magni at.",
"property_id": "4l773e",
"property": {
"id": "v9drvR",
"title": "In laudantium magni impedit quia aspernatur consequatur.",
"description": "Reiciendis officia aut non a iste.",
"name": "Mollitia aliquam et velit maxime quidem.",
"source": "system",
"data_type": "boolean",
"workspace_id": "kbq1my",
"workspace": {
"_type": "workspace",
"id": "V8Jw4e",
"name": "Maiores hic ut ex temporibus amet odit provident.",
"company_ident": "Vel fugiat explicabo suscipit enim nihil.",
"email": "golden.cruickshank@gmail.com",
"root_folder_id": "Ov4RdZ"
}
}
}
],
"string_values": [
{
"id": "aB5QQZ",
"value": "Incidunt minus nam qui.",
"property_id": "DWBE19",
"property": {
"id": "P3ywPKw",
"title": "Ipsam ipsum est perspiciatis accusantium dicta.",
"description": "Itaque ratione dignissimos reprehenderit magnam et aut voluptatem.",
"name": "Saepe in ut sunt a facere voluptatibus nostrum.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "0ZABao",
"workspace": {
"_type": "workspace",
"id": "v965dge",
"name": "Voluptatem aut omnis porro sit.",
"company_ident": "Reprehenderit nihil sequi omnis commodi et consequuntur et aut.",
"email": "frau@hegmann.com",
"root_folder_id": "ED5rMZ"
}
}
}
],
"jurisdictions": [
{
"id": "aEWrMM",
"code": "Neque sit autem aperiam recusandae pariatur sequi iusto."
}
],
"document_types": [
{
"_type": "document_type",
"id": "BJbxk6",
"name": "Est qui aut provident velit."
}
],
"parties": [
{
"id": "A4XG5q9",
"first_name": "Quod nemo sit omnis sunt perspiciatis.",
"last_name": "Optio aperiam dolores minus temporibus excepturi.",
"email": "jacey.gleichner@hyatt.org",
"phone": "Culpa laborum aperiam perspiciatis eveniet a et.",
"title": "Et quo rem eos aliquid sint sint fuga.",
"company_name": "A nobis consequatur natus aliquam nihil.",
"company_ident": "Repudiandae dolores enim reiciendis alias est.",
"address_id": "jKY77y",
"address": {
"id": "WPzm6oo",
"address_type": "Nostrum quisquam et vel.",
"address_lines": "Esse blanditiis velit distinctio dolores deleniti deleniti nisi.",
"city": "Qui optio aspernatur ab assumenda doloribus.",
"locality": "Totam quod quisquam minima natus molestiae quas velit maxime.",
"administrative_area": "Nisi est perspiciatis quasi velit qui occaecati illum molestiae.",
"post_code": "Fugit odit voluptates error minima quas aliquam amet.",
"country": "Error enim quia sunt blanditiis fugiat in."
},
"external_references": [
{
"id": "8Ov9Pa",
"name": "Minus recusandae expedita rerum quae eius et magni.",
"title": "Soluta earum veniam perspiciatis similique vero.",
"value": "Quidem maiores aut ipsa aspernatur nihil nam."
}
]
}
],
"reminders": [
{
"id": "ObBAl6",
"event_type": "document.reminder",
"title": "Quidem ut in et minus ut et."
}
],
"external_references": [
{
"id": "3dPyMJ",
"name": "Alias placeat et et officiis quia enim et.",
"title": "Consequatur ullam voluptates in.",
"value": "Molestiae velit non saepe totam rerum."
}
],
"tags": [
{
"tag": "Aut odit rerum ipsa."
}
],
"terms_and_conditions": {
"date": "1984-02-19T13:33:48+00:00",
"effective_date": "1976-01-06T16:10:32+00:00",
"term_end_date": "2002-07-02T18:24:44+00:00",
"signing_date": "1998-05-29T15:21:47+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"retention": {
"end_date": "2014-09-05T04:08:40+00:00"
},
"breadcrumb": [
{
"id": "a01P9O",
"name": "Omnis facilis explicabo reiciendis rem.",
"depth": 82476660
}
]
}
]
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Upload a new attachment
requires authentication
Example request:
curl --request POST \
"https://api.docue.com/public/v2/documents/E6oprW/attachments" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "file_name=Ut fuga modi minus consectetur magnam."\
--form "file=@/tmp/phpedPlBC" const url = new URL(
"https://api.docue.com/public/v2/documents/E6oprW/attachments"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('file_name', 'Ut fuga modi minus consectetur magnam.');
body.append('file', document.querySelector('input[name="file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/E6oprW/attachments';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'file_name',
'contents' => 'Ut fuga modi minus consectetur magnam.'
],
[
'name' => 'file',
'contents' => fopen('/tmp/phpedPlBC', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/E6oprW/attachments'
files = {
'file_name': (None, 'Ut fuga modi minus consectetur magnam.'),
'file': open('/tmp/phpedPlBC', 'rb')}
payload = {
"file_name": "Ut fuga modi minus consectetur magnam."
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'multipart/form-data',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, files=files)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "VperBL",
"created_at": "2014-09-04T14:32:10+00:00",
"updated_at": "1985-07-19T03:54:18+00:00",
"file_id": "OxrMWZ",
"file": {
"_type": "file",
"id": "mOoMZx",
"filename": "example.pdf",
"size": 135134145.14844,
"mime": "application/pdf",
"download_url": "http://wilkinson.net/veniam-possimus-nulla-qui-quo-rem-ea-culpa",
"preview_url": "http://langworth.biz/voluptas-modi-sed-ipsam-et-magni.html"
},
"documents": [
{
"download_url": "Vel voluptatem voluptas rem quaerat expedita est.",
"id": "vZr97D",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "In eaque laudantium.",
"description": "Accusantium hic unde excepturi.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "RZXLZ7",
"contract": {
"_type": "contract",
"id": "ZgMmzO",
"name": "Quis iure possimus voluptas deleniti.",
"stage": "Eos ipsam harum aut officia temporibus.",
"document_id": "2O40JO",
"sign_method": "strong",
"template_id": "Est est repudiandae dolorum fugit culpa aliquid.",
"template": {
"id": "EDY75a",
"name": "Pariatur rem est illum sed voluptas animi consequatur.",
"description": "Excepturi sit inventore ut praesentium saepe maiores.",
"type": "tailored"
},
"user": {
"id": "lQ2oW50",
"display_name": "Voluptatem assumenda velit et facere provident voluptas dicta non.",
"first_name": "Eius maiores aut blanditiis et similique voluptatem voluptas quasi.",
"last_name": "Quidem nemo ab est sequi molestias ab.",
"email": "wintheiser.junior@hotmail.com",
"language": "sv"
},
"is_paid": true,
"signing_settings": {
"id": "gzdMvg",
"created_at": "1997-08-16T08:01:05+00:00",
"updated_at": "1999-04-09T20:11:32+00:00",
"contract_id": "a2ePNZ",
"message": "A ea qui quam eaque.",
"expires_at": "2021-09-02T04:18:59+00:00",
"reminders_start": "1980-01-11T15:22:38+00:00",
"reminders_end": "1991-11-04T17:12:16+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "0ZABao",
"folder": {
"_type": "folder",
"id": "Z80NJk",
"name": "Magnam eaque labore aliquid sit quia.",
"created_at": "2013-08-21T22:21:52+00:00",
"updated_at": "1990-05-01T10:29:08+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "OR7M2A",
"name": "Consequuntur voluptatum odit veniam perferendis id.",
"created_at": "2022-01-18T15:13:25+00:00",
"updated_at": "2012-09-01T10:22:17+00:00",
"parent_id": "0ZABao",
"has_children": true
},
"has_children": true
},
"owner_id": "Dk0LLZ",
"owner": {
"id": "DJ23wD",
"display_name": "Unde est et voluptatem.",
"first_name": "Unde velit illum eius a quis.",
"last_name": "Officia molestias et omnis ducimus id sequi qui.",
"email": "domenico44@dare.biz",
"language": "de"
},
"workspace_id": "Ma2Jwa",
"workspace": {
"_type": "workspace",
"id": "4aLNDj",
"name": "Modi labore rerum aut ea nulla rerum sequi.",
"company_ident": "Quae velit quam et quibusdam dicta architecto.",
"email": "breanna05@hane.com",
"root_folder_id": "wOywZL"
},
"file_id": "wOym5O",
"file": {
"_type": "file",
"id": "ZK60d1",
"filename": "Reiciendis tempore maxime inventore iure eligendi necessitatibus.",
"size": 4524.01695,
"mime": "Consequuntur qui odit reiciendis in inventore dolorum aliquid architecto.",
"download_url": "http://kshlerin.com/quaerat-omnis-voluptatem-deleniti-nostrum-nulla-earum-labore.html",
"preview_url": "http://www.zieme.com/adipisci-illum-est-eum-ipsa-eaque-aspernatur-expedita-enim"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "WaBlND",
"property_id": "keNK44",
"property": {
"id": "NlrNn0",
"title": "Inventore aut rerum in sint nihil est quasi nemo.",
"description": "Eum eveniet similique quo repellat doloremque.",
"name": "Officia aliquid neque illo ut.",
"source": "system",
"data_type": "date",
"workspace_id": "rroq1v",
"workspace": {
"_type": "workspace",
"id": "aB3o9O",
"name": "Nihil maiores qui necessitatibus.",
"company_ident": "Adipisci placeat quidem adipisci rerum veritatis.",
"email": "ari47@balistreri.net",
"root_folder_id": "eoG7o2"
}
}
}
],
"date_values": [
{
"id": "Qbzz7l",
"value": "2007-07-26T17:25:41+00:00",
"duration": "P1D",
"basis": "Incidunt sit nihil provident est harum maiores.",
"property_id": "rKyJdV",
"property": {
"id": "Z9r8mP",
"title": "Tempora dolorem enim veniam facilis harum in aut.",
"description": "Sequi molestias fugit ut inventore sunt.",
"name": "Est est autem ea expedita.",
"source": "system",
"data_type": "string",
"workspace_id": "ga0EKO",
"workspace": {
"_type": "workspace",
"id": "NObBxO",
"name": "Distinctio quia qui corrupti cum corporis quam.",
"company_ident": "Eaque non suscipit aliquam qui.",
"email": "cary73@marvin.com",
"root_folder_id": "aEqJKW"
}
}
}
],
"numeric_values": [
{
"id": "NDkdZo",
"value": 98915,
"unit": "Quod eveniet dicta ullam mollitia repellendus qui.",
"property_id": "ajPXxd",
"property": {
"id": "MAE0g8",
"title": "Omnis sapiente eos recusandae.",
"description": "Inventore itaque mollitia aut nam labore alias.",
"name": "Quis praesentium non eligendi facere reprehenderit porro necessitatibus.",
"source": "system",
"data_type": "string",
"workspace_id": "gD6jDw",
"workspace": {
"_type": "workspace",
"id": "PZporD",
"name": "Laudantium neque illo voluptas corrupti molestiae voluptates reiciendis.",
"company_ident": "Ipsum molestias voluptas praesentium est consequatur reiciendis.",
"email": "sanford.dale@kub.com",
"root_folder_id": "aLg6PZ"
}
}
}
],
"string_values": [
{
"id": "7ajJva",
"value": "Porro delectus iste consequatur.",
"property_id": "vRWjoR",
"property": {
"id": "kexmEy",
"title": "Dolorum maxime totam alias beatae mollitia enim nisi.",
"description": "Excepturi debitis est perferendis id ut earum aliquam.",
"name": "Molestiae nesciunt facere quas qui.",
"source": "system",
"data_type": "numeric",
"workspace_id": "gD6jDw",
"workspace": {
"_type": "workspace",
"id": "Gx1ELjR",
"name": "Et voluptas pariatur voluptas voluptas dignissimos quasi.",
"company_ident": "Et et odio odio quia nobis modi nam ullam.",
"email": "nabshire@marvin.com",
"root_folder_id": "YZ9bPa"
}
}
}
],
"jurisdictions": [
{
"id": "Dke2ok",
"code": "Ad dignissimos fuga error suscipit."
}
],
"document_types": [
{
"_type": "document_type",
"id": "ZGr0bD",
"name": "Iusto animi reiciendis natus dicta quisquam optio sunt."
}
],
"parties": [
{
"id": "6DdwkO",
"first_name": "Fuga qui et tempore et eos et ut.",
"last_name": "Sit ut ad adipisci recusandae dolorem non.",
"email": "amara.brakus@vonrueden.com",
"phone": "Veniam libero omnis doloremque officia quaerat blanditiis qui.",
"title": "Ratione ut magni ipsum perspiciatis eveniet ad repudiandae.",
"company_name": "Laudantium quibusdam architecto aperiam provident aut voluptate nobis.",
"company_ident": "Voluptatum voluptates quos magnam aut accusamus quibusdam.",
"address_id": "9b8pGW",
"address": {
"id": "2ZlLRZ",
"address_type": "Dolores quia ea voluptatem voluptas qui.",
"address_lines": "Consequuntur quia voluptatem aut atque.",
"city": "In ea est incidunt suscipit ea soluta velit.",
"locality": "Sit similique pariatur ut eius id sed.",
"administrative_area": "Ipsam aliquid omnis sunt consectetur officiis quisquam deserunt.",
"post_code": "Quibusdam rerum et labore sunt consectetur aperiam.",
"country": "Itaque impedit earum fugiat tenetur est illo aut."
},
"external_references": [
{
"id": "NObxZW",
"name": "Sed mollitia officiis voluptate voluptates.",
"title": "Nulla nihil dolor sed accusamus nemo labore et.",
"value": "Voluptatem ratione veritatis sed iste ducimus distinctio dicta sapiente."
}
]
}
],
"reminders": [
{
"id": "6jJAemz",
"event_type": "document.reminder",
"title": "Aspernatur adipisci qui voluptate laboriosam in saepe."
}
],
"external_references": [
{
"id": "pZ1pvD",
"name": "Natus tempore quis eos ut porro est ipsa nisi.",
"title": "Magnam et odio itaque ducimus.",
"value": "Reprehenderit ea assumenda in."
}
],
"tags": [
{
"tag": "Voluptate sit id reprehenderit tempore a."
}
],
"terms_and_conditions": {
"date": "1975-08-30T13:33:09+00:00",
"effective_date": "1975-08-21T02:00:57+00:00",
"term_end_date": "1981-11-15T02:08:02+00:00",
"signing_date": "2012-01-19T10:06:23+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
},
"retention": {
"end_date": "2023-10-03T21:39:09+00:00"
},
"breadcrumb": [
{
"id": "ZA25ya",
"name": "Ducimus assumenda nostrum necessitatibus beatae.",
"depth": 298281
}
]
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get attachment data
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/b6rAAx/attachments/blqMkWR" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/b6rAAx/attachments/blqMkWR"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/b6rAAx/attachments/blqMkWR';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/b6rAAx/attachments/blqMkWR'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "OyQ6xb",
"created_at": "1992-02-10T20:48:00+00:00",
"updated_at": "2009-02-01T10:55:32+00:00",
"file_id": "5rQ59e",
"file": {
"_type": "file",
"id": "LDQ3aq",
"filename": "example.pdf",
"size": 52036.7,
"mime": "application/pdf",
"download_url": "http://oreilly.com/magni-animi-est-esse-veniam-et",
"preview_url": "http://harris.info/fuga-quis-vel-et-illum-asperiores.html"
},
"documents": [
{
"download_url": "Laborum praesentium voluptate fugiat et voluptate quia qui consectetur.",
"id": "Ma2w0O",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Sed eligendi excepturi aut.",
"description": "Dignissimos ipsa eveniet in sed aut aut.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "9Kj8vQ",
"contract": {
"_type": "contract",
"id": "Ma2naY",
"name": "Velit totam eos error saepe earum dolores veritatis.",
"stage": "Ducimus incidunt fuga debitis impedit a unde.",
"document_id": "eDJ92O",
"sign_method": "strong",
"template_id": "Quam dolorum voluptas aspernatur tenetur sequi et.",
"template": {
"id": "wn0VLz",
"name": "Est reiciendis est dolor enim rerum.",
"description": "Atque ut quo quas.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "1p42pv",
"display_name": "Consectetur veritatis reprehenderit dolores necessitatibus iste quia officiis.",
"first_name": "Voluptatem et autem dolor molestias sunt nihil enim.",
"last_name": "Unde earum ullam quae consequuntur iure excepturi consequatur.",
"email": "mnolan@goldner.net",
"language": "de"
},
"signing_settings": {
"id": "6Axqn9z",
"created_at": "1989-09-10T21:04:33+00:00",
"updated_at": "1988-09-26T12:18:51+00:00",
"contract_id": "eDJ0a1",
"message": "Voluptates quia illo commodi earum occaecati non libero exercitationem.",
"expires_at": "2005-12-01T18:10:51+00:00",
"reminders_start": "1999-11-24T14:19:14+00:00",
"reminders_end": "2024-10-06T03:18:10+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "ZAjVya",
"folder": {
"_type": "folder",
"id": "O7rPBa",
"name": "Illum quidem in impedit nostrum.",
"created_at": "1987-06-29T20:50:58+00:00",
"updated_at": "2025-06-15T09:56:32+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "a2pW4j",
"name": "Quos esse fugit quo omnis molestiae ut id eum.",
"created_at": "2014-11-09T10:47:38+00:00",
"updated_at": "1998-10-30T08:43:32+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "NObxZW",
"owner": {
"id": "gMj7Y3k",
"display_name": "Minus sed impedit repellendus porro porro consequatur nam occaecati.",
"first_name": "Sed nesciunt accusamus eaque placeat eligendi porro sed.",
"last_name": "Est ullam dolorem nihil corrupti voluptas excepturi qui dolor.",
"email": "freda39@nienow.com",
"language": "de"
},
"workspace_id": "ORM4gP",
"workspace": {
"_type": "workspace",
"id": "8OvloZ",
"name": "Nisi ex debitis fuga doloremque at quo.",
"company_ident": "Autem quaerat voluptatem quidem.",
"email": "gerry79@murray.info",
"root_folder_id": "OxVV9Z"
},
"file_id": "2O4eDy",
"file": {
"_type": "file",
"id": "BZVjAZ",
"filename": "Nihil et odio consequatur et.",
"size": 8204.08608868,
"mime": "Nam maxime perferendis quaerat et ad dicta.",
"download_url": "http://www.ortiz.biz/aspernatur-aut-voluptas-ea-qui-aut-error",
"preview_url": "https://goyette.com/voluptas-nobis-ut-iste-id-velit-enim-beatae.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "DJ2xng",
"property_id": "vOx51D",
"property": {
"id": "66XkRW",
"title": "Cumque nemo possimus quibusdam ipsa voluptates quis veniam laborum.",
"description": "Ab magnam et quas fuga qui consequatur et.",
"name": "Soluta rem non ad sit.",
"source": "system",
"data_type": "string",
"workspace_id": "2Zlp0Z",
"workspace": {
"_type": "workspace",
"id": "xogzve",
"name": "Voluptatem neque pariatur qui quasi.",
"company_ident": "Cum eum minus et architecto.",
"email": "dayne93@gmail.com",
"root_folder_id": "49Pkdbe"
}
}
}
],
"date_values": [
{
"id": "2O4eDy",
"value": "2024-03-18T11:53:37+00:00",
"duration": "P1D",
"basis": "Possimus ut vitae saepe id.",
"property_id": "PZporD",
"property": {
"id": "N41vq8x",
"title": "Temporibus libero sint adipisci ipsam et tempora maiores.",
"description": "Aspernatur veniam velit sed labore aperiam impedit.",
"name": "Perspiciatis voluptatibus error tempore minima.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "BaEMaV",
"workspace": {
"_type": "workspace",
"id": "WaBAZw",
"name": "Veritatis quibusdam est occaecati est aut quam quisquam.",
"company_ident": "Placeat nam qui beatae et hic.",
"email": "kreiger.alysa@kuphal.com",
"root_folder_id": "OxbzM4"
}
}
}
],
"numeric_values": [
{
"id": "aEGdMD",
"value": 158080.3528,
"unit": "Consequatur adipisci enim veritatis nihil.",
"property_id": "LDQ3aq",
"property": {
"id": "Ma2naY",
"title": "Vero facilis enim dicta modi exercitationem omnis quae non.",
"description": "Ea minus rem quam tenetur magnam natus reiciendis sed.",
"name": "Quia ut aliquam possimus quae et ea ut.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "DML3nO",
"workspace": {
"_type": "workspace",
"id": "aE5P2a",
"name": "Architecto voluptas ipsam hic qui.",
"company_ident": "Quos eligendi provident non similique et.",
"email": "boconnell@gmail.com",
"root_folder_id": "0115wGz"
}
}
}
],
"string_values": [
{
"id": "oxxNz2",
"value": "Eaque reprehenderit aspernatur optio.",
"property_id": "Mw9jrr",
"property": {
"id": "0ZABao",
"title": "Aperiam perspiciatis repellendus eveniet quibusdam corrupti.",
"description": "Omnis est veniam qui qui non.",
"name": "Animi temporibus ipsum eum vel non aliquid.",
"source": "system",
"data_type": "string",
"workspace_id": "aE5Wba",
"workspace": {
"_type": "workspace",
"id": "gD6jDw",
"name": "Soluta quia reiciendis tempore tempora possimus quis laboriosam.",
"company_ident": "Et non voluptas et quaerat voluptates voluptatem voluptatem ut.",
"email": "santina22@hotmail.com",
"root_folder_id": "Ox1pWD"
}
}
}
],
"jurisdictions": [
{
"id": "zMXn8P3",
"code": "Quam nihil modi quod quis et totam sunt."
}
],
"document_types": [
{
"_type": "document_type",
"id": "ObglwD",
"name": "Cupiditate dignissimos molestiae rerum sit provident quidem omnis."
}
],
"parties": [
{
"id": "LDQNEZ",
"first_name": "Qui animi similique est sit vero.",
"last_name": "Inventore eaque aspernatur vitae pariatur at.",
"email": "elda.jakubowski@huels.com",
"phone": "Doloremque quia vero asperiores.",
"title": "Rem et et et assumenda dicta.",
"company_name": "Nemo ducimus et ab est nisi ut.",
"company_ident": "Porro non voluptatem debitis ut assumenda est omnis consequatur.",
"address_id": "LZ89aA",
"address": {
"id": "2O4eDy",
"address_type": "Non voluptates omnis sed ad et.",
"address_lines": "Sit laboriosam dolores omnis ea non et.",
"city": "Et provident omnis maiores non nobis qui veniam.",
"locality": "Accusamus ut sunt quis nulla placeat.",
"administrative_area": "Soluta optio dolorem hic magnam non illum ipsum.",
"post_code": "Nemo dolorem similique aliquam maxime id.",
"country": "Voluptas et est sint consequatur placeat magnam iste qui."
},
"external_references": [
{
"id": "KJlA1Y",
"name": "Qui sint aut odit veritatis.",
"title": "Fugiat dolores quos neque aut.",
"value": "Exercitationem alias ratione in."
}
]
}
],
"reminders": [
{
"id": "O4WvNa",
"event_type": "document.reminder",
"title": "Et cum cum sapiente omnis quidem quam et."
}
],
"external_references": [
{
"id": "vNvbvBd",
"name": "Laudantium est vel facilis praesentium odio quia.",
"title": "Consectetur ut et iure quos ut accusantium odio.",
"value": "Autem ut sint minus culpa repudiandae facere provident."
}
],
"tags": [
{
"tag": "Velit accusantium quae fugiat consequatur doloremque."
}
],
"terms_and_conditions": {
"date": "1994-05-27T01:10:48+00:00",
"effective_date": "2025-08-13T00:46:14+00:00",
"term_end_date": "1989-06-28T17:17:12+00:00",
"signing_date": "2008-08-21T23:05:44+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
},
"retention": {
"end_date": "2002-03-12T04:32:36+00:00"
},
"breadcrumb": [
{
"id": "O4nydj",
"name": "Repudiandae consequatur aut possimus quibusdam.",
"depth": 80981968
}
]
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete an attachment
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/aPM1gO/attachments/m965lem" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/aPM1gO/attachments/m965lem"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/aPM1gO/attachments/m965lem';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/aPM1gO/attachments/m965lem'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document metadata - Custom properties
API methods for managing custom metadata properties.
List custom properties
requires authentication
List the custom properties configured for the workspace.
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/metadata/properties" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/metadata/properties"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/properties';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/properties'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a new custom property
requires authentication
Configure a new custom property for the workspace.
Example request:
curl --request POST \
"https://api.docue.com/public/v2/metadata/properties" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Aut dolorem sit eveniet aperiam.\",
\"title\": \"Enim totam quo et rem.\",
\"description\": \"Repudiandae non qui cupiditate et dolores.\",
\"data_type\": \"string\"
}"
const url = new URL(
"https://api.docue.com/public/v2/metadata/properties"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Aut dolorem sit eveniet aperiam.",
"title": "Enim totam quo et rem.",
"description": "Repudiandae non qui cupiditate et dolores.",
"data_type": "string"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/properties';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Aut dolorem sit eveniet aperiam.',
'title' => 'Enim totam quo et rem.',
'description' => 'Repudiandae non qui cupiditate et dolores.',
'data_type' => 'string',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/properties'
payload = {
"name": "Aut dolorem sit eveniet aperiam.",
"title": "Enim totam quo et rem.",
"description": "Repudiandae non qui cupiditate et dolores.",
"data_type": "string"
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "LZ8KqD",
"title": "Enim magnam perferendis quia sit.",
"description": "Soluta saepe suscipit molestias explicabo.",
"name": "Sed facere molestiae fuga aut.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "EQjrX7",
"workspace": {
"_type": "workspace",
"id": "DM6Awj",
"name": "Eos nihil error nemo.",
"company_ident": "Consectetur est ad eos.",
"email": "giles10@gmail.com",
"root_folder_id": "Z3e0vd"
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get a custom property data
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/metadata/properties/Wq6vbJ" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/metadata/properties/Wq6vbJ"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/properties/Wq6vbJ';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/properties/Wq6vbJ'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "NObxZW",
"title": "Possimus omnis quisquam veritatis beatae.",
"description": "Culpa suscipit saepe voluptatem optio quia iste.",
"name": "Quaerat rerum odit vel ea.",
"source": "system",
"data_type": "boolean",
"workspace_id": "aEQgn2",
"workspace": {
"_type": "workspace",
"id": "Dm4plO",
"name": "Eius rerum ratione qui numquam dolor deleniti repellendus.",
"company_ident": "Quaerat commodi quis error id rem et.",
"email": "miller.marcos@hotmail.com",
"root_folder_id": "BaEMaV"
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a custom property
requires authentication
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/metadata/properties/RZXv9O" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Aut eos tempora totam est nesciunt eos.\",
\"description\": \"Molestias totam inventore fuga laboriosam labore.\"
}"
const url = new URL(
"https://api.docue.com/public/v2/metadata/properties/RZXv9O"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "Aut eos tempora totam est nesciunt eos.",
"description": "Molestias totam inventore fuga laboriosam labore."
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/properties/RZXv9O';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'Aut eos tempora totam est nesciunt eos.',
'description' => 'Molestias totam inventore fuga laboriosam labore.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/properties/RZXv9O'
payload = {
"title": "Aut eos tempora totam est nesciunt eos.",
"description": "Molestias totam inventore fuga laboriosam labore."
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "DQBq8Z",
"title": "Aperiam earum voluptas omnis non molestiae quae.",
"description": "Voluptate facere odio labore aut autem fugit.",
"name": "Quas accusamus illo est eveniet nemo vitae et.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "6bGRAG",
"workspace": {
"_type": "workspace",
"id": "AQdABk",
"name": "Quis error blanditiis in aut quia porro omnis amet.",
"company_ident": "Quo voluptatem totam dicta sit soluta mollitia.",
"email": "mossie93@keebler.com",
"root_folder_id": "ZgnpAW"
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a custom property
requires authentication
Deleting a custom property will also remove all the property values from the documents.
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/metadata/properties/ED53xa" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/metadata/properties/ED53xa"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/metadata/properties/ED53xa';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/properties/ED53xa'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.List custom property values
requires authentication
List custom property values of a document
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/ZpGKxd/properties/we77ndo/values" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/ZpGKxd/properties/we77ndo/values"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/ZpGKxd/properties/we77ndo/values';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/ZpGKxd/properties/we77ndo/values'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"id": "GxenEPw",
"value": "Eos est aut non animi itaque laboriosam in.",
"property_id": "wOyNwD",
"property": {
"id": "wOy8qa",
"title": "Libero nisi est non sint saepe natus.",
"description": "Quae itaque at quo hic repellendus.",
"name": "Et veritatis dicta qui ut reiciendis accusantium earum.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "bgJ07d",
"workspace": {
"_type": "workspace",
"id": "kORRxO",
"name": "Vel magni dolorem id soluta ipsa placeat in eligendi.",
"company_ident": "Voluptas dignissimos aut voluptatibus exercitationem non.",
"email": "schoen.lisette@yahoo.com",
"root_folder_id": "aEoyWD"
}
}
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Set a custom property value
requires authentication
Set a custom property value of a document
Example request:
curl --request POST \
"https://api.docue.com/public/v2/documents/A8yxBk/properties/BZVMwD/values" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": \"1995-12-19T21:18:37+00:00\",
\"duration\": \"P1Y\",
\"basis\": \"Contract terms\",
\"unit\": \"EUR\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/A8yxBk/properties/BZVMwD/values"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"value": "1995-12-19T21:18:37+00:00",
"duration": "P1Y",
"basis": "Contract terms",
"unit": "EUR"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/A8yxBk/properties/BZVMwD/values';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'value' => '1995-12-19T21:18:37+00:00',
'duration' => 'P1Y',
'basis' => 'Contract terms',
'unit' => 'EUR',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/A8yxBk/properties/BZVMwD/values'
payload = {
"value": "1995-12-19T21:18:37+00:00",
"duration": "P1Y",
"basis": "Contract terms",
"unit": "EUR"
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "vOx61Z",
"value": "Aut incidunt neque sed.",
"property_id": "J1pXAX",
"property": {
"id": "M9wjgj",
"title": "Nisi cumque sunt explicabo rem veritatis provident.",
"description": "Voluptatem consectetur aut aut vitae dolorum qui.",
"name": "In dolor doloremque consectetur nostrum enim omnis harum.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "DMARjD",
"workspace": {
"_type": "workspace",
"id": "dz1yBgQ",
"name": "Non hic cum saepe sed veniam.",
"company_ident": "Quasi debitis quisquam eum omnis totam et.",
"email": "noah03@yahoo.com",
"root_folder_id": "LZ89aA"
}
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get custom property value data
requires authentication
Get a custom property value of a document
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/a0exbY/properties/pZ1va0/values/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/a0exbY/properties/pZ1va0/values/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/a0exbY/properties/pZ1va0/values/1';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/a0exbY/properties/pZ1va0/values/1'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "EQprRb",
"value": "Sed optio consectetur asperiores molestiae consectetur eligendi possimus.",
"property_id": "A71YJ7",
"property": {
"id": "OyyKvq",
"title": "Quia similique voluptas aut doloribus veniam harum.",
"description": "Nihil id sint vitae corrupti.",
"name": "Voluptate placeat enim eos vel officiis.",
"source": "system",
"data_type": "string",
"workspace_id": "eDJ0a1",
"workspace": {
"_type": "workspace",
"id": "gD67jZ",
"name": "Vero sint ut et totam omnis nam.",
"company_ident": "Doloribus assumenda aut mollitia suscipit sapiente harum.",
"email": "ayla10@gmail.com",
"root_folder_id": "wAK6xj4"
}
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a custom property value
requires authentication
Update a custom property value of a document
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/documents/kM2V5z/properties/LLgjqpG/values/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": \"1975-09-01T05:11:19+00:00\",
\"duration\": \"P1Y\",
\"basis\": \"Contract terms\",
\"unit\": \"EUR\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/kM2V5z/properties/LLgjqpG/values/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"value": "1975-09-01T05:11:19+00:00",
"duration": "P1Y",
"basis": "Contract terms",
"unit": "EUR"
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/kM2V5z/properties/LLgjqpG/values/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'value' => '1975-09-01T05:11:19+00:00',
'duration' => 'P1Y',
'basis' => 'Contract terms',
'unit' => 'EUR',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/kM2V5z/properties/LLgjqpG/values/1'
payload = {
"value": "1975-09-01T05:11:19+00:00",
"duration": "P1Y",
"basis": "Contract terms",
"unit": "EUR"
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "wOywZL",
"value": "Et neque ipsum esse saepe quas rerum sed.",
"property_id": "a21Vy4",
"property": {
"id": "1DM7aR",
"title": "Suscipit beatae impedit aut iste vel sunt et.",
"description": "Ut unde magnam nulla dolor.",
"name": "Temporibus hic incidunt dolor quaerat sit.",
"source": "system",
"data_type": "date",
"workspace_id": "ZNnz5Z",
"workspace": {
"_type": "workspace",
"id": "aeMdj8",
"name": "Autem ut sit autem voluptatibus consequatur quas quasi.",
"company_ident": "Ipsam dicta adipisci ea harum temporibus repellat tempore.",
"email": "ykub@wiza.biz",
"root_folder_id": "aPwEX1"
}
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove a custom property value
requires authentication
Remove a custom property value of a document
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/O46gNj/properties/EQ1RrP/values/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/O46gNj/properties/EQ1RrP/values/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/O46gNj/properties/EQ1RrP/values/1';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/O46gNj/properties/EQ1RrP/values/1'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document metadata - Languages
API methods for managing documents' languages
Get document's languages
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/gD6M6O/languages" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/gD6M6O/languages"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/gD6M6O/languages';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/gD6M6O/languages'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"code": "EN"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Set document's languages
requires authentication
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/documents/laeA3a/languages" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"languages\": [
\"fi\",
\"en\"
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/laeA3a/languages"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"languages": [
"fi",
"en"
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/laeA3a/languages';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'languages' => [
'fi',
'en',
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/laeA3a/languages'
payload = {
"languages": [
"fi",
"en"
]
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"code": "EN"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document metadata - Parties
API methods for managing document parties
List document's parties
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/0ZABao/parties" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/0ZABao/parties"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/0ZABao/parties';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/0ZABao/parties'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"id": "Zrow3a",
"first_name": "Aliquam eos quidem voluptas libero perspiciatis et.",
"last_name": "Quod nostrum et velit minima sunt illum.",
"email": "wilhelm08@batz.com",
"phone": "Facere est nemo dicta suscipit.",
"title": "Magni possimus nemo non repudiandae aliquam eaque et.",
"company_name": "Nostrum et blanditiis quidem earum et exercitationem.",
"company_ident": "Maxime veniam suscipit impedit culpa est quo.",
"address_id": "Zgmqmg",
"address": {
"id": "Dm1e1W",
"address_type": "Beatae veniam voluptatem ut reprehenderit voluptate dolore quasi.",
"address_lines": "Est accusantium non corporis ut aut voluptatibus magnam.",
"city": "Iste vel consectetur et.",
"locality": "Est inventore fuga est dolores praesentium placeat fuga.",
"administrative_area": "Facere est eveniet perferendis et ratione aliquid.",
"post_code": "Omnis eum ut nostrum voluptatem.",
"country": "Alias iste vero qui vel et facere."
},
"external_references": [
{
"id": "wOy8qa",
"name": "Quia enim et voluptatem consequatur.",
"title": "Nostrum aut nulla vel nisi harum architecto ea.",
"value": "Minima voluptate sunt eum ducimus."
}
]
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Add a new party to the document
requires authentication
Example request:
curl --request POST \
"https://api.docue.com/public/v2/documents/wOyRJD/parties" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": \"Jane\",
\"last_name\": \"Doe\",
\"email\": \"aboyer@shields.biz\",
\"phone\": \"+358401231231\",
\"title\": \"President\",
\"company_name\": \"Deserunt eius dolore ex aperiam eveniet ut quia dolore.\",
\"company_ident\": \"FI123456789\",
\"address\": {
\"address_type\": \"20341 Whitworth Institute\",
\"address_lines\": \"405\",
\"city\": \"Seattle\",
\"locality\": \"Whitworth\",
\"administrative_area\": \"WA\",
\"post_code\": \"98052\",
\"country\": \"United States of America\"
},
\"external_references\": [
{
\"name\": \"Aperiam exercitationem cumque sed sed.\",
\"title\": \"Reprehenderit exercitationem voluptatem praesentium aut vel atque maxime.\",
\"value\": \"Dolorum deleniti explicabo asperiores veritatis ipsam excepturi.\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/wOyRJD/parties"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"first_name": "Jane",
"last_name": "Doe",
"email": "aboyer@shields.biz",
"phone": "+358401231231",
"title": "President",
"company_name": "Deserunt eius dolore ex aperiam eveniet ut quia dolore.",
"company_ident": "FI123456789",
"address": {
"address_type": "20341 Whitworth Institute",
"address_lines": "405",
"city": "Seattle",
"locality": "Whitworth",
"administrative_area": "WA",
"post_code": "98052",
"country": "United States of America"
},
"external_references": [
{
"name": "Aperiam exercitationem cumque sed sed.",
"title": "Reprehenderit exercitationem voluptatem praesentium aut vel atque maxime.",
"value": "Dolorum deleniti explicabo asperiores veritatis ipsam excepturi."
}
]
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/wOyRJD/parties';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'aboyer@shields.biz',
'phone' => '+358401231231',
'title' => 'President',
'company_name' => 'Deserunt eius dolore ex aperiam eveniet ut quia dolore.',
'company_ident' => 'FI123456789',
'address' => [
'address_type' => '20341 Whitworth Institute',
'address_lines' => '405',
'city' => 'Seattle',
'locality' => 'Whitworth',
'administrative_area' => 'WA',
'post_code' => '98052',
'country' => 'United States of America',
],
'external_references' => [
[
'name' => 'Aperiam exercitationem cumque sed sed.',
'title' => 'Reprehenderit exercitationem voluptatem praesentium aut vel atque maxime.',
'value' => 'Dolorum deleniti explicabo asperiores veritatis ipsam excepturi.',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/wOyRJD/parties'
payload = {
"first_name": "Jane",
"last_name": "Doe",
"email": "aboyer@shields.biz",
"phone": "+358401231231",
"title": "President",
"company_name": "Deserunt eius dolore ex aperiam eveniet ut quia dolore.",
"company_ident": "FI123456789",
"address": {
"address_type": "20341 Whitworth Institute",
"address_lines": "405",
"city": "Seattle",
"locality": "Whitworth",
"administrative_area": "WA",
"post_code": "98052",
"country": "United States of America"
},
"external_references": [
{
"name": "Aperiam exercitationem cumque sed sed.",
"title": "Reprehenderit exercitationem voluptatem praesentium aut vel atque maxime.",
"value": "Dolorum deleniti explicabo asperiores veritatis ipsam excepturi."
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "NDk7yD",
"first_name": "Eum quas illum quae iste.",
"last_name": "Illo praesentium doloremque ea accusantium velit eligendi.",
"email": "lowe.emelie@gmail.com",
"phone": "Nihil deleniti neque asperiores.",
"title": "Cumque aperiam qui atque sed.",
"company_name": "In officiis voluptatem amet et quam consequatur quaerat.",
"company_ident": "Quibusdam modi dignissimos voluptatum repudiandae.",
"address_id": "Ma2pnD",
"address": {
"id": "kLB29k",
"address_type": "Consequatur excepturi amet ut nam consequatur quisquam.",
"address_lines": "Sunt eius sit eligendi sunt facilis voluptatem.",
"city": "Explicabo odio laudantium minus.",
"locality": "Nesciunt voluptatem tempora sed eos non quas voluptate.",
"administrative_area": "Sit et repellendus laudantium libero.",
"post_code": "Ipsum quo recusandae ad quo.",
"country": "Quaerat fugit eos vitae qui omnis aut tempora."
},
"external_references": [
{
"id": "6j9KEe",
"name": "Enim facilis illo nulla.",
"title": "Repudiandae nostrum consequuntur quia ut.",
"value": "Cumque minima vel optio laudantium."
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Get document's party
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/Z1rM3a/parties/DJ2gwD" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/Z1rM3a/parties/DJ2gwD"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/Z1rM3a/parties/DJ2gwD';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/Z1rM3a/parties/DJ2gwD'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "0ZArBa",
"first_name": "Quod voluptate sed eaque quisquam aliquam accusantium.",
"last_name": "Ex quia modi corporis quis ipsum.",
"email": "jean85@gmail.com",
"phone": "Iure architecto qui est molestiae veniam veniam.",
"title": "Consequatur deserunt nihil provident ut.",
"company_name": "Eum fugit doloribus delectus non harum alias perferendis.",
"company_ident": "Numquam repellendus eligendi accusamus ut voluptatibus occaecati.",
"address_id": "1DM9jD",
"address": {
"id": "NDkdZo",
"address_type": "Excepturi maiores nulla tenetur est quaerat omnis ut.",
"address_lines": "Repellendus commodi quam nostrum deserunt qui.",
"city": "Officia pariatur laboriosam cupiditate numquam.",
"locality": "Quia laborum ea dolor assumenda occaecati qui.",
"administrative_area": "Quia voluptatem non est iusto atque est.",
"post_code": "Repellendus unde quasi occaecati qui sunt.",
"country": "Facilis non in voluptas tempore."
},
"external_references": [
{
"id": "RZXxJZ",
"name": "Illum quis et autem est aut et et.",
"title": "Qui provident esse cumque accusamus possimus voluptatem.",
"value": "Voluptatibus est cum error minus."
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a document party
requires authentication
Example request:
curl --request PUT \
"https://api.docue.com/public/v2/documents/wOywZL/parties/ZlzzBO" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": \"Aut sit qui rerum voluptas nulla.\",
\"last_name\": \"Sequi perferendis ea minima fugit et nostrum aut velit.\",
\"email\": \"margot.osinski@botsford.net\",
\"phone\": \"+358401231231\",
\"title\": \"Nemo in vel a adipisci optio sint quis.\",
\"company_name\": \"Doloremque incidunt accusantium delectus similique quia quos qui.\",
\"company_ident\": \"FI123456789\",
\"address\": {
\"address_type\": \"20341 Whitworth Institute\",
\"address_lines\": \"405\",
\"city\": \"Seattle\",
\"locality\": \"Whitworth\",
\"administrative_area\": \"WA\",
\"post_code\": \"98052\",
\"country\": \"United States of America\"
},
\"external_references\": [
{
\"name\": \"Adipisci incidunt facere qui eligendi.\",
\"title\": \"Qui numquam dignissimos et consequuntur cupiditate.\",
\"value\": \"Ex at pariatur ipsum ipsum maxime commodi unde.\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/wOywZL/parties/ZlzzBO"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"first_name": "Aut sit qui rerum voluptas nulla.",
"last_name": "Sequi perferendis ea minima fugit et nostrum aut velit.",
"email": "margot.osinski@botsford.net",
"phone": "+358401231231",
"title": "Nemo in vel a adipisci optio sint quis.",
"company_name": "Doloremque incidunt accusantium delectus similique quia quos qui.",
"company_ident": "FI123456789",
"address": {
"address_type": "20341 Whitworth Institute",
"address_lines": "405",
"city": "Seattle",
"locality": "Whitworth",
"administrative_area": "WA",
"post_code": "98052",
"country": "United States of America"
},
"external_references": [
{
"name": "Adipisci incidunt facere qui eligendi.",
"title": "Qui numquam dignissimos et consequuntur cupiditate.",
"value": "Ex at pariatur ipsum ipsum maxime commodi unde."
}
]
};
fetch(url, {
method: "PUT",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/wOywZL/parties/ZlzzBO';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'first_name' => 'Aut sit qui rerum voluptas nulla.',
'last_name' => 'Sequi perferendis ea minima fugit et nostrum aut velit.',
'email' => 'margot.osinski@botsford.net',
'phone' => '+358401231231',
'title' => 'Nemo in vel a adipisci optio sint quis.',
'company_name' => 'Doloremque incidunt accusantium delectus similique quia quos qui.',
'company_ident' => 'FI123456789',
'address' => [
'address_type' => '20341 Whitworth Institute',
'address_lines' => '405',
'city' => 'Seattle',
'locality' => 'Whitworth',
'administrative_area' => 'WA',
'post_code' => '98052',
'country' => 'United States of America',
],
'external_references' => [
[
'name' => 'Adipisci incidunt facere qui eligendi.',
'title' => 'Qui numquam dignissimos et consequuntur cupiditate.',
'value' => 'Ex at pariatur ipsum ipsum maxime commodi unde.',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/wOywZL/parties/ZlzzBO'
payload = {
"first_name": "Aut sit qui rerum voluptas nulla.",
"last_name": "Sequi perferendis ea minima fugit et nostrum aut velit.",
"email": "margot.osinski@botsford.net",
"phone": "+358401231231",
"title": "Nemo in vel a adipisci optio sint quis.",
"company_name": "Doloremque incidunt accusantium delectus similique quia quos qui.",
"company_ident": "FI123456789",
"address": {
"address_type": "20341 Whitworth Institute",
"address_lines": "405",
"city": "Seattle",
"locality": "Whitworth",
"administrative_area": "WA",
"post_code": "98052",
"country": "United States of America"
},
"external_references": [
{
"name": "Adipisci incidunt facere qui eligendi.",
"title": "Qui numquam dignissimos et consequuntur cupiditate.",
"value": "Ex at pariatur ipsum ipsum maxime commodi unde."
}
]
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "DJ2x7n",
"first_name": "Quos facere praesentium sed maiores.",
"last_name": "Similique nemo ut consequatur modi rerum ducimus nihil ut.",
"email": "arolfson@spencer.com",
"phone": "Suscipit necessitatibus corrupti rem aspernatur est sint consequatur.",
"title": "Dicta tenetur voluptas nihil et vel ab nihil.",
"company_name": "At pariatur consequatur voluptates porro et atque iste eaque.",
"company_ident": "Tempora quo sit illum et.",
"address_id": "VKWQKV",
"address": {
"id": "gD6jDw",
"address_type": "Deleniti maiores labore repellendus rerum voluptas ad.",
"address_lines": "Nostrum similique fugit hic perspiciatis eum voluptas.",
"city": "Et iste soluta sapiente.",
"locality": "Architecto a esse quo consequatur non dicta.",
"administrative_area": "Est eos at adipisci qui porro.",
"post_code": "Expedita aut aliquam qui libero quia sunt magnam consequatur.",
"country": "Quam aut sint recusandae magni est dolor optio aut."
},
"external_references": [
{
"id": "yAvMm5",
"name": "Molestiae fugiat consequatur sit dicta praesentium itaque eveniet.",
"title": "Voluptas et illum et qui.",
"value": "Iure recusandae recusandae non."
}
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove a document party
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/Owm62Y/parties/l3X7w3" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/Owm62Y/parties/l3X7w3"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/Owm62Y/parties/l3X7w3';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/Owm62Y/parties/l3X7w3'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document metadata - Retention
API methods for managing document retention
Get document's retention information
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/aB3Qme/retention" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/aB3Qme/retention"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/aB3Qme/retention';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/aB3Qme/retention'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"end_date": "2006-09-06T19:02:37+00:00"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Set document's retention information
requires authentication
Example request:
curl --request PATCH \
"https://api.docue.com/public/v2/documents/wqvMQ8/retention" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"end_date\": \"1988-09-29T01:16:39+00:00\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/wqvMQ8/retention"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"end_date": "1988-09-29T01:16:39+00:00"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/wqvMQ8/retention';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'end_date' => '1988-09-29T01:16:39+00:00',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/wqvMQ8/retention'
payload = {
"end_date": "1988-09-29T01:16:39+00:00"
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"end_date": "1977-06-20T04:19:44+00:00"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove document's retention information
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/MAkemmq/retention" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/MAkemmq/retention"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/MAkemmq/retention';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/MAkemmq/retention'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Document metadata - Terms and Conditions
API methods for managing document terms and conditions
Get document's terms and conditions information
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/Ovz9oO/terms-and-conditions" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/Ovz9oO/terms-and-conditions"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/Ovz9oO/terms-and-conditions';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/Ovz9oO/terms-and-conditions'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"date": "1983-09-20T05:44:29+00:00",
"effective_date": "2000-06-24T10:37:40+00:00",
"term_end_date": "1989-08-03T15:33:00+00:00",
"signing_date": "2010-04-12T21:17:28+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Set document's terms and conditions information
requires authentication
Example request:
curl --request PATCH \
"https://api.docue.com/public/v2/documents/wOywZL/terms-and-conditions" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"date\": \"1980-08-28T14:09:38+00:00\",
\"effective_date\": \"1988-07-28T22:59:12+00:00\",
\"term_end_date\": \"2015-10-15T00:34:02+00:00\",
\"signing_date\": \"2016-12-01T06:58:48+00:00\",
\"contract_period\": \"P1D\",
\"notice_period\": \"P1D\",
\"duration_type\": \"indefinite\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/wOywZL/terms-and-conditions"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"date": "1980-08-28T14:09:38+00:00",
"effective_date": "1988-07-28T22:59:12+00:00",
"term_end_date": "2015-10-15T00:34:02+00:00",
"signing_date": "2016-12-01T06:58:48+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/wOywZL/terms-and-conditions';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'date' => '1980-08-28T14:09:38+00:00',
'effective_date' => '1988-07-28T22:59:12+00:00',
'term_end_date' => '2015-10-15T00:34:02+00:00',
'signing_date' => '2016-12-01T06:58:48+00:00',
'contract_period' => 'P1D',
'notice_period' => 'P1D',
'duration_type' => 'indefinite',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/wOywZL/terms-and-conditions'
payload = {
"date": "1980-08-28T14:09:38+00:00",
"effective_date": "1988-07-28T22:59:12+00:00",
"term_end_date": "2015-10-15T00:34:02+00:00",
"signing_date": "2016-12-01T06:58:48+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"date": "1996-08-06T10:39:47+00:00",
"effective_date": "2019-06-25T12:54:49+00:00",
"term_end_date": "2004-09-07T20:57:48+00:00",
"signing_date": "2008-12-05T00:07:35+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Remove document's terms and conditions information
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/kORd2Z/terms-and-conditions" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/documents/kORd2Z/terms-and-conditions"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/documents/kORd2Z/terms-and-conditions';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/kORd2Z/terms-and-conditions'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Folders
API methods for managing document folders
List available folders
requires authentication
List folders available to the authenticated user. User must have permission to view the folder for it to be listed.
Results can be filtered by providing the filter route parameter.
Available filters are:
filter[name]=folder namefilter[parent_id]=parent_folder_id
Results can be sorted by providing the sort route parameters. Format is:
sort=[-]parameter
Examples:
sort=namesorts ascending by namesort=-namesorts descending by name
Available sort parameters:
- name
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/folders" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/folders"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/folders';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/folders'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"_type": "folder",
"id": "GZgnWD",
"name": "Molestiae voluptates blanditiis ad placeat eligendi eaque.",
"created_at": "2003-05-23T08:50:13+00:00",
"updated_at": "2003-02-10T16:36:40+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "D50EeO",
"name": "Maiores praesentium nostrum in quis.",
"created_at": "2006-05-15T11:39:32+00:00",
"updated_at": "2013-01-22T06:03:42+00:00",
"parent_id": "0ZABao",
"has_children": true
}
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Show a folder
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/folders/xnB74J" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/folders/xnB74J"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/folders/xnB74J';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/folders/xnB74J'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"_type": "folder",
"id": "jnL3mX",
"name": "Sapiente similique eligendi assumenda nisi.",
"created_at": "1997-05-24T19:18:56+00:00",
"updated_at": "2016-10-07T14:10:34+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "kORJPO",
"name": "Distinctio dolore maiores voluptatem quidem repellendus.",
"created_at": "2006-05-12T09:50:01+00:00",
"updated_at": "2003-06-20T14:39:36+00:00",
"parent_id": "0ZABao",
"has_children": true
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Create a folder
requires authentication
Example request:
curl --request POST \
"https://api.docue.com/public/v2/folders" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Recusandae eius omnis modi animi dicta cumque.\",
\"parent_id\": \"BZV36a\"
}"
const url = new URL(
"https://api.docue.com/public/v2/folders"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Recusandae eius omnis modi animi dicta cumque.",
"parent_id": "BZV36a"
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/folders';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Recusandae eius omnis modi animi dicta cumque.',
'parent_id' => 'BZV36a',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/folders'
payload = {
"name": "Recusandae eius omnis modi animi dicta cumque.",
"parent_id": "BZV36a"
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"_type": "folder",
"id": "LZKzwD",
"name": "Voluptate dolore sit illum.",
"created_at": "1979-04-20T04:36:15+00:00",
"updated_at": "1986-07-02T20:53:54+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "4NrYM1A",
"name": "Ut facilis consequuntur ad.",
"created_at": "1994-01-22T03:51:51+00:00",
"updated_at": "2012-02-23T18:43:35+00:00",
"parent_id": "0ZABao",
"has_children": true
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a folder
requires authentication
Example request:
curl --request PATCH \
"https://api.docue.com/public/v2/folders/M0o5Mj" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"In modi est nostrum quibusdam.\",
\"parent_id\": \"KOqkgZ\"
}"
const url = new URL(
"https://api.docue.com/public/v2/folders/M0o5Mj"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "In modi est nostrum quibusdam.",
"parent_id": "KOqkgZ"
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/folders/M0o5Mj';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'In modi est nostrum quibusdam.',
'parent_id' => 'KOqkgZ',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/folders/M0o5Mj'
payload = {
"name": "In modi est nostrum quibusdam.",
"parent_id": "KOqkgZ"
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"_type": "folder",
"id": "NObxZW",
"name": "Corporis quasi quia aliquam.",
"created_at": "1991-10-09T05:43:53+00:00",
"updated_at": "2012-08-01T06:45:00+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "laekGD",
"name": "Quo qui officiis laboriosam.",
"created_at": "2001-10-01T15:35:18+00:00",
"updated_at": "1996-10-18T23:44:59+00:00",
"parent_id": "0ZABao"
},
"has_children": true
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a folder
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/folders/ZXre9m" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/folders/ZXre9m"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/folders/ZXre9m';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/folders/ZXre9m'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Signing
API methods for signing
Send a PDF file for signing
requires authentication
Current maximum size for the PDF document and each attachments is 13MB per file. If attachments are provided, they will be merged with the primary file before signing to create a single document for signing. Only PDF attachments are supported.
Please note that the route returns a contract - that is, a Docue builder document - the id primary ID is the ID of the underlying contract. If you need the document ID of the document for the rest of the V2 API calls, use the document_id of the response.
Example request:
curl --request POST \
"https://api.docue.com/public/v2/contracts" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "title=Tempora eaque ex quis."\
--form "language=sv"\
--form "folder_id=gD6KYZ"\
--form "signature_method=manual"\
--form "parties[][first_name]=Quos culpa explicabo consequatur itaque."\
--form "parties[][last_name]=Quos at excepturi quis reiciendis debitis."\
--form "parties[][company_title]=Tenetur ut eos et sunt ipsam."\
--form "parties[][company_ident]=Id nisi omnis voluptas sed architecto provident."\
--form "parties[][title]=Quasi illo cupiditate est quis quidem labore."\
--form "parties[][email]=yhauck@hotmail.com"\
--form "parties[][phone]=A odit aut est nihil maiores iusto aut voluptas."\
--form "parties[][message]=Qui vel dicta inventore illo repudiandae amet dolores."\
--form "parties[][language]=fi"\
--form "parties[][country]=GB"\
--form "parties[][order]=73947047"\
--form "parties[][include_completed_in_email]="\
--form "signing_settings[expires_at]=2005-11-14T09:31:38+00:00"\
--form "signing_settings[sender_name]=John Doe"\
--form "signing_settings[message]=Aut voluptates id minus quia voluptatem blanditiis nihil."\
--form "signing_settings[reminders_start]=1990-09-06T11:37:03+00:00"\
--form "signing_settings[reminders_end]=1982-03-20T19:34:07+00:00"\
--form "signing_settings[reminders_duration]=P3D"\
--form "send_invitations="\
--form "file=@/tmp/phpeJdCem" const url = new URL(
"https://api.docue.com/public/v2/contracts"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('title', 'Tempora eaque ex quis.');
body.append('language', 'sv');
body.append('folder_id', 'gD6KYZ');
body.append('signature_method', 'manual');
body.append('parties[][first_name]', 'Quos culpa explicabo consequatur itaque.');
body.append('parties[][last_name]', 'Quos at excepturi quis reiciendis debitis.');
body.append('parties[][company_title]', 'Tenetur ut eos et sunt ipsam.');
body.append('parties[][company_ident]', 'Id nisi omnis voluptas sed architecto provident.');
body.append('parties[][title]', 'Quasi illo cupiditate est quis quidem labore.');
body.append('parties[][email]', 'yhauck@hotmail.com');
body.append('parties[][phone]', 'A odit aut est nihil maiores iusto aut voluptas.');
body.append('parties[][message]', 'Qui vel dicta inventore illo repudiandae amet dolores.');
body.append('parties[][language]', 'fi');
body.append('parties[][country]', 'GB');
body.append('parties[][order]', '73947047');
body.append('parties[][include_completed_in_email]', '');
body.append('signing_settings[expires_at]', '2005-11-14T09:31:38+00:00');
body.append('signing_settings[sender_name]', 'John Doe');
body.append('signing_settings[message]', 'Aut voluptates id minus quia voluptatem blanditiis nihil.');
body.append('signing_settings[reminders_start]', '1990-09-06T11:37:03+00:00');
body.append('signing_settings[reminders_end]', '1982-03-20T19:34:07+00:00');
body.append('signing_settings[reminders_duration]', 'P3D');
body.append('send_invitations', '');
body.append('file', document.querySelector('input[name="file"]').files[0]);
fetch(url, {
method: "POST",
headers,
body,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/contracts';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'title',
'contents' => 'Tempora eaque ex quis.'
],
[
'name' => 'language',
'contents' => 'sv'
],
[
'name' => 'folder_id',
'contents' => 'gD6KYZ'
],
[
'name' => 'signature_method',
'contents' => 'manual'
],
[
'name' => 'parties[][first_name]',
'contents' => 'Quos culpa explicabo consequatur itaque.'
],
[
'name' => 'parties[][last_name]',
'contents' => 'Quos at excepturi quis reiciendis debitis.'
],
[
'name' => 'parties[][company_title]',
'contents' => 'Tenetur ut eos et sunt ipsam.'
],
[
'name' => 'parties[][company_ident]',
'contents' => 'Id nisi omnis voluptas sed architecto provident.'
],
[
'name' => 'parties[][title]',
'contents' => 'Quasi illo cupiditate est quis quidem labore.'
],
[
'name' => 'parties[][email]',
'contents' => 'yhauck@hotmail.com'
],
[
'name' => 'parties[][phone]',
'contents' => 'A odit aut est nihil maiores iusto aut voluptas.'
],
[
'name' => 'parties[][message]',
'contents' => 'Qui vel dicta inventore illo repudiandae amet dolores.'
],
[
'name' => 'parties[][language]',
'contents' => 'fi'
],
[
'name' => 'parties[][country]',
'contents' => 'GB'
],
[
'name' => 'parties[][order]',
'contents' => '73947047'
],
[
'name' => 'parties[][include_completed_in_email]',
'contents' => ''
],
[
'name' => 'signing_settings[expires_at]',
'contents' => '2005-11-14T09:31:38+00:00'
],
[
'name' => 'signing_settings[sender_name]',
'contents' => 'John Doe'
],
[
'name' => 'signing_settings[message]',
'contents' => 'Aut voluptates id minus quia voluptatem blanditiis nihil.'
],
[
'name' => 'signing_settings[reminders_start]',
'contents' => '1990-09-06T11:37:03+00:00'
],
[
'name' => 'signing_settings[reminders_end]',
'contents' => '1982-03-20T19:34:07+00:00'
],
[
'name' => 'signing_settings[reminders_duration]',
'contents' => 'P3D'
],
[
'name' => 'send_invitations',
'contents' => ''
],
[
'name' => 'file',
'contents' => fopen('/tmp/phpeJdCem', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/contracts'
files = {
'title': (None, 'Tempora eaque ex quis.'),
'language': (None, 'sv'),
'folder_id': (None, 'gD6KYZ'),
'signature_method': (None, 'manual'),
'parties[][first_name]': (None, 'Quos culpa explicabo consequatur itaque.'),
'parties[][last_name]': (None, 'Quos at excepturi quis reiciendis debitis.'),
'parties[][company_title]': (None, 'Tenetur ut eos et sunt ipsam.'),
'parties[][company_ident]': (None, 'Id nisi omnis voluptas sed architecto provident.'),
'parties[][title]': (None, 'Quasi illo cupiditate est quis quidem labore.'),
'parties[][email]': (None, 'yhauck@hotmail.com'),
'parties[][phone]': (None, 'A odit aut est nihil maiores iusto aut voluptas.'),
'parties[][message]': (None, 'Qui vel dicta inventore illo repudiandae amet dolores.'),
'parties[][language]': (None, 'fi'),
'parties[][country]': (None, 'GB'),
'parties[][order]': (None, '73947047'),
'parties[][include_completed_in_email]': (None, ''),
'signing_settings[expires_at]': (None, '2005-11-14T09:31:38+00:00'),
'signing_settings[sender_name]': (None, 'John Doe'),
'signing_settings[message]': (None, 'Aut voluptates id minus quia voluptatem blanditiis nihil.'),
'signing_settings[reminders_start]': (None, '1990-09-06T11:37:03+00:00'),
'signing_settings[reminders_end]': (None, '1982-03-20T19:34:07+00:00'),
'signing_settings[reminders_duration]': (None, 'P3D'),
'send_invitations': (None, ''),
'file': open('/tmp/phpeJdCem', 'rb')}
payload = {
"title": "Tempora eaque ex quis.",
"language": "sv",
"folder_id": "gD6KYZ",
"signature_method": "manual",
"attachments": [
[]
],
"parties": [
{
"first_name": "Quos culpa explicabo consequatur itaque.",
"last_name": "Quos at excepturi quis reiciendis debitis.",
"company_title": "Tenetur ut eos et sunt ipsam.",
"company_ident": "Id nisi omnis voluptas sed architecto provident.",
"title": "Quasi illo cupiditate est quis quidem labore.",
"email": "yhauck@hotmail.com",
"phone": "A odit aut est nihil maiores iusto aut voluptas.",
"message": "Qui vel dicta inventore illo repudiandae amet dolores.",
"language": "fi",
"country": "GB",
"order": 73947047,
"include_completed_in_email": false
}
],
"signing_settings": {
"expires_at": "2005-11-14T09:31:38+00:00",
"sender_name": "John Doe",
"message": "Aut voluptates id minus quia voluptatem blanditiis nihil.",
"reminders_start": "1990-09-06T11:37:03+00:00",
"reminders_end": "1982-03-20T19:34:07+00:00",
"reminders_duration": "P3D"
},
"send_invitations": false
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'multipart/form-data',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, files=files)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"_type": "contract",
"id": "NDkdZo",
"name": "Dolorem et dolorum ducimus.",
"stage": "Voluptatem et itaque dolores dolorem optio.",
"document_id": "ZNn825",
"sign_method": "canvas",
"document": {
"download_url": "Error perspiciatis natus officiis non neque dicta.",
"id": "oazqRZ",
"created_at": "2025-12-09T11:07:29.000000Z",
"updated_at": "2025-12-09T11:07:29.000000Z",
"title": "Eos omnis et consequuntur.",
"description": "Hic vitae doloremque rerum molestiae.",
"archive_status": "completed",
"contains_pii": "contains_pii",
"contract_id": "aEexyV",
"folder_id": "aEGY2D",
"folder": {
"_type": "folder",
"id": "YZ9yWZ",
"name": "Placeat veritatis aut placeat labore aut et eum.",
"created_at": "1974-06-12T19:09:48+00:00",
"updated_at": "2010-02-16T00:13:25+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "ZgWzKZ",
"name": "Ipsum magni et nihil assumenda maiores doloribus inventore.",
"created_at": "2003-07-22T01:23:17+00:00",
"updated_at": "1986-01-17T07:57:27+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "1DMlAO",
"owner": {
"id": "wOywZL",
"display_name": "At error ipsam exercitationem sed quis.",
"first_name": "Placeat facilis doloribus cum nostrum ut provident eum.",
"last_name": "Facere ex ipsa aut inventore non et.",
"email": "donnie.howe@rippin.biz",
"language": "pl"
},
"workspace_id": "pZGwzZ",
"workspace": {
"_type": "workspace",
"id": "ZAn3EB",
"name": "Quas tempore perspiciatis eveniet.",
"company_ident": "Non adipisci nemo itaque earum perspiciatis ab.",
"email": "predovic.nikita@hotmail.com",
"root_folder_id": "q0K3Vp6"
},
"file_id": "6kYvKB",
"file": {
"_type": "file",
"id": "2q5PbW",
"filename": "Iusto iure autem esse qui provident hic impedit.",
"size": 2264612.6,
"mime": "Officiis ea ducimus autem maxime et commodi.",
"download_url": "http://www.feeney.com/ipsum-debitis-velit-aut-tempora-excepturi-quis",
"preview_url": "http://www.konopelski.org/necessitatibus-dolor-atque-excepturi-quod"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "WxqgQm",
"value": true,
"property_id": "eDJeRO",
"property": {
"id": "DdWEVj",
"title": "Error adipisci ex eos tenetur ratione adipisci voluptatem.",
"description": "Quia sint explicabo veniam aut.",
"name": "Similique qui quia amet aspernatur eaque.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "Qr90x3",
"workspace": {
"_type": "workspace",
"id": "yNN1q9",
"name": "Totam quia dignissimos earum modi.",
"company_ident": "Fuga deleniti provident dolores molestias magni cupiditate saepe.",
"email": "mariana26@hotmail.com",
"root_folder_id": "zG90VdE"
}
}
}
],
"date_values": [
{
"id": "NePx30j",
"value": "2009-02-24T15:34:13+00:00",
"duration": "P1D",
"basis": "Dolorum id cumque non odio repudiandae et et.",
"property_id": "4LNVdX",
"property": {
"id": "DQyo1P",
"title": "Ut commodi tempora fuga expedita libero et laboriosam.",
"description": "Eius non eos alias et aut.",
"name": "Expedita ex et veniam quae et.",
"source": "system",
"data_type": "numeric",
"workspace_id": "DMN6AZ",
"workspace": {
"_type": "workspace",
"id": "aelE3Z",
"name": "Officia enim necessitatibus atque eligendi omnis voluptates quod.",
"company_ident": "Laborum voluptate eum sed.",
"email": "bulah.rowe@gmail.com",
"root_folder_id": "X5kgbd"
}
}
}
],
"numeric_values": [
{
"id": "OyypJO",
"value": 2.552,
"unit": "Totam et quos nihil ut.",
"property_id": "eDJKRZ",
"property": {
"id": "vNrEyd",
"title": "Omnis et nesciunt quia autem optio.",
"description": "Iure itaque sapiente accusamus repellendus modi est earum.",
"name": "Numquam accusamus consequatur praesentium inventore consectetur dolores sed.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "ml5Yml",
"workspace": {
"_type": "workspace",
"id": "4bzWdgq",
"name": "Velit doloremque sit et quia labore qui adipisci.",
"company_ident": "Ut dolorem nemo cumque illo placeat et.",
"email": "runte.ramona@yahoo.com",
"root_folder_id": "OyP79a"
}
}
}
],
"string_values": [
{
"id": "gD6jDw",
"value": "Eos et ex placeat occaecati commodi magni.",
"property_id": "PMkzVJ",
"property": {
"id": "ajyqN6",
"title": "Aut omnis dolore maxime omnis ut.",
"description": "Sed illum facilis ut ipsam repellat cumque.",
"name": "Voluptatem laudantium rerum sunt.",
"source": "system",
"data_type": "boolean",
"workspace_id": "vNNGlr",
"workspace": {
"_type": "workspace",
"id": "DY6jkZ",
"name": "Dolor aut perspiciatis veritatis qui consectetur aperiam voluptatem est.",
"company_ident": "Facilis et rem enim minus maiores architecto qui.",
"email": "beulah.cummerata@gmail.com",
"root_folder_id": "Dd7PVL"
}
}
}
],
"jurisdictions": [
{
"id": "Z8pn9Z",
"code": "Ut et minima nobis error illo."
}
],
"document_types": [
{
"_type": "document_type",
"id": "Ma2naY",
"name": "Dolore sed tempora animi omnis."
}
],
"parties": [
{
"id": "rjB30y",
"first_name": "Quos quas vel quam nesciunt et quos ad.",
"last_name": "Dignissimos culpa et nisi aliquid officia.",
"email": "kayli78@gmail.com",
"phone": "Est consequuntur doloribus velit omnis aut.",
"title": "Ex facilis molestiae dolores beatae.",
"company_name": "At qui ea totam ullam dolorum nihil aliquid.",
"company_ident": "Non aliquid est et cupiditate pariatur.",
"address_id": "Q3bk8j",
"address": {
"id": "vZreMD",
"address_type": "Eos repellendus doloribus aliquid quo consequatur.",
"address_lines": "Id sunt rerum repellat corrupti.",
"city": "Assumenda voluptatum quia repellat iste nostrum.",
"locality": "Id ut nihil aut numquam sapiente porro ut est.",
"administrative_area": "In placeat quidem explicabo officia.",
"post_code": "Quam omnis officiis eius ea et.",
"country": "Dolores illum non eos et eos."
},
"external_references": [
{
"id": "Dmekb6",
"name": "Est non hic nisi et.",
"title": "Et et blanditiis rem.",
"value": "Sint rerum asperiores quis quia culpa."
}
]
}
],
"reminders": [
{
"id": "6Dd0Dv",
"event_type": "document.reminder",
"title": "Est pariatur non amet doloribus velit."
}
],
"attachments": [
{
"id": "1R4Rpg",
"created_at": "2007-08-05T15:17:52+00:00",
"updated_at": "2005-07-29T13:24:54+00:00",
"file_id": "D527dL",
"file": {
"_type": "file",
"id": "6QooMlG",
"filename": "example.pdf",
"size": 8442533,
"mime": "application/pdf",
"download_url": "http://www.connelly.com/",
"preview_url": "http://www.willms.biz/velit-veritatis-qui-possimus-explicabo-libero-laboriosam-fugit"
}
}
],
"external_references": [
{
"id": "1DMbBZ",
"name": "Et ex quae quae est dolore.",
"title": "Cupiditate veniam cupiditate excepturi harum.",
"value": "Cumque non optio incidunt aut ut aspernatur tempora."
}
],
"tags": [
{
"tag": "Nisi quia corporis eos dolorum ducimus recusandae."
}
],
"terms_and_conditions": {
"date": "1985-03-01T07:55:38+00:00",
"effective_date": "2002-08-19T23:18:22+00:00",
"term_end_date": "2022-08-15T19:34:39+00:00",
"signing_date": "2006-12-24T13:58:05+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "2001-10-25T10:35:51+00:00"
},
"breadcrumb": [
{
"id": "AB5oyb",
"name": "Id sequi qui fuga explicabo et unde cupiditate.",
"depth": 49
}
]
},
"template_id": "Nobis qui est maiores ad.",
"template": {
"id": "p7wzon",
"name": "Ab quidem voluptatem voluptatem sit vel officiis.",
"description": "Eum optio quia nostrum eaque.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "0ZAA7Z",
"display_name": "A commodi quia minus ullam assumenda nihil corrupti.",
"first_name": "Aut esse voluptatem cupiditate dolorem.",
"last_name": "Error harum eos aliquid adipisci aut.",
"email": "zmetz@wisozk.net",
"language": "fi"
},
"signing_settings": {
"id": "ZnLBkV",
"created_at": "2013-05-06T09:00:25+00:00",
"updated_at": "2007-02-02T13:38:51+00:00",
"contract_id": "O4bBJZ",
"message": "Id quidem assumenda voluptatem eum.",
"expires_at": "1977-05-14T04:30:00+00:00",
"reminders_start": "1995-01-28T15:05:46+00:00",
"reminders_end": "1974-11-13T02:48:09+00:00",
"reminders_duration": "P3D"
}
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Templates
API methods for managing templates and their basic properties.
Lists templates available to the workspace
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/templates?filter%5Btype%5D%3Dtailored=tailored" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/templates"
);
const params = {
"filter[type]=tailored": "tailored",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/templates';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'query' => [
'filter[type]=tailored' => 'tailored',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/templates'
params = {
'filter[type]=tailored': 'tailored',
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers, params=params)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"id": "m47woV",
"name": "Cum totam temporibus vel vel quasi.",
"description": "In qui cum delectus tempore vel.",
"type": "tailored"
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Webhooks
API methods for managing webhooks.
Retrieve all workspace's webhooks
requires authentication
List webhooks registered to the workspace.
Results can be filtered by providing the filter route parameter.
Available filters are:
filter[enabled]=true/false
Results can be sorted by providing the sort route parameters. Format is:
sort=[-]parameter
Examples:
sort=namesorts ascending by namesort=-namesorts descending by name
Available sort parameters:
- name
- created_at
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/webhooks" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/webhooks"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/webhooks';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/webhooks'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": [
{
"id": "D675YZ",
"created_at": "1976-04-10T07:47:03+00:00",
"updated_at": "2024-05-27T12:08:42+00:00",
"name": "Dolorum alias et vitae est culpa ratione nostrum.",
"enabled": true,
"description": "Occaecati ut ipsum vero rerum consectetur. Saepe eum ut error. Voluptatibus vel occaecati sit ratione voluptatem autem voluptatibus.",
"accepted_events": [
"document-created",
"document-updated",
"document-metadata-updated"
]
}
]
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Retrieves a single webhook
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/webhooks/Z9Jw7Q" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/webhooks/Z9Jw7Q"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/webhooks/Z9Jw7Q';
$response = $client->get(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/webhooks/Z9Jw7Q'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('GET', url, headers=headers)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "NObxZW",
"created_at": "2006-04-13T16:12:23+00:00",
"updated_at": "2012-11-06T11:51:55+00:00",
"name": "Harum sit consectetur error ut voluptatum tempore atque.",
"enabled": true,
"description": "Pariatur sit consequuntur laboriosam. Quis fugiat quibusdam sit amet. Voluptatem enim sit numquam aut voluptatem vel iure provident. Magni alias nostrum voluptas doloribus provident quia optio vitae.",
"accepted_events": [
"document-created",
"document-updated",
"document-metadata-updated"
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Creates new webhook
requires authentication
Example request:
curl --request POST \
"https://api.docue.com/public/v2/webhooks" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Blanditiis voluptatem ut veniam.\",
\"description\": \"Officiis inventore eos consectetur dolores.\",
\"enabled\": true,
\"accepted_events\": [
\"sign-process-completed\"
],
\"endpoints\": []
}"
const url = new URL(
"https://api.docue.com/public/v2/webhooks"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Blanditiis voluptatem ut veniam.",
"description": "Officiis inventore eos consectetur dolores.",
"enabled": true,
"accepted_events": [
"sign-process-completed"
],
"endpoints": []
};
fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/webhooks';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Blanditiis voluptatem ut veniam.',
'description' => 'Officiis inventore eos consectetur dolores.',
'enabled' => true,
'accepted_events' => [
'sign-process-completed',
],
'endpoints' => [],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/webhooks'
payload = {
"name": "Blanditiis voluptatem ut veniam.",
"description": "Officiis inventore eos consectetur dolores.",
"enabled": true,
"accepted_events": [
"sign-process-completed"
],
"endpoints": []
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "Oq2ogD",
"created_at": "1990-06-17T15:06:26+00:00",
"updated_at": "1973-04-18T15:48:26+00:00",
"name": "Praesentium sed et ducimus aliquid eos.",
"enabled": true,
"description": "Sit ut repudiandae eaque fugiat quas. Magnam in animi iste. Quos unde excepturi ducimus fuga nihil aut consequuntur.",
"accepted_events": [
"document-created",
"document-updated",
"document-metadata-updated"
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Delete a webhook
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/webhooks/NDkdZo" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/webhooks/NDkdZo"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/webhooks/NDkdZo';
$response = $client->delete(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/webhooks/NDkdZo'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('DELETE', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Update a webhook configuration
requires authentication
Example request:
curl --request PATCH \
"https://api.docue.com/public/v2/webhooks/Lpn6WY" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Aliquam autem qui quod eveniet non aliquid.\",
\"description\": \"Adipisci quia omnis rerum aut aspernatur fugiat.\",
\"enabled\": false,
\"accepted_events\": \"sign-process-completed\",
\"endpoints\": []
}"
const url = new URL(
"https://api.docue.com/public/v2/webhooks/Lpn6WY"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Aliquam autem qui quod eveniet non aliquid.",
"description": "Adipisci quia omnis rerum aut aspernatur fugiat.",
"enabled": false,
"accepted_events": "sign-process-completed",
"endpoints": []
};
fetch(url, {
method: "PATCH",
headers,
body: JSON.stringify(body),
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/webhooks/Lpn6WY';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Aliquam autem qui quod eveniet non aliquid.',
'description' => 'Adipisci quia omnis rerum aut aspernatur fugiat.',
'enabled' => false,
'accepted_events' => 'sign-process-completed',
'endpoints' => [],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/webhooks/Lpn6WY'
payload = {
"name": "Aliquam autem qui quod eveniet non aliquid.",
"description": "Adipisci quia omnis rerum aut aspernatur fugiat.",
"enabled": false,
"accepted_events": "sign-process-completed",
"endpoints": []
}
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('PATCH', url, headers=headers, json=payload)
response.json()Example response (200, Successful response with the data. Please note that example responses are generated with fake data and may not be accurate.):
{
"data": {
"id": "OxXp4O",
"created_at": "2007-11-26T20:19:44+00:00",
"updated_at": "2023-01-10T14:07:23+00:00",
"name": "Qui aspernatur magnam atque blanditiis deserunt officiis quia.",
"enabled": true,
"description": "Minus omnis eveniet rerum voluptatem quo dolor consectetur odio. Quis itaque vel blanditiis tempora. Nihil quo quibusdam at culpa voluptatum eos.",
"accepted_events": [
"document-created",
"document-updated",
"document-metadata-updated"
]
}
}
Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.Test a webhook
requires authentication
Fetches the requested document and sends a "document-updated" event to the requested webhook.
Example request:
curl --request POST \
"https://api.docue.com/public/v2/webhooks/ObnPRO/test/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"const url = new URL(
"https://api.docue.com/public/v2/webhooks/ObnPRO/test/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers,
}).then(response => response.json());$client = new \GuzzleHttp\Client();
$url = 'https://api.docue.com/public/v2/webhooks/ObnPRO/test/1';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/webhooks/ObnPRO/test/1'
headers = {
'Authorization': 'Bearer {YOUR_API_TOKEN}',
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request('POST', url, headers=headers)
response.json()Received response:
Request failed with error:
Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.