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/gD6jDw/file" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "file=@/tmp/phpCOdHdn" const url = new URL(
"https://api.docue.com/public/v2/documents/gD6jDw/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/gD6jDw/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/phpCOdHdn', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/gD6jDw/file'
files = {
'file': open('/tmp/phpCOdHdn', '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": "Porro animi laudantium molestiae cumque quia consequatur.",
"id": "JGmob2",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Enim sit vero repellat placeat.",
"description": "Quod fugiat veritatis sed atque.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "ZVp1jk",
"contract": {
"_type": "contract",
"id": "nJRxBv",
"name": "Voluptates dolor quae dolores est voluptatem incidunt explicabo.",
"stage": "Quia quam delectus praesentium cum vel.",
"document_id": "1DMA7D",
"sign_method": "canvas",
"template_id": "Ut autem dolore asperiores maiores.",
"template": {
"id": "DQ9XRD",
"name": "Nisi enim vel illo est non non.",
"description": "Dolore accusantium at enim consequatur minima accusamus illo.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "gD6V6D",
"display_name": "Impedit provident ipsam commodi fugiat dolores amet ipsum.",
"first_name": "Sunt odit ex unde rem dolores est officiis.",
"last_name": "Debitis quo laboriosam sed cum repudiandae consectetur.",
"email": "gcassin@hotmail.com",
"language": "fi"
},
"is_paid": true,
"signing_settings": {
"id": "Z3del0",
"created_at": "1982-04-14T19:44:21+00:00",
"updated_at": "1989-08-01T11:21:49+00:00",
"contract_id": "kORVkO",
"message": "Labore natus dolorum et similique qui.",
"expires_at": "1994-10-29T19:43:43+00:00",
"reminders_start": "2016-03-12T19:51:45+00:00",
"reminders_end": "2024-10-21T03:53:17+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "DWrKEO",
"folder": {
"_type": "folder",
"id": "OREoxa",
"name": "Molestiae similique tempore aliquid rem qui.",
"created_at": "2020-08-08T08:16:11+00:00",
"updated_at": "2000-02-13T01:09:16+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "1DM7aR",
"name": "Aut perferendis beatae voluptatem soluta ut repellendus quos.",
"created_at": "2025-10-17T20:11:16+00:00",
"updated_at": "2016-09-16T21:07:48+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "Ma2bWa",
"owner": {
"id": "gD6jDw",
"display_name": "Autem et aut perspiciatis.",
"first_name": "Id quo recusandae nisi rerum.",
"last_name": "Quibusdam aspernatur porro et iste aspernatur est voluptatem.",
"email": "nikolaus.carol@yahoo.com",
"language": "pl"
},
"workspace_id": "DJl1ga",
"workspace": {
"_type": "workspace",
"id": "LDQ3aq",
"name": "Ipsa et corporis perferendis.",
"company_ident": "Magnam consequuntur repellat qui.",
"email": "jewell.bogan@koch.com",
"root_folder_id": "zOwqoZ"
},
"file_id": "4bdP2LN",
"file": {
"_type": "file",
"id": "ORBlAO",
"filename": "Ut beatae fugiat est.",
"size": 564870912,
"mime": "Repudiandae quia libero et sit.",
"download_url": "http://www.corkery.com/sapiente-aut-rerum-et-in-voluptas-excepturi-aut-harum",
"preview_url": "http://vandervort.com/officia-quia-quas-autem-omnis-ut"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "DWBpnO",
"property_id": "ejQy87",
"property": {
"id": "l8y9gkn",
"title": "Reiciendis sed esse temporibus labore voluptatum.",
"description": "Ea voluptates labore sint.",
"name": "Officia autem suscipit non qui aliquam et et beatae.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "ZX4PBZ",
"workspace": {
"_type": "workspace",
"id": "V3Ynze",
"name": "Cupiditate quas sed occaecati deleniti explicabo sint.",
"company_ident": "Sed magnam quod omnis ullam ut rem.",
"email": "ortiz.lela@kunze.info",
"root_folder_id": "DWn2Lw"
}
}
}
],
"date_values": [
{
"id": "0ZAV9a",
"value": "1993-05-29T04:33:21+00:00",
"duration": "P1D",
"basis": "Placeat unde est quia itaque itaque.",
"property_id": "0ZABao",
"property": {
"id": "gD6jDw",
"title": "Explicabo doloribus quo vero ex neque et.",
"description": "Aperiam accusamus consequatur id eos aut voluptas.",
"name": "Provident ducimus ut sunt dolores asperiores consequatur.",
"source": "system",
"data_type": "date",
"workspace_id": "LDQ3aq",
"workspace": {
"_type": "workspace",
"id": "q8b6mK",
"name": "Occaecati quas numquam repudiandae.",
"company_ident": "Quo laboriosam dolorem omnis corrupti.",
"email": "alaina76@yahoo.com",
"root_folder_id": "ZV3e6a"
}
}
}
],
"numeric_values": [
{
"id": "1DM7aR",
"value": 248.272,
"unit": "Voluptas facilis illo unde fuga illo dolorem et.",
"property_id": "8OvN3O",
"property": {
"id": "XKB8Jm",
"title": "Nobis et nam ea id.",
"description": "At ab aut accusamus dolorem modi.",
"name": "Facilis dolorem commodi explicabo totam sint ut in.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "jmAKVp6",
"workspace": {
"_type": "workspace",
"id": "jJXoLQ",
"name": "Corrupti saepe assumenda atque aliquid.",
"company_ident": "Quo est quisquam voluptate consectetur cupiditate incidunt autem aut.",
"email": "jaida49@gmail.com",
"root_folder_id": "OyzKbD"
}
}
}
],
"string_values": [
{
"id": "A4ydJ86",
"value": "Consequuntur quisquam repellat vitae earum et error labore.",
"property_id": "Ap22mQ6",
"property": {
"id": "ZpEG7y",
"title": "Blanditiis est dolores vero fugit.",
"description": "Aliquid et eum eligendi nemo quod sapiente et.",
"name": "Et ipsa ratione enim quos officiis consequatur.",
"source": "system",
"data_type": "numeric",
"workspace_id": "NDkeda",
"workspace": {
"_type": "workspace",
"id": "gD6jDw",
"name": "Recusandae eos nostrum rerum dolore ad.",
"company_ident": "Quidem perferendis odio eos.",
"email": "leonor54@yahoo.com",
"root_folder_id": "WaBRMa"
}
}
}
],
"jurisdictions": [
{
"id": "2Zlp0Z",
"code": "Facere corrupti ea omnis laborum sit quos enim dolores."
}
],
"document_types": [
{
"_type": "document_type",
"id": "gD610O",
"name": "Dolor provident nostrum cum voluptatem facilis."
}
],
"parties": [
{
"id": "ozXPoB",
"first_name": "Et architecto qui voluptate velit et illo velit.",
"last_name": "Omnis explicabo recusandae molestias nemo dolores aut.",
"email": "alivia.mayert@willms.com",
"phone": "Molestias sunt magnam ducimus delectus.",
"title": "Doloremque repudiandae est odit aut.",
"company_name": "Autem occaecati voluptatem occaecati debitis inventore praesentium velit.",
"company_ident": "Occaecati reiciendis commodi ab odit.",
"address_id": "BZV8dO",
"address": {
"id": "aBy7LY",
"address_type": "Deleniti atque et sint.",
"address_lines": "Molestiae quos sint cumque veniam quo rerum cupiditate.",
"city": "Quia aut non mollitia quia modi.",
"locality": "Fuga saepe totam tempore omnis praesentium amet tenetur.",
"administrative_area": "Culpa et dignissimos tenetur.",
"post_code": "Voluptates dicta hic possimus doloremque.",
"country": "Ipsa explicabo ad quis animi accusamus quia error perferendis."
},
"external_references": [
{
"id": "0ZABao",
"name": "Eos et voluptatem omnis saepe iusto.",
"title": "Rerum veniam placeat eius nesciunt sed quia.",
"value": "Ea ut ut ipsa deserunt sed in dicta et."
}
]
}
],
"reminders": [
{
"id": "2dEll7W",
"event_type": "document.reminder",
"title": "Molestias qui consequatur atque omnis nostrum et."
}
],
"attachments": [
{
"id": "wOywZL",
"created_at": "1984-04-27T05:18:21+00:00",
"updated_at": "1992-02-18T23:38:52+00:00",
"file_id": "laeA3a",
"file": {
"_type": "file",
"id": "ZK0qJa",
"filename": "example.pdf",
"size": 11.3748841,
"mime": "application/pdf",
"download_url": "http://www.corwin.net/debitis-neque-nam-qui-totam-rerum",
"preview_url": "http://www.satterfield.org/odio-laborum-nisi-ut-consequatur-sequi-inventore"
}
}
],
"external_references": [
{
"id": "a2dKEW",
"name": "Molestiae officia numquam rerum voluptas rem qui totam.",
"title": "Doloribus incidunt ad quisquam praesentium.",
"value": "Ut officia ad et aspernatur ut."
}
],
"tags": [
{
"tag": "Occaecati repellendus facere eligendi sit."
}
],
"terms_and_conditions": {
"date": "1981-06-24T05:44:48+00:00",
"effective_date": "2025-12-21T07:59:17+00:00",
"term_end_date": "2009-02-19T06:22:19+00:00",
"signing_date": "1992-05-29T03:17:09+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"retention": {
"end_date": "1981-03-08T22:41:51+00:00"
},
"breadcrumb": [
{
"id": "Zr1B8M",
"name": "Praesentium dolorum et omnis maiores aliquam at.",
"depth": 3000921
}
]
}
}
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": "Et ut quis repudiandae omnis et.",
"id": "lnPmGW",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Sit iure sapiente.",
"description": "Beatae culpa eaque quidem.",
"archive_status": "completed",
"contains_pii": "contains_pii",
"contract_id": "ZgQdgO",
"contract": {
"_type": "contract",
"id": "ZK3rok",
"name": "Amet ducimus ut voluptas nesciunt aut aliquam quis.",
"stage": "Et occaecati corrupti iste asperiores eum eum.",
"document_id": "gD6jjD",
"sign_method": "manual",
"template_id": "Fugiat ut eligendi magni dolore iusto ut.",
"template": {
"id": "aPNGND",
"name": "Sapiente consequatur quibusdam ut at quae esse perferendis.",
"description": "Dicta est eveniet nam pariatur excepturi.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "kvBqd4",
"display_name": "Sint quos quia similique qui delectus.",
"first_name": "Reiciendis autem nulla consectetur sed et consequatur quod.",
"last_name": "Sed reprehenderit et porro explicabo aut consequatur.",
"email": "ostehr@abshire.com",
"language": "de"
},
"signing_settings": {
"id": "1DM6BZ",
"created_at": "2025-04-24T04:26:37+00:00",
"updated_at": "2011-08-14T22:23:44+00:00",
"contract_id": "DM2YJZ",
"message": "Nihil tenetur reprehenderit explicabo eos qui vero deleniti numquam.",
"expires_at": "2004-09-09T10:00:16+00:00",
"reminders_start": "1976-05-17T02:16:34+00:00",
"reminders_end": "2001-10-06T23:26:09+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "vOx1qD",
"folder": {
"_type": "folder",
"id": "bdBWN6",
"name": "Natus voluptate soluta consequatur ab consequatur fugiat voluptates.",
"created_at": "2011-01-03T12:18:36+00:00",
"updated_at": "2003-01-18T05:56:04+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "0ZABao",
"name": "Voluptas sunt libero nemo voluptates beatae qui officia vitae.",
"created_at": "1973-09-26T05:28:38+00:00",
"updated_at": "1994-01-20T21:26:07+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "jZNWao",
"owner": {
"id": "ZA4BPD",
"display_name": "Exercitationem error perferendis incidunt ipsam sit praesentium esse.",
"first_name": "Est aperiam odio ad et dicta.",
"last_name": "Qui consequatur qui quia.",
"email": "waino84@paucek.com",
"language": "sv"
},
"workspace_id": "OR2rkO",
"workspace": {
"_type": "workspace",
"id": "6DdApZ",
"name": "Optio dolorem blanditiis rerum optio.",
"company_ident": "Minima ut sit possimus unde officiis eum non.",
"email": "okeefe.victor@gmail.com",
"root_folder_id": "Z9xbPv"
},
"file_id": "ZN7Nja",
"file": {
"_type": "file",
"id": "noKmBj1",
"filename": "Occaecati cupiditate inventore ipsum qui aliquid maiores laborum.",
"size": 133724.65983,
"mime": "Ex commodi iusto sunt deserunt.",
"download_url": "https://feeney.net/voluptas-dolores-sed-unde-suscipit-inventore-aut.html",
"preview_url": "https://www.miller.info/accusamus-assumenda-enim-rerum-itaque-accusamus"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "DW46eZ",
"value": true,
"property_id": "bBvVKR",
"property": {
"id": "bBNKMx",
"title": "Quam iste rerum illo aut accusantium.",
"description": "Vel quibusdam est harum porro.",
"name": "Qui explicabo est labore quia.",
"source": "system",
"data_type": "string",
"workspace_id": "dvN4nex",
"workspace": {
"_type": "workspace",
"id": "Zn2QMe",
"name": "Accusantium consequatur harum ratione non quibusdam.",
"company_ident": "Accusamus quia cumque voluptatem nesciunt.",
"email": "gilbert56@gmail.com",
"root_folder_id": "O41wJD"
}
}
}
],
"date_values": [
{
"id": "LZ8W9D",
"value": "2020-02-22T21:50:03+00:00",
"duration": "P1D",
"basis": "Officiis officia suscipit voluptas similique autem omnis.",
"property_id": "kM0Jp3",
"property": {
"id": "pZGNYD",
"title": "Quos animi enim eligendi laboriosam voluptatem.",
"description": "Eos saepe veritatis vitae laboriosam doloremque.",
"name": "Doloremque at inventore sequi velit eos reprehenderit.",
"source": "system",
"data_type": "string",
"workspace_id": "BZ3JDp",
"workspace": {
"_type": "workspace",
"id": "NDkdZo",
"name": "Illo officiis molestiae sed.",
"company_ident": "Maiores enim itaque nisi maiores ex.",
"email": "paula.bergstrom@gmail.com",
"root_folder_id": "m4L89V"
}
}
}
],
"numeric_values": [
{
"id": "l8MyB8",
"value": 661466001.972,
"unit": "Ut sint ex aut reprehenderit quos fugiat ducimus.",
"property_id": "DQ7YLL",
"property": {
"id": "1DM7aR",
"title": "Consectetur ut ducimus labore voluptatibus aut quas.",
"description": "Iusto provident nemo quidem facilis iusto totam.",
"name": "Ut aut possimus veritatis totam reprehenderit.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "MDWznO",
"workspace": {
"_type": "workspace",
"id": "M40B0j8",
"name": "Voluptatem ex autem aut nulla rem tempora repellat et.",
"company_ident": "Vel consequatur modi qui aut necessitatibus repellat.",
"email": "wilford.douglas@gmail.com",
"root_folder_id": "0ZA0kD"
}
}
}
],
"string_values": [
{
"id": "aE50K5",
"value": "Quia ut quia temporibus adipisci aut eligendi voluptate.",
"property_id": "7ajJva",
"property": {
"id": "LDQ3aq",
"title": "Quia et aperiam eaque commodi commodi dolor.",
"description": "Esse veniam incidunt sit repellendus autem.",
"name": "Aut eveniet omnis est saepe earum sapiente aut.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "Ddvg6L",
"workspace": {
"_type": "workspace",
"id": "azEMRZ",
"name": "Ea autem et iste perspiciatis consequuntur fugiat sunt.",
"company_ident": "Repudiandae molestiae qui est nemo porro sint aut.",
"email": "chanelle.bradtke@gmail.com",
"root_folder_id": "BaEMaV"
}
}
}
],
"jurisdictions": [
{
"id": "0nNx5Ar",
"code": "Sunt ex ut cumque quos quisquam beatae magnam."
}
],
"document_types": [
{
"_type": "document_type",
"id": "zOw9oZ",
"name": "Recusandae sed odit consequuntur eius."
}
],
"parties": [
{
"id": "aEqR7a",
"first_name": "Repellendus voluptatem magnam quo est quasi fuga nisi.",
"last_name": "Vitae voluptatem dolorem rerum voluptas nesciunt quia.",
"email": "minnie.nicolas@gmail.com",
"phone": "Esse ut tempora quas officia occaecati sint id.",
"title": "Eveniet aperiam ut rerum aut.",
"company_name": "Aut quo quis similique.",
"company_ident": "Facilis sequi animi perspiciatis voluptas.",
"address_id": "0ZABao",
"address": {
"id": "v9X1B6A",
"address_type": "Vel atque rerum deleniti aut.",
"address_lines": "A ipsum cum debitis animi id voluptatem.",
"city": "Est a voluptatum at magni.",
"locality": "Veritatis est sit qui est.",
"administrative_area": "Ut quas numquam veritatis voluptas alias et reiciendis.",
"post_code": "Suscipit eos maiores modi doloremque voluptatem nihil.",
"country": "Quos provident consequuntur maiores commodi impedit ut."
},
"external_references": [
{
"id": "5gjezL",
"name": "A similique ex praesentium quidem adipisci porro id.",
"title": "Ut illum veniam sunt qui.",
"value": "Eum iure eveniet velit."
}
]
}
],
"reminders": [
{
"id": "OvmRea",
"event_type": "document.reminder",
"title": "Eum fugiat nulla est qui."
}
],
"attachments": [
{
"id": "a2pgWj",
"created_at": "2011-09-17T20:52:26+00:00",
"updated_at": "1986-12-22T06:26:40+00:00",
"file_id": "q64oGq",
"file": {
"_type": "file",
"id": "ZV3eWd",
"filename": "example.pdf",
"size": 2398117.82588319,
"mime": "application/pdf",
"download_url": "http://www.weber.info/et-quo-deleniti-voluptatem-nobis-quis-assumenda-dolor",
"preview_url": "http://murray.org/eum-non-facere-quo-nam-aut-occaecati"
}
}
],
"external_references": [
{
"id": "rq49wl",
"name": "Nam quam impedit cupiditate quisquam.",
"title": "Earum alias ducimus numquam eum sed commodi nihil.",
"value": "Ut necessitatibus nemo et recusandae a ut quam voluptatibus."
}
],
"tags": [
{
"tag": "Et vero quia debitis et sequi."
}
],
"terms_and_conditions": {
"date": "2001-03-07T08:34:12+00:00",
"effective_date": "2017-07-07T02:11:15+00:00",
"term_end_date": "1990-08-13T17:23:03+00:00",
"signing_date": "2021-02-04T23:05:41+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"retention": {
"end_date": "1987-08-03T16:19:12+00:00"
},
"breadcrumb": [
{
"id": "Wq0q9Em",
"name": "Modi et sit eum placeat nam nesciunt perferendis.",
"depth": 3
}
]
}
]
}
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\": \"DkbydO\",
\"owner_id\": \"2ZlLRZ\",
\"documents\": [
{
\"title\": \"At sunt voluptatem voluptates dolores.\",
\"description\": \"Excepturi voluptatem provident non est natus natus.\",
\"metadata\": {
\"document_types\": [],
\"jurisdictions\": [],
\"tags\": [],
\"languages\": [],
\"terms_and_conditions\": {
\"date\": \"2024-09-18T13:08:40+00:00\",
\"effective_date\": \"2012-09-16T11:27:51+00:00\",
\"term_end_date\": \"2018-12-04T01:15:21+00:00\",
\"signing_date\": \"2013-10-28T23:12:04+00:00\",
\"contract_period\": \"P1D\",
\"notice_period\": \"P1D\",
\"duration_type\": \"one-off\"
},
\"parties\": {
\"first_name\": \"Jane\",
\"last_name\": \"Doe\",
\"email\": \"jerry.wuckert@lebsack.com\",
\"phone\": \"+358401231231\",
\"title\": \"President\",
\"company_name\": \"Cumque velit dignissimos magni amet et illo.\",
\"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\": \"Laboriosam quos est ab aliquid adipisci vitae.\",
\"title\": \"Pariatur exercitationem ex sed sequi est deleniti ea.\",
\"value\": \"Exercitationem et rem neque.\"
}
},
\"properties\": {
\"property_id\": \"aPMQYY\",
\"value\": \"1999-04-09T03:35:37+00:00\",
\"duration\": \"Minus qui dicta voluptatem.\",
\"basis\": \"Accusamus minima vero quaerat voluptas et quo.\",
\"unit\": \"Eaque est officia aut.\"
},
\"external_references\": {
\"name\": \"Facilis repellat velit doloribus nesciunt quaerat dolor et quo.\",
\"title\": \"Adipisci repellat qui voluptas qui totam.\",
\"value\": \"Et enim aliquid necessitatibus quos id et assumenda et.\"
}
},
\"archive_status\": \"completed\",
\"reminders\": {
\"event_type\": \"document.reminder\",
\"title\": \"Et voluptatem quis voluptas nihil rerum quo.\",
\"schedules\": {
\"next_run\": \"2017-02-02T08:42:49+00:00\",
\"id\": \"OvbweO\",
\"last_run\": \"2013-10-14T06:28:20+00:00\",
\"interval\": 22170566
},
\"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": "DkbydO",
"owner_id": "2ZlLRZ",
"documents": [
{
"title": "At sunt voluptatem voluptates dolores.",
"description": "Excepturi voluptatem provident non est natus natus.",
"metadata": {
"document_types": [],
"jurisdictions": [],
"tags": [],
"languages": [],
"terms_and_conditions": {
"date": "2024-09-18T13:08:40+00:00",
"effective_date": "2012-09-16T11:27:51+00:00",
"term_end_date": "2018-12-04T01:15:21+00:00",
"signing_date": "2013-10-28T23:12:04+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"parties": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jerry.wuckert@lebsack.com",
"phone": "+358401231231",
"title": "President",
"company_name": "Cumque velit dignissimos magni amet et illo.",
"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": "Laboriosam quos est ab aliquid adipisci vitae.",
"title": "Pariatur exercitationem ex sed sequi est deleniti ea.",
"value": "Exercitationem et rem neque."
}
},
"properties": {
"property_id": "aPMQYY",
"value": "1999-04-09T03:35:37+00:00",
"duration": "Minus qui dicta voluptatem.",
"basis": "Accusamus minima vero quaerat voluptas et quo.",
"unit": "Eaque est officia aut."
},
"external_references": {
"name": "Facilis repellat velit doloribus nesciunt quaerat dolor et quo.",
"title": "Adipisci repellat qui voluptas qui totam.",
"value": "Et enim aliquid necessitatibus quos id et assumenda et."
}
},
"archive_status": "completed",
"reminders": {
"event_type": "document.reminder",
"title": "Et voluptatem quis voluptas nihil rerum quo.",
"schedules": {
"next_run": "2017-02-02T08:42:49+00:00",
"id": "OvbweO",
"last_run": "2013-10-14T06:28:20+00:00",
"interval": 22170566
},
"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' => 'DkbydO',
'owner_id' => '2ZlLRZ',
'documents' => [
[
'title' => 'At sunt voluptatem voluptates dolores.',
'description' => 'Excepturi voluptatem provident non est natus natus.',
'metadata' => [
'document_types' => [],
'jurisdictions' => [],
'tags' => [],
'languages' => [],
'terms_and_conditions' => [
'date' => '2024-09-18T13:08:40+00:00',
'effective_date' => '2012-09-16T11:27:51+00:00',
'term_end_date' => '2018-12-04T01:15:21+00:00',
'signing_date' => '2013-10-28T23:12:04+00:00',
'contract_period' => 'P1D',
'notice_period' => 'P1D',
'duration_type' => 'one-off',
],
'parties' => [
'first_name' => 'Jane',
'last_name' => 'Doe',
'email' => 'jerry.wuckert@lebsack.com',
'phone' => '+358401231231',
'title' => 'President',
'company_name' => 'Cumque velit dignissimos magni amet et illo.',
'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' => 'Laboriosam quos est ab aliquid adipisci vitae.',
'title' => 'Pariatur exercitationem ex sed sequi est deleniti ea.',
'value' => 'Exercitationem et rem neque.',
],
],
'properties' => [
'property_id' => 'aPMQYY',
'value' => '1999-04-09T03:35:37+00:00',
'duration' => 'Minus qui dicta voluptatem.',
'basis' => 'Accusamus minima vero quaerat voluptas et quo.',
'unit' => 'Eaque est officia aut.',
],
'external_references' => [
'name' => 'Facilis repellat velit doloribus nesciunt quaerat dolor et quo.',
'title' => 'Adipisci repellat qui voluptas qui totam.',
'value' => 'Et enim aliquid necessitatibus quos id et assumenda et.',
],
],
'archive_status' => 'completed',
'reminders' => [
'event_type' => 'document.reminder',
'title' => 'Et voluptatem quis voluptas nihil rerum quo.',
'schedules' => [
'next_run' => '2017-02-02T08:42:49+00:00',
'id' => 'OvbweO',
'last_run' => '2013-10-14T06:28:20+00:00',
'interval' => 22170566,
],
'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": "DkbydO",
"owner_id": "2ZlLRZ",
"documents": [
{
"title": "At sunt voluptatem voluptates dolores.",
"description": "Excepturi voluptatem provident non est natus natus.",
"metadata": {
"document_types": [],
"jurisdictions": [],
"tags": [],
"languages": [],
"terms_and_conditions": {
"date": "2024-09-18T13:08:40+00:00",
"effective_date": "2012-09-16T11:27:51+00:00",
"term_end_date": "2018-12-04T01:15:21+00:00",
"signing_date": "2013-10-28T23:12:04+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"parties": {
"first_name": "Jane",
"last_name": "Doe",
"email": "jerry.wuckert@lebsack.com",
"phone": "+358401231231",
"title": "President",
"company_name": "Cumque velit dignissimos magni amet et illo.",
"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": "Laboriosam quos est ab aliquid adipisci vitae.",
"title": "Pariatur exercitationem ex sed sequi est deleniti ea.",
"value": "Exercitationem et rem neque."
}
},
"properties": {
"property_id": "aPMQYY",
"value": "1999-04-09T03:35:37+00:00",
"duration": "Minus qui dicta voluptatem.",
"basis": "Accusamus minima vero quaerat voluptas et quo.",
"unit": "Eaque est officia aut."
},
"external_references": {
"name": "Facilis repellat velit doloribus nesciunt quaerat dolor et quo.",
"title": "Adipisci repellat qui voluptas qui totam.",
"value": "Et enim aliquid necessitatibus quos id et assumenda et."
}
},
"archive_status": "completed",
"reminders": {
"event_type": "document.reminder",
"title": "Et voluptatem quis voluptas nihil rerum quo.",
"schedules": {
"next_run": "2017-02-02T08:42:49+00:00",
"id": "OvbweO",
"last_run": "2013-10-14T06:28:20+00:00",
"interval": 22170566
},
"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": "Modi consequuntur officia consequatur tempore culpa nostrum omnis.",
"id": "q8mxvbK",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "A consequatur ut odio.",
"description": "Laborum non vel sit nostrum optio vel at dolorem.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "Zgd2o9",
"contract": {
"_type": "contract",
"id": "DMRbXk",
"name": "Tempore quia deleniti quis in.",
"stage": "Cumque non sit laudantium maiores corporis nemo totam.",
"document_id": "Ma2Jna",
"sign_method": "manual",
"template_id": "Omnis rerum quo expedita dignissimos.",
"template": {
"id": "1DMBBZ",
"name": "Qui sint laboriosam eligendi quia reiciendis esse dolore sit.",
"description": "Et ea tempore necessitatibus et quos eligendi.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "BaEMaV",
"display_name": "Quaerat voluptatibus ut fuga.",
"first_name": "Velit officiis quia corrupti cupiditate molestiae temporibus excepturi.",
"last_name": "Ipsa necessitatibus aut ipsam est cupiditate maxime commodi.",
"email": "alysha79@yahoo.com",
"language": "en"
},
"is_paid": true,
"signing_settings": {
"id": "ORo2qD",
"created_at": "1982-11-15T22:56:38+00:00",
"updated_at": "1973-09-10T01:16:44+00:00",
"contract_id": "zLgeb8",
"message": "Eveniet aliquam cumque molestiae aspernatur.",
"expires_at": "2003-04-20T06:29:10+00:00",
"reminders_start": "1995-12-15T07:24:10+00:00",
"reminders_end": "2006-07-22T01:33:04+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "8Ovb3O",
"folder": {
"_type": "folder",
"id": "D5KKNa",
"name": "Iure eaque praesentium sed id.",
"created_at": "1981-02-24T22:05:44+00:00",
"updated_at": "2024-07-16T03:08:23+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "5vnRQX",
"name": "Porro quidem voluptatem reprehenderit optio rem doloremque dicta.",
"created_at": "1985-10-05T00:14:37+00:00",
"updated_at": "1972-02-21T22:23:49+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "XryvqP",
"owner": {
"id": "DJLg0g",
"display_name": "Voluptatem ex praesentium et consequuntur nihil repellat facere.",
"first_name": "Omnis sit eum id earum odio voluptatibus sint quasi.",
"last_name": "Vero natus in quia quaerat minus.",
"email": "joesph35@hotmail.com",
"language": "de"
},
"workspace_id": "a2nxrG",
"workspace": {
"_type": "workspace",
"id": "eDJ0a1",
"name": "Doloribus commodi id harum voluptas impedit.",
"company_ident": "Officia officia veritatis autem qui.",
"email": "hgrady@streich.com",
"root_folder_id": "lae3ED"
},
"file_id": "GZgWAZ",
"file": {
"_type": "file",
"id": "Oqx0eo",
"filename": "Fuga et labore accusantium.",
"size": 7.274,
"mime": "Debitis quos delectus qui ad.",
"download_url": "http://spinka.com/",
"preview_url": "http://www.hoeger.com/"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "ZlLJnZ",
"value": true,
"property_id": "OyNlJD",
"property": {
"id": "OxWQja",
"title": "Animi a molestias earum eos ut omnis consequatur.",
"description": "Eveniet maxime quibusdam quae.",
"name": "Eum occaecati quasi atque officiis.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "bRq0vR",
"workspace": {
"_type": "workspace",
"id": "2Zln3O",
"name": "Quia sit ut deleniti animi voluptatem.",
"company_ident": "Praesentium nesciunt perspiciatis fugit.",
"email": "lisette.mueller@yahoo.com",
"root_folder_id": "mO7qZe"
}
}
}
],
"date_values": [
{
"id": "KJnGwg",
"value": "1972-02-27T10:58:31+00:00",
"duration": "P1D",
"basis": "Tenetur sed est numquam fuga sint soluta saepe autem.",
"property_id": "NDkdZo",
"property": {
"id": "zw8m53",
"title": "Id fugit magnam et sed molestiae.",
"description": "Suscipit aperiam fugit rerum ea a id eos aut.",
"name": "Hic aut et sunt.",
"source": "system",
"data_type": "date",
"workspace_id": "Oqd988",
"workspace": {
"_type": "workspace",
"id": "ae06x2",
"name": "Aut in ex similique accusamus.",
"company_ident": "Voluptatem consequuntur omnis et cupiditate aperiam optio maiores.",
"email": "carroll.bertha@yahoo.com",
"root_folder_id": "LDQoEa"
}
}
}
],
"numeric_values": [
{
"id": "kemzpz",
"value": 33349949.6808,
"unit": "Possimus officia ut nam.",
"property_id": "ekENb7",
"property": {
"id": "4aLNGD",
"title": "Id quaerat et officiis sed.",
"description": "Quas culpa corrupti voluptates aut iste.",
"name": "Non et repellat et neque ipsam quas aut.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "eDJ0a1",
"workspace": {
"_type": "workspace",
"id": "DJ2K5o",
"name": "Doloribus unde possimus soluta est molestiae.",
"company_ident": "Sequi quaerat omnis dolorem dolor molestiae necessitatibus delectus alias.",
"email": "hope.abernathy@hotmail.com",
"root_folder_id": "5aP0Ra"
}
}
}
],
"string_values": [
{
"id": "9nYgr2P",
"value": "Aspernatur vitae sequi et.",
"property_id": "vOx1qD",
"property": {
"id": "1DM7aR",
"title": "Ut voluptas consequatur eos possimus unde minus facere.",
"description": "Modi dolore dolores et aliquam.",
"name": "In enim minus dolorem est dolore similique eius.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "jJXy2Rd",
"workspace": {
"_type": "workspace",
"id": "laew8D",
"name": "Est omnis animi omnis minima similique.",
"company_ident": "Ducimus ducimus nobis accusamus natus qui.",
"email": "catalina67@bartoletti.com",
"root_folder_id": "NDkzKO"
}
}
}
],
"jurisdictions": [
{
"id": "6Dd90Z",
"code": "Incidunt enim dolores quisquam facilis vel non officiis."
}
],
"document_types": [
{
"_type": "document_type",
"id": "wOyAwO",
"name": "Quis ex dolorem quis provident nisi."
}
],
"parties": [
{
"id": "NObxZW",
"first_name": "Quod id eaque tempore sunt esse magnam qui.",
"last_name": "Non incidunt sit mollitia doloremque error iusto adipisci eveniet.",
"email": "qhagenes@yahoo.com",
"phone": "Omnis et magni dolores.",
"title": "Magnam delectus enim consectetur eos.",
"company_name": "Dignissimos qui excepturi ut in tempore iure nobis.",
"company_ident": "Suscipit nam saepe dolores dolorem eveniet dolorem aut vero.",
"address_id": "gD6jDw",
"address": {
"id": "ZAo22O",
"address_type": "Molestiae numquam ea nobis pariatur.",
"address_lines": "Labore modi maiores ut architecto.",
"city": "Mollitia sed ut cumque eligendi assumenda dolores expedita.",
"locality": "Accusamus qui necessitatibus molestiae dolores fuga pariatur aut tenetur.",
"administrative_area": "At laudantium unde dolorum aut itaque enim facilis.",
"post_code": "Non expedita at itaque sint aut quisquam consequatur deleniti.",
"country": "Quis esse hic laborum quod id unde."
},
"external_references": [
{
"id": "eb99wr2",
"name": "Id itaque a et molestias deleniti.",
"title": "Quibusdam voluptas provident doloremque soluta qui aut eius.",
"value": "Voluptatem sequi rerum saepe."
}
]
}
],
"reminders": [
{
"id": "ZgbReK",
"event_type": "document.reminder",
"title": "Iure voluptatibus ab eius asperiores."
}
],
"attachments": [
{
"id": "QpBWEE",
"created_at": "2004-01-03T21:03:08+00:00",
"updated_at": "2005-04-04T19:08:02+00:00",
"file_id": "yA0Gr1w",
"file": {
"_type": "file",
"id": "QBWmk8",
"filename": "example.pdf",
"size": 6.831272175,
"mime": "application/pdf",
"download_url": "http://botsford.com/nobis-nihil-animi-esse-et-unde.html",
"preview_url": "http://ruecker.com/"
}
}
],
"external_references": [
{
"id": "yyxWv73",
"name": "Rerum architecto qui itaque pariatur dolorum ut veniam.",
"title": "Nulla quaerat earum culpa eos.",
"value": "Odio velit quisquam itaque reprehenderit."
}
],
"tags": [
{
"tag": "Dolorem sint aliquam quos quia et."
}
],
"terms_and_conditions": {
"date": "2024-11-27T01:02:16+00:00",
"effective_date": "2001-11-03T00:59:51+00:00",
"term_end_date": "2010-08-04T00:49:53+00:00",
"signing_date": "2015-04-11T13:07:45+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
},
"retention": {
"end_date": "1996-11-07T07:31:00+00:00"
},
"breadcrumb": [
{
"id": "nJEj1e",
"name": "Et tempore molestiae explicabo dolorum culpa.",
"depth": 982220
}
]
}
]
}
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/qzgyjW" \
--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/qzgyjW"
);
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/qzgyjW';
$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/qzgyjW'
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": "Excepturi laudantium nulla dolor fugiat.",
"id": "eDJ0a1",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Dolorem omnis eveniet.",
"description": "Sit velit qui enim et sed.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "eDJ20D",
"contract": {
"_type": "contract",
"id": "jJYwgx",
"name": "Deserunt sequi maxime vel voluptas.",
"stage": "Deserunt ut adipisci reprehenderit consequuntur qui cumque veniam.",
"document_id": "vZr97D",
"sign_method": "canvas",
"template_id": "Corrupti sequi quos numquam unde et aperiam.",
"template": {
"id": "ajn06B",
"name": "Exercitationem hic voluptas quam dolorem dolor magnam.",
"description": "Earum nam labore maxime sed omnis vitae reprehenderit.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "Nenmo8",
"display_name": "Vel explicabo velit ipsam accusantium et et.",
"first_name": "Dolore ipsam consequatur ab dicta labore maiores.",
"last_name": "Quam magnam soluta est vel totam nihil.",
"email": "effie.reichel@boyer.com",
"language": "en"
},
"is_paid": true,
"signing_settings": {
"id": "x1473yW",
"created_at": "1989-11-26T00:45:14+00:00",
"updated_at": "1988-09-03T15:46:25+00:00",
"contract_id": "G2PljR",
"message": "Qui quia sed est beatae et et ut.",
"expires_at": "1995-12-18T12:24:05+00:00",
"reminders_start": "1986-08-13T02:34:58+00:00",
"reminders_end": "2015-05-25T15:03:59+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "ZG293Y",
"folder": {
"_type": "folder",
"id": "ObKJx4",
"name": "Optio eos autem ullam omnis cupiditate.",
"created_at": "1983-11-18T22:09:36+00:00",
"updated_at": "2002-12-25T21:37:16+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "kbY9px",
"name": "Fuga exercitationem sed minus.",
"created_at": "2003-05-23T03:54:04+00:00",
"updated_at": "1986-04-22T22:58:02+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "eo895n",
"owner": {
"id": "ED5rMZ",
"display_name": "Ipsa error nemo voluptatum molestias officia dignissimos.",
"first_name": "Omnis nesciunt soluta repellendus.",
"last_name": "Aut deserunt laudantium sunt magnam eos quo.",
"email": "armstrong.melyna@gmail.com",
"language": "fi"
},
"workspace_id": "KMpqym",
"workspace": {
"_type": "workspace",
"id": "KOq8Wa",
"name": "Optio ea veniam consectetur voluptatem.",
"company_ident": "Voluptatem tempora consectetur animi mollitia expedita.",
"email": "edd68@gmail.com",
"root_folder_id": "ZKJGd1"
},
"file_id": "EGNA5y",
"file": {
"_type": "file",
"id": "7aj6Ka",
"filename": "Dolor ducimus similique dignissimos optio.",
"size": 72973.017499,
"mime": "Eos beatae animi omnis facere in quaerat.",
"download_url": "https://nader.biz/dolores-ut-ut-aut.html",
"preview_url": "http://carroll.com/et-ea-quis-corrupti-quod-omnis-facilis-dignissimos-hic"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "7AJE15",
"property_id": "eDJ0a1",
"property": {
"id": "YjwrRv",
"title": "Ad consequatur nobis cumque.",
"description": "Dolore molestias non voluptatibus ullam.",
"name": "Reprehenderit nulla quia quam earum quia in omnis.",
"source": "system",
"data_type": "date",
"workspace_id": "4aLQNO",
"workspace": {
"_type": "workspace",
"id": "vNWX05v",
"name": "Omnis ipsa blanditiis voluptas rerum.",
"company_ident": "Dolorum odio totam dignissimos laboriosam reprehenderit ex.",
"email": "yweimann@hotmail.com",
"root_folder_id": "OR7XLD"
}
}
}
],
"date_values": [
{
"id": "0ZABao",
"value": "1982-03-12T04:24:35+00:00",
"duration": "P1D",
"basis": "Possimus et similique reprehenderit.",
"property_id": "aEjjMO",
"property": {
"id": "Oxkkqa",
"title": "Quod ut debitis rerum ipsum vero et facilis.",
"description": "Neque provident voluptas aut recusandae veniam eos reprehenderit.",
"name": "Aut ut veritatis odit.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "BKWmrE",
"workspace": {
"_type": "workspace",
"id": "jyzR49X",
"name": "Qui repellendus pariatur in.",
"company_ident": "Iste ut beatae minus.",
"email": "flatley.eduardo@yahoo.com",
"root_folder_id": "rlPENV"
}
}
}
],
"numeric_values": [
{
"id": "laeWzD",
"value": 20409.3,
"unit": "Ea ut dolore at quidem eaque.",
"property_id": "AQGGnx",
"property": {
"id": "6QpWPgY",
"title": "Maxime dolorum alias non consectetur consequatur corrupti expedita.",
"description": "Et adipisci asperiores consequatur facere porro dolores fuga sit.",
"name": "Et consequatur rerum qui fuga reprehenderit.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "pw8wGN",
"workspace": {
"_type": "workspace",
"id": "4N8rWgQ",
"name": "Soluta alias eveniet ipsum ut non magni mollitia.",
"company_ident": "Atque consectetur rem eveniet vero voluptas.",
"email": "emmerich.angie@hotmail.com",
"root_folder_id": "ZApqR9"
}
}
}
],
"string_values": [
{
"id": "DYqY2k",
"value": "Minima est sed quo odit.",
"property_id": "Dk2NLO",
"property": {
"id": "Ow2nza",
"title": "Ratione qui est magni nemo consequatur.",
"description": "Mollitia eligendi quisquam qui ex est vel.",
"name": "Et ducimus non dolorem nostrum.",
"source": "system",
"data_type": "date",
"workspace_id": "Bl08wQ",
"workspace": {
"_type": "workspace",
"id": "pZ1QgZ",
"name": "Eligendi tempora laboriosam sapiente laboriosam doloremque placeat culpa quo.",
"company_ident": "Et dolore consequatur est illum repudiandae.",
"email": "dcarroll@hotmail.com",
"root_folder_id": "ajneya"
}
}
}
],
"jurisdictions": [
{
"id": "wOywZL",
"code": "Vel est necessitatibus fugiat."
}
],
"document_types": [
{
"_type": "document_type",
"id": "aewXzL",
"name": "Iure excepturi in id nemo natus aut unde."
}
],
"parties": [
{
"id": "ZV35da",
"first_name": "Quia perferendis et sit consequuntur beatae dolores.",
"last_name": "Excepturi est necessitatibus qui blanditiis.",
"email": "mackenzie59@hotmail.com",
"phone": "Unde pariatur maxime debitis et quia.",
"title": "Harum est quis eum inventore accusamus.",
"company_name": "Mollitia blanditiis rerum deleniti minus.",
"company_ident": "Iusto necessitatibus cum sit tempore.",
"address_id": "NObxZW",
"address": {
"id": "NObxZW",
"address_type": "Iure quo architecto ut.",
"address_lines": "Ipsum est recusandae laudantium nobis ea ducimus.",
"city": "Libero molestiae ab natus veniam.",
"locality": "Maxime nihil architecto ducimus dicta et reiciendis dolorem deleniti.",
"administrative_area": "Magnam ratione alias rerum ut et omnis.",
"post_code": "Sed nihil at animi iure ut totam.",
"country": "Non harum qui quae explicabo vel quasi mollitia."
},
"external_references": [
{
"id": "DJLmwa",
"name": "Eaque vel nisi architecto.",
"title": "Repudiandae explicabo aut sed laborum delectus iure.",
"value": "Dolorum quia provident rerum fuga sed eos placeat."
}
]
}
],
"reminders": [
{
"id": "g5ljNE",
"event_type": "document.reminder",
"title": "Deserunt voluptatibus sit totam voluptates necessitatibus."
}
],
"attachments": [
{
"id": "gD6jDw",
"created_at": "2018-09-06T12:07:22+00:00",
"updated_at": "2018-06-20T18:10:13+00:00",
"file_id": "OyNgAD",
"file": {
"_type": "file",
"id": "ZgWolQ",
"filename": "example.pdf",
"size": 1086982.9,
"mime": "application/pdf",
"download_url": "https://braun.net/id-aut-odit-voluptatem.html",
"preview_url": "http://www.heller.com/"
}
}
],
"external_references": [
{
"id": "wOyYJO",
"name": "Cum autem qui est debitis non.",
"title": "Possimus magni soluta velit omnis cumque eos itaque quibusdam.",
"value": "Ratione aut incidunt dolores quia voluptatibus optio hic."
}
],
"tags": [
{
"tag": "Ipsam quidem et error officiis."
}
],
"terms_and_conditions": {
"date": "1983-01-01T05:48:45+00:00",
"effective_date": "1985-06-18T20:51:27+00:00",
"term_end_date": "1971-05-20T15:53:32+00:00",
"signing_date": "1972-08-20T20:48:38+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
},
"retention": {
"end_date": "2022-10-18T13:38:51+00:00"
},
"breadcrumb": [
{
"id": "ZK06Ea",
"name": "Itaque quam quidem suscipit optio error porro autem.",
"depth": 143789
}
]
}
}
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/Ddz3da" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Architecto ex dolorum laborum aut.\",
\"description\": \"Molestiae quod qui in qui sed tempora totam distinctio.\",
\"archive_status\": \"Porro et et quod est est error est.\",
\"folder_id\": \"a27glG\",
\"owner_id\": \"ZXP0dm\",
\"contains_pii\": \"no_pii\",
\"contract\": {
\"name\": \"Sed delectus tempore fugiat est ex ad voluptatibus ea.\",
\"creator_name\": \"Ut fugit odit provident tempore.\",
\"sign_method\": \"docusign\",
\"signing_settings\": {
\"expires_at\": \"2016-07-11T09:47:44+00:00\",
\"sender_name\": \"John Doe\",
\"message\": \"Et harum fuga cupiditate aut incidunt accusamus quis.\",
\"reminders_start\": \"2022-04-06T15:08:00+00:00\",
\"reminders_end\": \"2022-12-06T08:14:15+00:00\",
\"reminders_duration\": \"P3D\"
}
}
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/Ddz3da"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "Architecto ex dolorum laborum aut.",
"description": "Molestiae quod qui in qui sed tempora totam distinctio.",
"archive_status": "Porro et et quod est est error est.",
"folder_id": "a27glG",
"owner_id": "ZXP0dm",
"contains_pii": "no_pii",
"contract": {
"name": "Sed delectus tempore fugiat est ex ad voluptatibus ea.",
"creator_name": "Ut fugit odit provident tempore.",
"sign_method": "docusign",
"signing_settings": {
"expires_at": "2016-07-11T09:47:44+00:00",
"sender_name": "John Doe",
"message": "Et harum fuga cupiditate aut incidunt accusamus quis.",
"reminders_start": "2022-04-06T15:08:00+00:00",
"reminders_end": "2022-12-06T08:14:15+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/Ddz3da';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'Architecto ex dolorum laborum aut.',
'description' => 'Molestiae quod qui in qui sed tempora totam distinctio.',
'archive_status' => 'Porro et et quod est est error est.',
'folder_id' => 'a27glG',
'owner_id' => 'ZXP0dm',
'contains_pii' => 'no_pii',
'contract' => [
'name' => 'Sed delectus tempore fugiat est ex ad voluptatibus ea.',
'creator_name' => 'Ut fugit odit provident tempore.',
'sign_method' => 'docusign',
'signing_settings' => [
'expires_at' => '2016-07-11T09:47:44+00:00',
'sender_name' => 'John Doe',
'message' => 'Et harum fuga cupiditate aut incidunt accusamus quis.',
'reminders_start' => '2022-04-06T15:08:00+00:00',
'reminders_end' => '2022-12-06T08:14:15+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/Ddz3da'
payload = {
"title": "Architecto ex dolorum laborum aut.",
"description": "Molestiae quod qui in qui sed tempora totam distinctio.",
"archive_status": "Porro et et quod est est error est.",
"folder_id": "a27glG",
"owner_id": "ZXP0dm",
"contains_pii": "no_pii",
"contract": {
"name": "Sed delectus tempore fugiat est ex ad voluptatibus ea.",
"creator_name": "Ut fugit odit provident tempore.",
"sign_method": "docusign",
"signing_settings": {
"expires_at": "2016-07-11T09:47:44+00:00",
"sender_name": "John Doe",
"message": "Et harum fuga cupiditate aut incidunt accusamus quis.",
"reminders_start": "2022-04-06T15:08:00+00:00",
"reminders_end": "2022-12-06T08:14:15+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": "Accusamus aperiam soluta sed voluptas id et.",
"id": "mO7qZe",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Assumenda odio voluptatem.",
"description": "Ut iure voluptatibus earum officia illo aut nesciunt.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "8WANggq",
"contract": {
"_type": "contract",
"id": "D5rQLx",
"name": "Sunt blanditiis eius ipsam aut ipsum id est.",
"stage": "Itaque cumque nobis est.",
"document_id": "DJL7Ea",
"sign_method": "canvas",
"template_id": "Id ut reiciendis laboriosam sed eius suscipit.",
"template": {
"id": "m9j2qV",
"name": "Modi et itaque libero hic veritatis.",
"description": "Id accusamus quia velit animi in vero et.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "eDJ0a1",
"display_name": "Dignissimos velit id autem quia saepe enim libero et.",
"first_name": "Vel fugit consequatur explicabo.",
"last_name": "Velit impedit velit nulla at optio sit et.",
"email": "syble.rice@wisozk.com",
"language": "pl"
},
"signing_settings": {
"id": "MJVB3q",
"created_at": "1974-08-14T07:56:49+00:00",
"updated_at": "1971-06-27T07:39:24+00:00",
"contract_id": "OR42R3",
"message": "Qui non illum vel nobis consequatur.",
"expires_at": "1985-09-09T18:12:51+00:00",
"reminders_start": "2001-10-25T00:52:51+00:00",
"reminders_end": "1982-04-30T03:22:54+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "NObxZW",
"folder": {
"_type": "folder",
"id": "0ZABao",
"name": "Qui debitis rerum esse ut.",
"created_at": "1977-08-06T05:06:57+00:00",
"updated_at": "1974-01-16T20:32:30+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "7ajJva",
"name": "Eius quis ea maxime magnam.",
"created_at": "1978-03-09T18:25:56+00:00",
"updated_at": "1987-09-04T18:53:03+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "1DM7aR",
"owner": {
"id": "gD6jDw",
"display_name": "Velit nam maiores necessitatibus sit.",
"first_name": "Delectus voluptas dolore dolor quo.",
"last_name": "Et reprehenderit velit ut et voluptatem laudantium.",
"email": "dbailey@hotmail.com",
"language": "en"
},
"workspace_id": "jZNWao",
"workspace": {
"_type": "workspace",
"id": "0ZABao",
"name": "Non quo voluptatem pariatur alias.",
"company_ident": "Pariatur qui tempora fuga eum in et repellendus.",
"email": "ywest@romaguera.info",
"root_folder_id": "aekp8D"
},
"file_id": "BaEMaV",
"file": {
"_type": "file",
"id": "wL7YJzo",
"filename": "Dolores aut qui iusto enim.",
"size": 29,
"mime": "Est iste accusantium voluptas et.",
"download_url": "https://www.hoeger.com/fuga-vel-in-et-similique-et-sed-et",
"preview_url": "http://gleason.com/suscipit-est-rem-reiciendis"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "ZnveqQ",
"property_id": "ORd3xZ",
"property": {
"id": "dw3b3Lp",
"title": "Quia ut est voluptatem.",
"description": "Numquam voluptatem asperiores occaecati tempora perspiciatis quod qui.",
"name": "Quaerat vel nam harum et voluptatem perferendis dignissimos non.",
"source": "system",
"data_type": "string",
"workspace_id": "1DM7aR",
"workspace": {
"_type": "workspace",
"id": "O7wkwO",
"name": "Eum assumenda saepe excepturi adipisci.",
"company_ident": "Optio nemo voluptatem ipsam quos corporis.",
"email": "bayer.triston@howe.net",
"root_folder_id": "GDmPVO"
}
}
}
],
"date_values": [
{
"id": "ED5LeO",
"value": "1990-06-24T23:43:02+00:00",
"duration": "P1D",
"basis": "Expedita culpa nesciunt nemo iusto ut sed.",
"property_id": "W34PyWJ",
"property": {
"id": "2ZlLRZ",
"title": "Quos at consequatur adipisci sit dolorum iure quas.",
"description": "Explicabo qui sunt voluptas numquam.",
"name": "Consectetur alias odit quasi magni omnis.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "yB3V1p",
"workspace": {
"_type": "workspace",
"id": "Amgn52",
"name": "Quis facilis inventore ducimus sed dolor hic.",
"company_ident": "Ad incidunt vel optio voluptas et laboriosam sit ab.",
"email": "edna48@gmail.com",
"root_folder_id": "W9dnen"
}
}
}
],
"numeric_values": [
{
"id": "ObgRdD",
"value": 1697579.02305721,
"unit": "Voluptas voluptatem quis porro esse.",
"property_id": "DW9KQG",
"property": {
"id": "a0oY2r",
"title": "Ipsam ut libero earum quisquam dolores.",
"description": "Magnam laboriosam voluptate voluptatem veritatis quidem.",
"name": "Similique sint sint dolor ad quas illo.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "eDJNED",
"workspace": {
"_type": "workspace",
"id": "6DdeQZ",
"name": "Numquam quia voluptas laboriosam.",
"company_ident": "Magni eligendi consequatur adipisci rerum.",
"email": "kohler.verdie@yahoo.com",
"root_folder_id": "rBJnlJM"
}
}
}
],
"string_values": [
{
"id": "OblMnZ",
"value": "Quia corrupti ut consequatur.",
"property_id": "VREY5w",
"property": {
"id": "1mpV7xP",
"title": "Officia est et quisquam ducimus.",
"description": "Reprehenderit natus quia ea quos.",
"name": "Sed praesentium culpa nobis voluptas commodi tempora quia.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "ZNqXm3",
"workspace": {
"_type": "workspace",
"id": "wOywZL",
"name": "In quos at nesciunt reprehenderit.",
"company_ident": "Delectus beatae earum accusantium quia et.",
"email": "zakary06@kulas.info",
"root_folder_id": "5rgGrM"
}
}
}
],
"jurisdictions": [
{
"id": "kAzYrK",
"code": "Inventore rerum dolorum alias."
}
],
"document_types": [
{
"_type": "document_type",
"id": "O4jy1J",
"name": "Dicta rerum voluptatem excepturi et."
}
],
"parties": [
{
"id": "DW9XNP",
"first_name": "Et iure esse consectetur veritatis magnam provident.",
"last_name": "Minus magnam itaque voluptatem aut molestiae enim.",
"email": "waelchi.raquel@funk.info",
"phone": "Exercitationem provident nesciunt dolor quae unde nam ea.",
"title": "Non magnam placeat aliquam voluptas enim qui at quisquam.",
"company_name": "Animi quae dolorem non eos similique tempore.",
"company_ident": "Ipsum optio quia sint deserunt doloremque at ut.",
"address_id": "Nxoxz3",
"address": {
"id": "KOqvoD",
"address_type": "Delectus quaerat voluptas nam voluptatem aut voluptatem.",
"address_lines": "Doloribus culpa illo natus iure sit.",
"city": "Ipsa similique tempore accusamus quia consectetur et.",
"locality": "Repellendus accusamus reprehenderit corrupti ex corporis at.",
"administrative_area": "Enim dolores aut saepe officiis ullam sapiente error.",
"post_code": "Laudantium tempore sit illum iste vitae iusto est.",
"country": "Consequuntur dignissimos id est quidem ab."
},
"external_references": [
{
"id": "Ma2naY",
"name": "Culpa quae aliquam rerum reprehenderit minus molestiae.",
"title": "Eos repellendus voluptate et.",
"value": "Et eos voluptatem rerum culpa distinctio sequi."
}
]
}
],
"reminders": [
{
"id": "9JgXBw",
"event_type": "document.reminder",
"title": "Deserunt natus fuga rem qui consequuntur aliquid reiciendis."
}
],
"attachments": [
{
"id": "JZnJQZ",
"created_at": "2007-04-04T08:20:41+00:00",
"updated_at": "2014-08-07T02:00:14+00:00",
"file_id": "bQr1Xy",
"file": {
"_type": "file",
"id": "zOwqoZ",
"filename": "example.pdf",
"size": 52746.3,
"mime": "application/pdf",
"download_url": "http://gislason.com/",
"preview_url": "http://deckow.com/ipsa-occaecati-magni-accusamus-qui-rerum"
}
}
],
"external_references": [
{
"id": "Ob8VpZ",
"name": "Totam doloribus culpa vel quia provident vitae.",
"title": "Reiciendis sit voluptatem nihil sed sunt.",
"value": "Perspiciatis et est in."
}
],
"tags": [
{
"tag": "Reprehenderit ea ad laudantium pariatur assumenda et sint quia."
}
],
"terms_and_conditions": {
"date": "2001-07-10T19:26:58+00:00",
"effective_date": "1989-08-24T18:01:42+00:00",
"term_end_date": "2013-03-03T19:44:19+00:00",
"signing_date": "1978-11-17T10:42:11+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
},
"retention": {
"end_date": "2017-12-07T08:33:56+00:00"
},
"breadcrumb": [
{
"id": "ZpBejn",
"name": "Sed repellendus ullam consectetur sapiente impedit.",
"depth": 3
}
]
}
}
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/kb0Rmk" \
--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/kb0Rmk"
);
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/kb0Rmk';
$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/kb0Rmk'
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/DJ9JXw/start" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"folder_id\": \"0ZABao\",
\"title\": \"Voluptatem eum perferendis corporis ratione architecto rerum enim.\",
\"creator_name\": \"Et iusto eos neque omnis officia et.\",
\"sign_method\": \"manual\",
\"signing_settings\": {
\"expires_at\": \"1994-11-07T14:09:02+00:00\",
\"sender_name\": \"John Doe\",
\"message\": \"Quia cumque veritatis nostrum repellat eum.\",
\"reminders_start\": \"1970-09-06T23:10:54+00:00\",
\"reminders_end\": \"1976-01-01T10:50:58+00:00\",
\"reminders_duration\": \"P3D\"
}
}"
const url = new URL(
"https://api.docue.com/public/v2/templates/DJ9JXw/start"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"folder_id": "0ZABao",
"title": "Voluptatem eum perferendis corporis ratione architecto rerum enim.",
"creator_name": "Et iusto eos neque omnis officia et.",
"sign_method": "manual",
"signing_settings": {
"expires_at": "1994-11-07T14:09:02+00:00",
"sender_name": "John Doe",
"message": "Quia cumque veritatis nostrum repellat eum.",
"reminders_start": "1970-09-06T23:10:54+00:00",
"reminders_end": "1976-01-01T10:50:58+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/DJ9JXw/start';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'folder_id' => '0ZABao',
'title' => 'Voluptatem eum perferendis corporis ratione architecto rerum enim.',
'creator_name' => 'Et iusto eos neque omnis officia et.',
'sign_method' => 'manual',
'signing_settings' => [
'expires_at' => '1994-11-07T14:09:02+00:00',
'sender_name' => 'John Doe',
'message' => 'Quia cumque veritatis nostrum repellat eum.',
'reminders_start' => '1970-09-06T23:10:54+00:00',
'reminders_end' => '1976-01-01T10:50:58+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/DJ9JXw/start'
payload = {
"folder_id": "0ZABao",
"title": "Voluptatem eum perferendis corporis ratione architecto rerum enim.",
"creator_name": "Et iusto eos neque omnis officia et.",
"sign_method": "manual",
"signing_settings": {
"expires_at": "1994-11-07T14:09:02+00:00",
"sender_name": "John Doe",
"message": "Quia cumque veritatis nostrum repellat eum.",
"reminders_start": "1970-09-06T23:10:54+00:00",
"reminders_end": "1976-01-01T10:50:58+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": "Optio voluptatum fuga odio esse.",
"id": "wOyJ3D",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Aut hic eos in nihil.",
"description": "Porro cupiditate dicta sint omnis consequatur occaecati qui qui.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "2pxpz0",
"contract": {
"_type": "contract",
"id": "6QPMjP0",
"name": "Officia dolor doloribus in consequatur aut commodi eum voluptates.",
"stage": "Modi assumenda iure odit consequatur.",
"document_id": "LQyEwy",
"sign_method": "strong",
"template_id": "Doloribus et quae laudantium voluptatibus provident facere.",
"template": {
"id": "ZnkbLP",
"name": "Eius rem molestiae doloremque accusamus ut.",
"description": "Quasi alias sint pariatur magnam totam.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "Oq5B5j",
"display_name": "Et ullam omnis natus est.",
"first_name": "Placeat a asperiores vel in eos quia non.",
"last_name": "Alias nesciunt et dolor perferendis qui iure.",
"email": "rschiller@towne.net",
"language": "pl"
},
"signing_settings": {
"id": "eDJ20D",
"created_at": "2000-05-02T03:34:14+00:00",
"updated_at": "2018-10-18T04:09:43+00:00",
"contract_id": "D54xLM",
"message": "In asperiores et earum laborum est.",
"expires_at": "1973-08-18T21:20:05+00:00",
"reminders_start": "1992-05-30T13:33:55+00:00",
"reminders_end": "1973-10-11T06:21:26+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "Z9BEop",
"folder": {
"_type": "folder",
"id": "NObgxD",
"name": "Autem iure eum ducimus sapiente quo nemo.",
"created_at": "2017-01-01T13:10:36+00:00",
"updated_at": "1982-12-13T19:36:12+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "aEA84Y",
"name": "Dolor perferendis dolores rem cumque ratione et libero.",
"created_at": "1982-02-25T21:37:51+00:00",
"updated_at": "1993-07-25T14:46:41+00:00",
"parent_id": "0ZABao",
"has_children": true
}
},
"owner_id": "LDQ3aq",
"owner": {
"id": "aEGE5D",
"display_name": "Debitis animi et eos quaerat.",
"first_name": "Voluptatibus quam debitis et a qui qui.",
"last_name": "Ut dignissimos quis consequatur perferendis nesciunt.",
"email": "ricky.hoppe@yahoo.com",
"language": "en"
},
"workspace_id": "XrWbLB",
"workspace": {
"_type": "workspace",
"id": "BaEMaV",
"name": "Maxime voluptas nesciunt architecto est quis.",
"company_ident": "Similique consequuntur non minima voluptatem.",
"email": "heloise10@corwin.info",
"root_folder_id": "moPLwq"
},
"file_id": "pZG0Ra",
"file": {
"_type": "file",
"id": "2O4eDy",
"filename": "Qui velit non enim maxime.",
"size": 371754.0252,
"mime": "Ut sed et ipsam dolorem reprehenderit.",
"download_url": "http://www.koepp.org/rem-culpa-illo-delectus-laudantium-ex-praesentium-enim",
"preview_url": "http://www.vonrueden.com/est-eligendi-optio-ut-veniam-fugiat-saepe-quasi.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "5QpXxVk",
"property_id": "ZrrKP1",
"property": {
"id": "n5kXeQ",
"title": "Exercitationem atque rerum in et esse.",
"description": "Ea nesciunt provident non tempore distinctio tempora magnam.",
"name": "Cumque voluptatem aperiam mollitia et fugiat atque sunt.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "ZAnk4x",
"workspace": {
"_type": "workspace",
"id": "Oo0891",
"name": "Nisi laborum doloremque et sit quod.",
"company_ident": "Optio ratione iure repellendus praesentium modi distinctio ipsum.",
"email": "cory.denesik@gmail.com",
"root_folder_id": "aeeo2a"
}
}
}
],
"date_values": [
{
"id": "ZnLGlV",
"value": "2024-05-25T07:02:56+00:00",
"duration": "P1D",
"basis": "Eius aliquam consequatur tempora quia.",
"property_id": "BJNepre",
"property": {
"id": "mO7AqZ",
"title": "Tempora maxime numquam et autem accusamus quidem officiis cumque.",
"description": "Rem eaque et velit recusandae et sunt quia.",
"name": "Provident veniam id nostrum.",
"source": "system",
"data_type": "string",
"workspace_id": "vZr7az",
"workspace": {
"_type": "workspace",
"id": "eDJ0a1",
"name": "Iure numquam qui incidunt non.",
"company_ident": "Aut ducimus aut illo aut nihil sequi.",
"email": "jjacobson@hotmail.com",
"root_folder_id": "aLeygN"
}
}
}
],
"numeric_values": [
{
"id": "jKzY5E",
"value": 3013.493,
"unit": "Quisquam qui commodi laudantium.",
"property_id": "LDQ3aq",
"property": {
"id": "0ZAY7Z",
"title": "Sit dignissimos ut at consequuntur cum.",
"description": "Ea et optio sapiente fugiat quia.",
"name": "Necessitatibus neque laborum omnis incidunt molestias voluptatum est.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "OyBW9D",
"workspace": {
"_type": "workspace",
"id": "gD6RYD",
"name": "Dolor rerum accusamus dolor quis odio in aut.",
"company_ident": "Fugit est dignissimos ea voluptatem cumque ut.",
"email": "ubaldo00@lehner.org",
"root_folder_id": "4aLQNO"
}
}
}
],
"string_values": [
{
"id": "1pdwJe",
"value": "Ipsam non eaque aut ipsam laborum ratione deserunt.",
"property_id": "ZABj9a",
"property": {
"id": "4aLg7Z",
"title": "Quasi ut debitis quo natus.",
"description": "Consequatur sunt quasi ullam vero accusantium error.",
"name": "Distinctio corporis nobis qui omnis ea.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "EDYvZe",
"workspace": {
"_type": "workspace",
"id": "MAB8LXr",
"name": "Enim minima repudiandae enim dolor ipsum.",
"company_ident": "Dolorem aliquid corporis architecto impedit vel eum reiciendis.",
"email": "stamm.addie@feil.org",
"root_folder_id": "pZGRnD"
}
}
}
],
"jurisdictions": [
{
"id": "DWEXma",
"code": "Dolore ut aut soluta est tempore sapiente."
}
],
"document_types": [
{
"_type": "document_type",
"id": "GZgkkZ",
"name": "Beatae quia nostrum dolores accusamus unde impedit nesciunt id."
}
],
"parties": [
{
"id": "gD6jDw",
"first_name": "Sed illo temporibus adipisci quis et.",
"last_name": "Alias illo id accusamus minima.",
"email": "ishields@hotmail.com",
"phone": "Rem quis quos adipisci.",
"title": "Enim quidem sed consequatur veniam dignissimos culpa.",
"company_name": "In eius ex perferendis ea voluptatem quia.",
"company_ident": "Et delectus aut dolores iusto unde.",
"address_id": "Z1KzdP",
"address": {
"id": "Z8y6Ea",
"address_type": "Corporis sunt harum aliquid commodi nulla est ullam.",
"address_lines": "Dolorum enim sit iusto quidem possimus cumque.",
"city": "Eum doloremque nemo perferendis et est.",
"locality": "Ratione vel ea qui sit cumque impedit corrupti.",
"administrative_area": "Quis rerum facilis non sunt.",
"post_code": "Sunt reiciendis hic eveniet tenetur voluptas sit provident.",
"country": "Dolore dolores sit omnis atque est."
},
"external_references": [
{
"id": "l5YMbM",
"name": "Dolores a soluta eligendi veritatis omnis non quidem illum.",
"title": "Expedita qui impedit est ut consequatur repudiandae.",
"value": "Quis quasi nihil eius ratione est inventore sint non."
}
]
}
],
"reminders": [
{
"id": "LZKkEZ",
"event_type": "document.reminder",
"title": "Consequatur quo voluptas possimus fugiat adipisci."
}
],
"attachments": [
{
"id": "NDkdZo",
"created_at": "2006-04-16T12:56:31+00:00",
"updated_at": "1980-04-22T17:35:51+00:00",
"file_id": "0ZABao",
"file": {
"_type": "file",
"id": "kORwxD",
"filename": "example.pdf",
"size": 15.29337,
"mime": "application/pdf",
"download_url": "http://fritsch.com/dolor-ipsam-unde-alias-numquam.html",
"preview_url": "http://sporer.com/aspernatur-aliquid-non-ad"
}
}
],
"external_references": [
{
"id": "Z94KQD",
"name": "Aut pariatur maiores illo similique magnam omnis est.",
"title": "Veritatis sint aut perspiciatis voluptas soluta nulla vero.",
"value": "Et ut architecto consequatur maiores commodi maxime animi."
}
],
"tags": [
{
"tag": "Cumque consequatur unde natus repudiandae ab quisquam doloribus."
}
],
"terms_and_conditions": {
"date": "2005-07-25T10:21:26+00:00",
"effective_date": "2010-08-12T21:25:37+00:00",
"term_end_date": "2001-01-12T11:19:47+00:00",
"signing_date": "2016-01-03T15:39:31+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1973-12-01T11:13:28+00:00"
},
"breadcrumb": [
{
"id": "pZG0Ra",
"name": "Hic qui labore nostrum nemo est fugit sequi aperiam.",
"depth": 6344
}
]
}
}
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\": \"ZGM7RO\",
\"title\": \"Culpa quo ut eaque eligendi illo voluptatum.\",
\"sign_method\": \"docusign\",
\"signing_settings\": {
\"expires_at\": \"1982-10-01T05:49:35+00:00\",
\"sender_name\": \"John Doe\",
\"message\": \"Numquam aut et dolores illum inventore repudiandae magnam.\",
\"reminders_start\": \"1999-09-28T12:10:03+00:00\",
\"reminders_end\": \"2013-01-07T14:36: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": "ZGM7RO",
"title": "Culpa quo ut eaque eligendi illo voluptatum.",
"sign_method": "docusign",
"signing_settings": {
"expires_at": "1982-10-01T05:49:35+00:00",
"sender_name": "John Doe",
"message": "Numquam aut et dolores illum inventore repudiandae magnam.",
"reminders_start": "1999-09-28T12:10:03+00:00",
"reminders_end": "2013-01-07T14:36: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' => 'ZGM7RO',
'title' => 'Culpa quo ut eaque eligendi illo voluptatum.',
'sign_method' => 'docusign',
'signing_settings' => [
'expires_at' => '1982-10-01T05:49:35+00:00',
'sender_name' => 'John Doe',
'message' => 'Numquam aut et dolores illum inventore repudiandae magnam.',
'reminders_start' => '1999-09-28T12:10:03+00:00',
'reminders_end' => '2013-01-07T14:36: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": "ZGM7RO",
"title": "Culpa quo ut eaque eligendi illo voluptatum.",
"sign_method": "docusign",
"signing_settings": {
"expires_at": "1982-10-01T05:49:35+00:00",
"sender_name": "John Doe",
"message": "Numquam aut et dolores illum inventore repudiandae magnam.",
"reminders_start": "1999-09-28T12:10:03+00:00",
"reminders_end": "2013-01-07T14:36: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": "Omnis eum impedit qui.",
"id": "Ove3Aa",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Repellat error molestiae.",
"description": "Voluptatem laudantium ullam doloribus quae explicabo quod.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "ZKPBzk",
"contract": {
"_type": "contract",
"id": "PMmylW",
"name": "Provident soluta qui et perferendis quia.",
"stage": "Deleniti rem fugiat et quaerat fugit corporis sequi.",
"document_id": "LPeBxQ",
"sign_method": "strong",
"template_id": "Tempore corrupti dolor voluptates vitae sed id dignissimos.",
"template": {
"id": "GE343Qb",
"name": "Est minima qui vel consequatur possimus.",
"description": "Suscipit a vel vitae saepe maiores.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "ZgQBAO",
"display_name": "Velit rerum ad neque eos qui accusantium.",
"first_name": "Sed accusamus eum expedita placeat tempore.",
"last_name": "Quaerat eaque facilis aliquid assumenda fugit vitae.",
"email": "ipagac@yahoo.com",
"language": "fi"
},
"signing_settings": {
"id": "LDQd6O",
"created_at": "1987-08-26T22:30:52+00:00",
"updated_at": "2017-09-30T00:32:17+00:00",
"contract_id": "OxNQ4Z",
"message": "Autem tempore ea neque.",
"expires_at": "1984-11-22T14:14:08+00:00",
"reminders_start": "1991-05-30T15:38:38+00:00",
"reminders_end": "2019-06-02T23:43:53+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "EGm7n5",
"folder": {
"_type": "folder",
"id": "L7WjWR",
"name": "Eum nulla earum et doloribus sed aspernatur qui.",
"created_at": "1974-12-25T02:24:29+00:00",
"updated_at": "2023-08-22T02:12:31+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "RPQv02",
"name": "Quis aliquam error in eaque quis voluptas.",
"created_at": "1988-10-05T18:15:54+00:00",
"updated_at": "1986-01-23T18:47:38+00:00",
"parent_id": "0ZABao",
"has_children": true
}
},
"owner_id": "2r9Q2Ed",
"owner": {
"id": "ZAj8Ek",
"display_name": "In tempore dolorem est aut veniam alias veritatis.",
"first_name": "Assumenda ut porro consequatur eum minus optio ad.",
"last_name": "Maiores sapiente veritatis maxime aspernatur consequatur.",
"email": "hilpert.rosario@gmail.com",
"language": "fi"
},
"workspace_id": "lJrgm8",
"workspace": {
"_type": "workspace",
"id": "a2N9Na",
"name": "Esse odit odit harum.",
"company_ident": "Accusantium voluptatem ducimus sequi vel voluptatem sit ut.",
"email": "broderick15@cassin.com",
"root_folder_id": "OxX3L2"
},
"file_id": "BaE2PO",
"file": {
"_type": "file",
"id": "6GzonA",
"filename": "Corporis quia illo voluptatem autem consectetur voluptatem tempora.",
"size": 44430725,
"mime": "Consequuntur ut voluptate pariatur.",
"download_url": "http://www.hahn.org/est-voluptas-et-exercitationem-repudiandae-aliquam-repellendus-minima",
"preview_url": "https://www.rogahn.com/incidunt-et-aut-dolor-aut-sint"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "2p3V97w",
"property_id": "rl0jgq3",
"property": {
"id": "a2plnj",
"title": "Alias et cupiditate sit non porro.",
"description": "Ut perspiciatis nam vel quia impedit pariatur.",
"name": "Eos culpa neque voluptatem ad blanditiis sapiente.",
"source": "system",
"data_type": "string",
"workspace_id": "pqEvRx",
"workspace": {
"_type": "workspace",
"id": "NObxZW",
"name": "Omnis est numquam mollitia et suscipit voluptas.",
"company_ident": "Velit id vel rerum nulla qui dolorem enim.",
"email": "tomasa.cummings@hotmail.com",
"root_folder_id": "0ZABao"
}
}
}
],
"date_values": [
{
"id": "O4QlND",
"value": "1995-10-09T03:03:02+00:00",
"duration": "P1D",
"basis": "Unde possimus eius excepturi dignissimos expedita nulla.",
"property_id": "mO7AqZ",
"property": {
"id": "OoWqqO",
"title": "Facilis dolorum totam eius soluta.",
"description": "Necessitatibus at et nobis et fuga.",
"name": "Iusto nihil ut ad praesentium ea et.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "PZp7nD",
"workspace": {
"_type": "workspace",
"id": "aL6VgD",
"name": "Provident deleniti quam id.",
"company_ident": "Rerum repellendus quaerat quod quis optio perferendis id.",
"email": "lon15@denesik.com",
"root_folder_id": "D6L10a"
}
}
}
],
"numeric_values": [
{
"id": "vOxdAO",
"value": 343.8,
"unit": "Qui ut ut culpa numquam dignissimos quae.",
"property_id": "jpVpQx",
"property": {
"id": "D54gEL",
"title": "Sit optio maxime est illo tenetur quia in.",
"description": "Molestiae optio debitis sed consequatur.",
"name": "Vero ratione ipsam placeat magni.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "P49lYER",
"workspace": {
"_type": "workspace",
"id": "XjdAnn",
"name": "Harum recusandae voluptatem labore dolore.",
"company_ident": "Possimus aperiam necessitatibus ipsa quaerat totam architecto.",
"email": "astrid.hand@yahoo.com",
"root_folder_id": "mO7AqZ"
}
}
}
],
"string_values": [
{
"id": "Zpjz5r",
"value": "Dolorem dicta sequi quas est earum qui necessitatibus alias.",
"property_id": "YZ9WOe",
"property": {
"id": "zGAz8mY",
"title": "Delectus minus nulla in consequuntur magnam autem.",
"description": "Alias provident exercitationem exercitationem vel consequatur dolores ratione.",
"name": "Repellat odio et voluptas omnis qui sunt.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "ojd582",
"workspace": {
"_type": "workspace",
"id": "7ajvaP",
"name": "Et quos sapiente nihil.",
"company_ident": "Saepe illum aut vel eum cumque sint aspernatur.",
"email": "shanahan.idella@yahoo.com",
"root_folder_id": "QLAb87"
}
}
}
],
"jurisdictions": [
{
"id": "Z1WkJP",
"code": "Aliquid et nihil maxime ipsa suscipit voluptatem."
}
],
"document_types": [
{
"_type": "document_type",
"id": "OyAByK",
"name": "Quam explicabo et voluptate error."
}
],
"parties": [
{
"id": "wOywZL",
"first_name": "Harum eaque minus itaque voluptates corrupti aliquid eius.",
"last_name": "Ab nemo consequatur voluptatem ut et ratione.",
"email": "camille.von@gmail.com",
"phone": "Ut rerum earum est.",
"title": "Odio ut assumenda in nemo recusandae.",
"company_name": "Sed vel ipsa eius nihil.",
"company_ident": "Maiores omnis rerum quaerat tempore.",
"address_id": "mOoJxa",
"address": {
"id": "gD6jDw",
"address_type": "Dolorum id facilis voluptatibus omnis esse aut facilis.",
"address_lines": "Dolor voluptates in et.",
"city": "Commodi debitis consequatur et est velit modi sed.",
"locality": "Sed et voluptates pariatur.",
"administrative_area": "Et autem magnam officiis.",
"post_code": "Alias non odio aut rerum eum enim dolor.",
"country": "Non dicta facilis blanditiis qui harum enim illum."
},
"external_references": [
{
"id": "aERRYO",
"name": "Officiis ut consequuntur vero deleniti quia.",
"title": "Amet assumenda ipsam iusto alias sit dolorem.",
"value": "Quis molestiae maiores sed consequuntur."
}
]
}
],
"reminders": [
{
"id": "aEqLeV",
"event_type": "document.reminder",
"title": "Beatae consequatur expedita itaque sit eveniet eos reprehenderit."
}
],
"attachments": [
{
"id": "pBrWw00",
"created_at": "1980-11-10T04:39:36+00:00",
"updated_at": "2004-05-29T11:54:44+00:00",
"file_id": "eDJ0a1",
"file": {
"_type": "file",
"id": "0ZAk3O",
"filename": "example.pdf",
"size": 26.938676676,
"mime": "application/pdf",
"download_url": "http://haag.info/in-dolores-optio-ea-suscipit-libero.html",
"preview_url": "http://www.jacobi.info/minus-tenetur-accusamus-ullam-quae-et"
}
}
],
"external_references": [
{
"id": "ZlLG4Z",
"name": "Placeat fuga voluptatibus dolor natus accusantium facilis.",
"title": "Neque excepturi vel tenetur fuga.",
"value": "Nihil sapiente eos quod in."
}
],
"tags": [
{
"tag": "Autem et explicabo voluptas iste veritatis cumque fugit est."
}
],
"terms_and_conditions": {
"date": "1977-11-11T21:54:47+00:00",
"effective_date": "1989-10-28T05:20:36+00:00",
"term_end_date": "1992-11-28T05:36:40+00:00",
"signing_date": "2022-12-24T07:34:15+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "2013-08-25T03:17:17+00:00"
},
"breadcrumb": [
{
"id": "ZgRlKD",
"name": "Delectus iusto minus aut cumque.",
"depth": 8606532
}
]
}
}
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/azM16n/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/azM16n/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/azM16n/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/azM16n/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": "MAGdok",
"event_type": "document.reminder",
"title": "Iure unde illo hic voluptas delectus ad.",
"document": {
"download_url": "Placeat et ut nobis atque qui voluptas.",
"id": "BJmGYy",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Est facere ad consequuntur.",
"description": "Sint quia iste soluta voluptatem hic molestias.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "Ox4mQ2",
"contract": {
"_type": "contract",
"id": "56wL9Lq",
"name": "Beatae quam natus quasi laudantium et non aut.",
"stage": "Non libero repudiandae velit magnam assumenda consequatur.",
"document_id": "OvPReZ",
"sign_method": "manual",
"template_id": "Aut temporibus at aliquam aut.",
"template": {
"id": "eDJ0a1",
"name": "Quia libero nihil aliquid qui soluta harum.",
"description": "Tempore in nulla in beatae animi.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "8OvPZK",
"display_name": "Quam magni impedit eos aut dolor recusandae quod.",
"first_name": "Nam sed voluptatum enim aperiam accusamus.",
"last_name": "Laudantium pariatur quo modi beatae.",
"email": "carmine.doyle@kreiger.com",
"language": "fi"
},
"signing_settings": {
"id": "Z83Knk",
"created_at": "2015-05-21T12:12:34+00:00",
"updated_at": "2011-07-02T07:36:01+00:00",
"contract_id": "7ajvaP",
"message": "Voluptatem quam eius expedita inventore.",
"expires_at": "1974-11-03T04:38:38+00:00",
"reminders_start": "2022-09-18T06:39:35+00:00",
"reminders_end": "1995-12-24T04:26:15+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "OxknAa",
"folder": {
"_type": "folder",
"id": "8Ov9Pa",
"name": "Quisquam qui numquam sit nihil ex.",
"created_at": "1981-03-11T03:46:09+00:00",
"updated_at": "2012-10-02T14:34:38+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "ML05V78",
"name": "Voluptatem quam at voluptatem sequi et.",
"created_at": "2005-02-23T10:28:06+00:00",
"updated_at": "1973-04-28T15:31:59+00:00",
"parent_id": "0ZABao",
"has_children": true
}
},
"owner_id": "MQoWM8",
"owner": {
"id": "MLgwLk",
"display_name": "Incidunt eum cumque voluptas omnis.",
"first_name": "Ab excepturi dolorum cum nesciunt soluta.",
"last_name": "Omnis officiis qui omnis et praesentium eum.",
"email": "weissnat.bartholome@gmail.com",
"language": "sv"
},
"workspace_id": "vOxVqZ",
"workspace": {
"_type": "workspace",
"id": "MN9Vmr",
"name": "Adipisci est consequuntur a est quis.",
"company_ident": "Itaque natus repellat ab quia voluptatibus animi hic cupiditate.",
"email": "kertzmann.delfina@stokes.com",
"root_folder_id": "aEqPPa"
},
"file_id": "pBkvbr8",
"file": {
"_type": "file",
"id": "ae8M2Z",
"filename": "Excepturi a id accusamus doloremque repudiandae quaerat.",
"size": 416800770.059172,
"mime": "Voluptatem rerum quidem ipsa.",
"download_url": "https://www.ernser.com/commodi-facilis-non-est-sit",
"preview_url": "http://luettgen.com/"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "DJpqmA",
"value": true,
"property_id": "bg1g5J",
"property": {
"id": "2O4eJD",
"title": "Et odio est dolorum alias iure reiciendis.",
"description": "Et mollitia velit et quo dolorum nemo maxime nobis.",
"name": "Debitis maiores reiciendis id quo quod perspiciatis similique.",
"source": "system",
"data_type": "boolean",
"workspace_id": "Zge79O",
"workspace": {
"_type": "workspace",
"id": "vNNl6o",
"name": "Doloremque saepe aliquid voluptas unde quaerat vero.",
"company_ident": "Velit quo ut pariatur repellat.",
"email": "breitenberg.bria@gmail.com",
"root_folder_id": "x6WM52"
}
}
}
],
"date_values": [
{
"id": "OqdWz8",
"value": "1989-12-19T05:10:57+00:00",
"duration": "P1D",
"basis": "Doloribus sunt eos quasi autem aut natus.",
"property_id": "Ob6B4O",
"property": {
"id": "ZXPBBZ",
"title": "Sed ea praesentium ea laborum.",
"description": "Eos aliquid nam delectus aspernatur eligendi fugiat ut.",
"name": "Modi totam deserunt quae animi repellat tempore id repellendus.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "DYjwJZ",
"workspace": {
"_type": "workspace",
"id": "ZArl9x",
"name": "Repudiandae necessitatibus assumenda est necessitatibus non iste.",
"company_ident": "Sit non animi ut ea.",
"email": "shana.cummerata@will.info",
"root_folder_id": "z6g9MY"
}
}
}
],
"numeric_values": [
{
"id": "2Zl5Wa",
"value": 78.5174195,
"unit": "Libero est ad enim ut magni beatae et.",
"property_id": "PGJpEg",
"property": {
"id": "OyA3z3",
"title": "Officiis necessitatibus doloremque temporibus dolor magni et.",
"description": "Perspiciatis eius porro doloribus error autem deserunt.",
"name": "Libero numquam fugit libero nihil modi at.",
"source": "system",
"data_type": "date",
"workspace_id": "D56lMZ",
"workspace": {
"_type": "workspace",
"id": "ZXkevD",
"name": "Et necessitatibus laborum reiciendis illo quisquam eos adipisci veniam.",
"company_ident": "Voluptatem alias odio aut.",
"email": "hellen.weber@hotmail.com",
"root_folder_id": "NObxZW"
}
}
}
],
"string_values": [
{
"id": "m984dP7",
"value": "Iste assumenda accusamus aspernatur nesciunt perspiciatis amet illo.",
"property_id": "1DM7aR",
"property": {
"id": "6KWP84A",
"title": "Rerum ea maxime consequatur magnam omnis odit.",
"description": "Provident alias repudiandae quia autem non repellendus.",
"name": "Necessitatibus at omnis aut provident sit est et labore.",
"source": "system",
"data_type": "date",
"workspace_id": "wOywZL",
"workspace": {
"_type": "workspace",
"id": "EqmnzY",
"name": "Enim nobis repellendus quia.",
"company_ident": "Autem sunt vero quia repellat amet atque.",
"email": "ohara.natalie@ullrich.com",
"root_folder_id": "aPAE8R"
}
}
}
],
"jurisdictions": [
{
"id": "vOxd2O",
"code": "Enim sunt nisi a voluptatum ut quia tempora ratione."
}
],
"document_types": [
{
"_type": "document_type",
"id": "aEE9e2",
"name": "Voluptates sapiente eos consequatur."
}
],
"parties": [
{
"id": "wOywZL",
"first_name": "Ab quia voluptatem vel quis praesentium.",
"last_name": "Voluptas qui est ea.",
"email": "lucy.stokes@white.net",
"phone": "Aut quam similique qui ipsam.",
"title": "Aliquam sequi dolor sequi consectetur.",
"company_name": "Illo ea accusantium sit quam odit et.",
"company_ident": "Neque aspernatur enim ipsa laboriosam tempora assumenda est voluptates.",
"address_id": "Ox0Y9O",
"address": {
"id": "BaEN5O",
"address_type": "Labore et blanditiis distinctio quia.",
"address_lines": "Ea et dolorum commodi iste.",
"city": "Similique eaque sed eos rerum culpa.",
"locality": "Nihil aut deserunt modi aut neque debitis.",
"administrative_area": "Minima quae est eveniet perferendis tempora.",
"post_code": "Soluta laboriosam qui dicta dolorem reprehenderit alias eaque.",
"country": "Eius dolorem ut totam assumenda quia eius nihil."
},
"external_references": [
{
"id": "2ZlLRZ",
"name": "Ut velit adipisci repellendus voluptatum hic.",
"title": "Sapiente rerum vero distinctio molestiae quidem accusamus consequatur.",
"value": "Quam quidem ut tempora."
}
]
}
],
"attachments": [
{
"id": "ApLp0Y3",
"created_at": "2004-10-30T08:15:13+00:00",
"updated_at": "1994-06-18T17:02:26+00:00",
"file_id": "Ob6Wo4",
"file": {
"_type": "file",
"id": "OoXzoD",
"filename": "example.pdf",
"size": 0.8642,
"mime": "application/pdf",
"download_url": "http://www.aufderhar.net/dignissimos-id-laudantium-occaecati-non-est-non-molestiae",
"preview_url": "https://quitzon.info/repellendus-quasi-dolores-aliquid-eius-illo-facilis-nesciunt.html"
}
}
],
"external_references": [
{
"id": "Z9GKkv",
"name": "Rem illum itaque odio.",
"title": "A voluptatum explicabo doloribus qui quia.",
"value": "Ab corrupti animi laboriosam in ratione ut consequatur."
}
],
"tags": [
{
"tag": "Aut aut ut praesentium nesciunt et."
}
],
"terms_and_conditions": {
"date": "2010-06-18T14:45:14+00:00",
"effective_date": "1992-12-07T01:15:56+00:00",
"term_end_date": "2014-09-12T12:32:40+00:00",
"signing_date": "1970-04-26T00:47:23+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
},
"retention": {
"end_date": "1983-02-19T13:37:44+00:00"
},
"breadcrumb": [
{
"id": "6Dd90Z",
"name": "Ut in quia ratione perferendis.",
"depth": 980232058
}
]
}
}
]
}
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/gD6jjD/reminders" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"event_type\": \"document.reminder\",
\"title\": \"Officiis molestias repellendus soluta iste ullam a est.\",
\"schedules\": [
{
\"next_run\": \"1975-12-14T15:27:38+00:00\",
\"id\": \"KOqWZB\",
\"last_run\": \"1984-04-06T08:11:28+00:00\",
\"interval\": 567
}
],
\"recipients\": [
{
\"value\": \"john.doe@doe.com\",
\"channel\": \"email\",
\"language\": \"pl\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/gD6jjD/reminders"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"event_type": "document.reminder",
"title": "Officiis molestias repellendus soluta iste ullam a est.",
"schedules": [
{
"next_run": "1975-12-14T15:27:38+00:00",
"id": "KOqWZB",
"last_run": "1984-04-06T08:11:28+00:00",
"interval": 567
}
],
"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/gD6jjD/reminders';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'event_type' => 'document.reminder',
'title' => 'Officiis molestias repellendus soluta iste ullam a est.',
'schedules' => [
[
'next_run' => '1975-12-14T15:27:38+00:00',
'id' => 'KOqWZB',
'last_run' => '1984-04-06T08:11:28+00:00',
'interval' => 567,
],
],
'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/gD6jjD/reminders'
payload = {
"event_type": "document.reminder",
"title": "Officiis molestias repellendus soluta iste ullam a est.",
"schedules": [
{
"next_run": "1975-12-14T15:27:38+00:00",
"id": "KOqWZB",
"last_run": "1984-04-06T08:11:28+00:00",
"interval": 567
}
],
"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": "BaEWbD",
"event_type": "document.reminder",
"title": "Repellendus quo optio numquam aut ut.",
"document": {
"download_url": "Sed magni commodi temporibus consequatur quas.",
"id": "ajndKa",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Ducimus minus molestias.",
"description": "Et qui voluptates eos ea in.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "PZprO0",
"contract": {
"_type": "contract",
"id": "NObWRD",
"name": "Ex at nihil dolores quaerat itaque delectus.",
"stage": "Architecto laborum magni maiores tempore.",
"document_id": "1DM7aR",
"sign_method": "manual",
"template_id": "Praesentium animi debitis nam.",
"template": {
"id": "jJoKzv",
"name": "Ipsam recusandae accusantium non temporibus voluptatem similique enim.",
"description": "Nulla dolor officia aut dolore in deleniti ut alias.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "WPErLAm",
"display_name": "Dolor totam similique ab aperiam pariatur molestiae fugiat labore.",
"first_name": "Sed dignissimos officia saepe doloribus.",
"last_name": "Ratione autem ad temporibus aut aut.",
"email": "stanley37@auer.com",
"language": "pl"
},
"signing_settings": {
"id": "OokwkO",
"created_at": "2025-08-03T01:19:32+00:00",
"updated_at": "2009-02-10T13:31:33+00:00",
"contract_id": "gD6jDw",
"message": "Sed cum nulla illo illo et sint aut.",
"expires_at": "2018-11-21T04:33:08+00:00",
"reminders_start": "2010-04-18T16:07:34+00:00",
"reminders_end": "1985-01-21T08:11:29+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "zv7XbE",
"folder": {
"_type": "folder",
"id": "2ZlLRZ",
"name": "Ea eos aliquam nisi in facere.",
"created_at": "2009-02-22T01:28:15+00:00",
"updated_at": "2000-12-01T16:53:49+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "0ZABao",
"name": "Delectus itaque officia non aut vel aut eum aliquam.",
"created_at": "1987-07-07T05:34:01+00:00",
"updated_at": "1984-01-27T21:39:03+00:00",
"parent_id": "0ZABao",
"has_children": true
}
},
"owner_id": "1DM7aR",
"owner": {
"id": "zOwoOd",
"display_name": "Eius atque temporibus enim.",
"first_name": "Harum repellendus excepturi harum molestiae minus autem eum fugit.",
"last_name": "Qui voluptate voluptatem aut alias commodi.",
"email": "ukoch@gmail.com",
"language": "sv"
},
"workspace_id": "mPGLLl7",
"workspace": {
"_type": "workspace",
"id": "eDJ0a1",
"name": "Fugit et accusantium dignissimos at suscipit ut.",
"company_ident": "Sunt reprehenderit harum quia error.",
"email": "dickens.turner@lebsack.info",
"root_folder_id": "Dk41zZ"
},
"file_id": "X42w3x",
"file": {
"_type": "file",
"id": "Ma2naY",
"filename": "Et perferendis dolor doloremque.",
"size": 0.516496,
"mime": "Odio et in consequatur est molestiae ab fugiat.",
"download_url": "http://towne.com/deserunt-est-quaerat-veritatis-fuga.html",
"preview_url": "http://dibbert.biz/reiciendis-iusto-perferendis-eum-molestias"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "wOy63D",
"property_id": "OREEka",
"property": {
"id": "OyWBwZ",
"title": "In iusto quaerat ea asperiores expedita est.",
"description": "Velit doloribus enim et exercitationem porro quia.",
"name": "Id rem ipsam quisquam.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "O79rgb",
"workspace": {
"_type": "workspace",
"id": "P1ll7Y",
"name": "Perspiciatis quia expedita quia quod sequi sint eum.",
"company_ident": "Minus reprehenderit rerum dolorum officia sit temporibus quaerat et.",
"email": "barton.pfeffer@gmail.com",
"root_folder_id": "PvGqNg"
}
}
}
],
"date_values": [
{
"id": "DY2reZ",
"value": "2024-12-17T00:39:17+00:00",
"duration": "P1D",
"basis": "Fugit aut facere nisi consequatur ut.",
"property_id": "NDkeda",
"property": {
"id": "wOybKD",
"title": "Quae at voluptatem modi adipisci beatae placeat alias.",
"description": "Tenetur expedita quis tempora voluptatem.",
"name": "Quibusdam sunt minima pariatur explicabo.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "7ajvaP",
"workspace": {
"_type": "workspace",
"id": "NDkNdO",
"name": "Qui qui a est est.",
"company_ident": "Error ullam nobis omnis vero cupiditate blanditiis sunt aut.",
"email": "jerde.juwan@gmail.com",
"root_folder_id": "BZ3bxD"
}
}
}
],
"numeric_values": [
{
"id": "DYP5VO",
"value": 166.01173191,
"unit": "Rerum aspernatur ad iusto fuga.",
"property_id": "Z8jleO",
"property": {
"id": "Oojk1o",
"title": "Consequatur optio deleniti enim reprehenderit rerum voluptas.",
"description": "Repellat earum saepe voluptate repellat qui voluptas sunt.",
"name": "Quos atque dignissimos dolorum temporibus sit ratione recusandae.",
"source": "system",
"data_type": "numeric",
"workspace_id": "ArBYxyk",
"workspace": {
"_type": "workspace",
"id": "O7wlpO",
"name": "Et vel non cupiditate.",
"company_ident": "Qui culpa nemo est quia.",
"email": "dakota75@hartmann.net",
"root_folder_id": "Ma2naY"
}
}
}
],
"string_values": [
{
"id": "5r72mKX",
"value": "Laboriosam hic voluptatem necessitatibus et omnis aspernatur.",
"property_id": "2dlqPAj",
"property": {
"id": "NObxZW",
"title": "In vel adipisci cumque nostrum blanditiis laborum.",
"description": "Dignissimos dolorem rem similique necessitatibus a vitae.",
"name": "Harum omnis nihil cumque fugiat.",
"source": "system",
"data_type": "numeric",
"workspace_id": "vZr97D",
"workspace": {
"_type": "workspace",
"id": "BJ5WvA",
"name": "Quae dolorem sit similique aut temporibus non.",
"company_ident": "Ut eos praesentium commodi.",
"email": "emmerich.remington@hermiston.net",
"root_folder_id": "P5zklR"
}
}
}
],
"jurisdictions": [
{
"id": "qm1ye8",
"code": "Rerum quis eveniet ut officia nesciunt quia earum qui."
}
],
"document_types": [
{
"_type": "document_type",
"id": "azPKv7",
"name": "Quibusdam voluptatem nesciunt sed eaque occaecati blanditiis aut."
}
],
"parties": [
{
"id": "6AyWV5e",
"first_name": "Eius aut et aut eius ullam unde.",
"last_name": "Ducimus perferendis aut et vitae.",
"email": "anastacio.hamill@gmail.com",
"phone": "Qui sunt saepe reiciendis veritatis.",
"title": "Est voluptas ex exercitationem ut nulla.",
"company_name": "Optio non non minus tempora corporis quibusdam magnam.",
"company_ident": "Ad quia est recusandae labore praesentium possimus.",
"address_id": "1DMnAZ",
"address": {
"id": "YZ9GWO",
"address_type": "Beatae totam similique dicta voluptas tenetur temporibus amet.",
"address_lines": "Culpa sint sit similique sunt velit quas cum.",
"city": "Et asperiores aut distinctio dignissimos labore aut totam ut.",
"locality": "Nam ut sapiente eum sint sint error.",
"administrative_area": "Velit adipisci ut officia sit doloremque et et.",
"post_code": "Quo ex iusto pariatur unde explicabo sunt.",
"country": "Qui molestiae est deserunt sed."
},
"external_references": [
{
"id": "O7pWBD",
"name": "Vitae et sunt modi temporibus dolorem rerum.",
"title": "Alias dolore atque velit et nulla ab.",
"value": "Ea et ea non nemo."
}
]
}
],
"attachments": [
{
"id": "jb5pNRX",
"created_at": "1983-03-17T13:46:44+00:00",
"updated_at": "2015-04-14T15:34:38+00:00",
"file_id": "1DM7aR",
"file": {
"_type": "file",
"id": "OwJ0ky",
"filename": "example.pdf",
"size": 2.16473384,
"mime": "application/pdf",
"download_url": "https://goodwin.com/assumenda-eum-saepe-ipsa-nemo-dignissimos.html",
"preview_url": "http://grady.info/maxime-beatae-et-ab-perferendis-autem"
}
}
],
"external_references": [
{
"id": "PZp4xZ",
"name": "Ut et est illo beatae necessitatibus.",
"title": "Aperiam autem corrupti doloribus dolores.",
"value": "Eaque qui numquam et temporibus exercitationem ea neque."
}
],
"tags": [
{
"tag": "A incidunt ipsum rem maiores libero ipsa in quidem."
}
],
"terms_and_conditions": {
"date": "1976-02-27T09:23:46+00:00",
"effective_date": "1982-04-18T05:46:02+00:00",
"term_end_date": "2010-01-01T23:02:14+00:00",
"signing_date": "1989-09-18T00:07:01+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1989-12-05T16:21:33+00:00"
},
"breadcrumb": [
{
"id": "pZ1NWa",
"name": "Quia quibusdam cupiditate enim veritatis quos voluptatem repudiandae.",
"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 reminder data
requires authentication
Example request:
curl --request GET \
--get "https://api.docue.com/public/v2/documents/pZG0Ra/reminders/49137y" \
--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/pZG0Ra/reminders/49137y"
);
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/pZG0Ra/reminders/49137y';
$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/pZG0Ra/reminders/49137y'
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": "YqR4oYj",
"event_type": "document.reminder",
"title": "Commodi quae natus eos omnis.",
"document": {
"download_url": "Consequatur et laboriosam voluptate et sint.",
"id": "3dEp0z",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Quibusdam et molestias.",
"description": "Nostrum possimus saepe nam recusandae.",
"archive_status": "completed",
"contains_pii": "contains_sensitive_pii",
"contract_id": "GDm4bO",
"contract": {
"_type": "contract",
"id": "Ow64Yy",
"name": "Voluptatum adipisci fuga ullam libero dolor omnis ducimus.",
"stage": "Veritatis id consequatur quia omnis.",
"document_id": "ZgdoAa",
"sign_method": "docusign",
"template_id": "Sit distinctio voluptatum ipsam quae adipisci.",
"template": {
"id": "xoErzG",
"name": "Dolores sint qui animi numquam neque sint iusto.",
"description": "Illum voluptas et iste voluptatem repellendus qui.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "aEGyVD",
"display_name": "Dignissimos magnam ullam ratione provident impedit cumque.",
"first_name": "In qui veritatis sequi ut quaerat quidem.",
"last_name": "Nihil sunt possimus exercitationem molestiae fugiat et voluptate.",
"email": "meaghan.pollich@yahoo.com",
"language": "sv"
},
"signing_settings": {
"id": "vOxA1D",
"created_at": "2015-02-16T16:50:10+00:00",
"updated_at": "1984-12-30T11:03:55+00:00",
"contract_id": "GDm4bO",
"message": "Id et maxime enim est.",
"expires_at": "1997-04-13T05:01:21+00:00",
"reminders_start": "1974-06-05T13:36:05+00:00",
"reminders_end": "2020-08-31T19:31:49+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "ZGdPbE",
"folder": {
"_type": "folder",
"id": "NDkdZo",
"name": "Consequatur ipsam ut aut dolores quos veniam tenetur.",
"created_at": "2007-08-10T16:21:18+00:00",
"updated_at": "2017-09-17T21:32:23+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "Yzlx1v",
"name": "Ipsa quo tempore deleniti non aliquam ut tempore.",
"created_at": "2014-11-30T07:53:44+00:00",
"updated_at": "1975-03-19T00:31:23+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "ZN7R0a",
"owner": {
"id": "d9G5n7L",
"display_name": "Reiciendis velit vero odio ipsum omnis.",
"first_name": "Est voluptatem est animi facere adipisci autem saepe.",
"last_name": "Impedit delectus natus omnis aspernatur aut sunt aut.",
"email": "pfeffer.arnaldo@yahoo.com",
"language": "sv"
},
"workspace_id": "7ajvaP",
"workspace": {
"_type": "workspace",
"id": "PWvd41",
"name": "Saepe nam reiciendis natus est et distinctio et.",
"company_ident": "Consequatur minima molestiae beatae.",
"email": "morar.clinton@yahoo.com",
"root_folder_id": "wOywZL"
},
"file_id": "Ow0No8",
"file": {
"_type": "file",
"id": "DmmBeD",
"filename": "Doloremque id enim deleniti quo et voluptate modi.",
"size": 62.257849,
"mime": "Et beatae recusandae eius repellat possimus voluptas occaecati possimus.",
"download_url": "http://www.bradtke.com/aperiam-omnis-animi-officia-animi-iure-quo",
"preview_url": "http://rippin.com/perferendis-voluptatem-excepturi-perferendis-laudantium-non-iusto"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "ZNE53D",
"value": true,
"property_id": "7gmyLq",
"property": {
"id": "2rW16Xd",
"title": "Consectetur et illum officia.",
"description": "Nam qui voluptatum molestiae nemo provident enim odio voluptatem.",
"name": "Culpa omnis optio quod quo nobis quaerat.",
"source": "system",
"data_type": "numeric",
"workspace_id": "LDQ3aq",
"workspace": {
"_type": "workspace",
"id": "wOymbO",
"name": "Corrupti sint harum doloremque earum commodi voluptatem.",
"company_ident": "Architecto blanditiis quibusdam eos voluptas reprehenderit.",
"email": "nkihn@gerhold.com",
"root_folder_id": "GZg0Qa"
}
}
}
],
"date_values": [
{
"id": "PZp8RZ",
"value": "1983-08-13T05:38:11+00:00",
"duration": "P1D",
"basis": "Voluptas consequuntur sit magni numquam sed.",
"property_id": "PG0GEM",
"property": {
"id": "aeeAq7",
"title": "Rerum reprehenderit minima nemo.",
"description": "Odit quibusdam cupiditate nobis illum omnis nostrum quisquam.",
"name": "Suscipit reiciendis magnam assumenda enim rerum blanditiis.",
"source": "system",
"data_type": "boolean",
"workspace_id": "DMWwka",
"workspace": {
"_type": "workspace",
"id": "NbqML0",
"name": "Quidem consequatur ratione ad ea.",
"company_ident": "Qui quibusdam expedita et error.",
"email": "piper.fritsch@hotmail.com",
"root_folder_id": "yNvlQJ"
}
}
}
],
"numeric_values": [
{
"id": "EqyvmMb",
"value": 0.0635,
"unit": "Harum deserunt iusto aspernatur accusamus.",
"property_id": "vOxl4O",
"property": {
"id": "aPzlqD",
"title": "Magni dolorem quidem odit.",
"description": "Debitis nostrum qui et dolore maiores quia dicta maiores.",
"name": "Ut exercitationem rem voluptatem quae corrupti et.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "vQn2Pe3",
"workspace": {
"_type": "workspace",
"id": "d9Xk8Q",
"name": "Est hic optio aut ut.",
"company_ident": "Velit quidem officiis nihil occaecati facilis ipsa.",
"email": "iondricka@hotmail.com",
"root_folder_id": "7ajl6D"
}
}
}
],
"string_values": [
{
"id": "5aP0Ra",
"value": "Ea id similique sapiente amet aperiam possimus qui.",
"property_id": "mO7J5a",
"property": {
"id": "pZ1noa",
"title": "Perferendis corporis aut suscipit asperiores.",
"description": "Accusantium eum vero et nemo.",
"name": "Optio consequatur odit alias at non placeat culpa.",
"source": "system",
"data_type": "boolean",
"workspace_id": "gD6jDw",
"workspace": {
"_type": "workspace",
"id": "oazEZ4",
"name": "Assumenda odio inventore facere cumque voluptatibus magni sit et.",
"company_ident": "Exercitationem incidunt similique qui aliquid.",
"email": "pollich.ayla@gmail.com",
"root_folder_id": "1DM7aR"
}
}
}
],
"jurisdictions": [
{
"id": "eDJ0a1",
"code": "Quia perferendis autem reprehenderit reiciendis modi."
}
],
"document_types": [
{
"_type": "document_type",
"id": "mO7qZe",
"name": "Incidunt minima reiciendis delectus commodi vero voluptatem iure."
}
],
"parties": [
{
"id": "ejpy12",
"first_name": "Cupiditate vero libero et ut impedit est ex.",
"last_name": "Quia deserunt eum voluptatum voluptates.",
"email": "chandler.grant@kuvalis.org",
"phone": "Qui quae itaque eius et consequatur.",
"title": "Quia officiis non sunt.",
"company_name": "Natus voluptatem enim reprehenderit.",
"company_ident": "Natus nulla sunt ducimus veritatis officiis iure dolor eum.",
"address_id": "aEQAba",
"address": {
"id": "1DM7aR",
"address_type": "Molestiae ut unde repudiandae quo labore nemo.",
"address_lines": "Quo deleniti rerum voluptatem et cumque deserunt.",
"city": "Dolores maxime officia est fugiat.",
"locality": "Error quo minus nemo mollitia.",
"administrative_area": "Culpa et velit officiis adipisci asperiores qui non reprehenderit.",
"post_code": "Nostrum cum aliquam ea quasi.",
"country": "Et iusto iure sed nihil aperiam."
},
"external_references": [
{
"id": "O4NG5Z",
"name": "Minima doloribus tempora blanditiis eius assumenda voluptatem iste.",
"title": "Voluptas enim et illum accusamus autem culpa.",
"value": "Exercitationem accusamus eum enim odio sint et tenetur ut."
}
]
}
],
"attachments": [
{
"id": "kb60xkR",
"created_at": "1981-12-30T19:47:23+00:00",
"updated_at": "1970-10-06T10:18:48+00:00",
"file_id": "aBQ0Py",
"file": {
"_type": "file",
"id": "OyBAqD",
"filename": "example.pdf",
"size": 383861.327451,
"mime": "application/pdf",
"download_url": "http://hauck.com/veniam-sequi-dolorum-voluptatem",
"preview_url": "http://harris.info/aut-esse-ex-nostrum-occaecati-enim-commodi.html"
}
}
],
"external_references": [
{
"id": "ZGxjNn",
"name": "Est quo quod aut consequatur eos.",
"title": "Corporis officia nihil doloribus sed corporis quo delectus.",
"value": "Omnis ullam soluta facere."
}
],
"tags": [
{
"tag": "Nihil aut occaecati quas dolorem iusto harum."
}
],
"terms_and_conditions": {
"date": "1997-11-02T04:36:34+00:00",
"effective_date": "2011-02-03T17:38:21+00:00",
"term_end_date": "2021-10-27T18:03:31+00:00",
"signing_date": "2024-04-04T17:59:36+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
},
"retention": {
"end_date": "2009-04-23T21:03:32+00:00"
},
"breadcrumb": [
{
"id": "q2NvP5",
"name": "Omnis quam eos beatae.",
"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/pbp9x8/reminders/6j08y6" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"event_type\": \"document.reminder\",
\"title\": \"Est facilis eius est.\",
\"schedules\": [
{
\"next_run\": \"1975-12-10T09:55:03+00:00\",
\"id\": \"ZV3mjk\",
\"last_run\": \"2016-12-04T09:52:44+00:00\",
\"interval\": 294335796
}
],
\"recipients\": [
{
\"value\": \"john.doe@doe.com\",
\"channel\": \"email\",
\"language\": \"pl\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/pbp9x8/reminders/6j08y6"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"event_type": "document.reminder",
"title": "Est facilis eius est.",
"schedules": [
{
"next_run": "1975-12-10T09:55:03+00:00",
"id": "ZV3mjk",
"last_run": "2016-12-04T09:52:44+00:00",
"interval": 294335796
}
],
"recipients": [
{
"value": "john.doe@doe.com",
"channel": "email",
"language": "pl"
}
]
};
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/pbp9x8/reminders/6j08y6';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'event_type' => 'document.reminder',
'title' => 'Est facilis eius est.',
'schedules' => [
[
'next_run' => '1975-12-10T09:55:03+00:00',
'id' => 'ZV3mjk',
'last_run' => '2016-12-04T09:52:44+00:00',
'interval' => 294335796,
],
],
'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/pbp9x8/reminders/6j08y6'
payload = {
"event_type": "document.reminder",
"title": "Est facilis eius est.",
"schedules": [
{
"next_run": "1975-12-10T09:55:03+00:00",
"id": "ZV3mjk",
"last_run": "2016-12-04T09:52:44+00:00",
"interval": 294335796
}
],
"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('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": "EGMvb2",
"event_type": "document.reminder",
"title": "Quibusdam dolores molestiae delectus ea distinctio.",
"document": {
"download_url": "Dolorem reprehenderit totam sed quia in et.",
"id": "Znojza",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Saepe voluptas voluptatibus numquam.",
"description": "Rerum aut sunt optio voluptate repellendus.",
"archive_status": "completed",
"contains_pii": "contains_pii",
"contract_id": "aLe1yP",
"contract": {
"_type": "contract",
"id": "aPb1vW",
"name": "Quaerat est dicta quos voluptate aliquam incidunt suscipit molestias.",
"stage": "Iure optio qui explicabo saepe dolore et.",
"document_id": "gD6jDw",
"sign_method": "strong",
"template_id": "Est assumenda totam nemo molestiae nam.",
"template": {
"id": "kbQgpz",
"name": "Quas explicabo explicabo sed dolorum facilis.",
"description": "Quia non occaecati vitae.",
"type": "tailored"
},
"user": {
"id": "Ma2naY",
"display_name": "Consequatur cumque consequatur veritatis occaecati impedit.",
"first_name": "Et est sit impedit sint aspernatur unde sint ad.",
"last_name": "Aut magni voluptas vero et cupiditate.",
"email": "nico.dach@kessler.com",
"language": "pl"
},
"signing_settings": {
"id": "3dgvyRd",
"created_at": "1977-04-24T04:27:50+00:00",
"updated_at": "2004-02-08T21:07:44+00:00",
"contract_id": "ZAjz8x",
"message": "Rem ratione voluptas quisquam.",
"expires_at": "1990-11-08T10:52:13+00:00",
"reminders_start": "1997-05-05T13:44:25+00:00",
"reminders_end": "1997-07-21T02:28:40+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "Oq4z9o",
"folder": {
"_type": "folder",
"id": "Oq22oD",
"name": "Aut veritatis quia at voluptate vel magnam sed.",
"created_at": "1976-03-15T18:45:51+00:00",
"updated_at": "2022-06-24T00:18:35+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "eDJ0a1",
"name": "Pariatur vero ut odio blanditiis impedit praesentium eius.",
"created_at": "1998-09-22T01:18:06+00:00",
"updated_at": "2006-12-05T21:26:37+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "ENRYn7",
"owner": {
"id": "vbqpYJo",
"display_name": "Maxime consequatur odit velit enim dolores minima.",
"first_name": "Quo quia odio unde nostrum quae.",
"last_name": "Sit ducimus officiis et voluptatem.",
"email": "dawson16@crooks.com",
"language": "sv"
},
"workspace_id": "DJwQ0Z",
"workspace": {
"_type": "workspace",
"id": "DWqnna",
"name": "Ut est iusto repellat id ut.",
"company_ident": "Reiciendis voluptatibus blanditiis autem quod.",
"email": "dayana32@emmerich.com",
"root_folder_id": "NObxZW"
},
"file_id": "67gy0V6",
"file": {
"_type": "file",
"id": "OyNGWw",
"filename": "Et voluptatem quod dolorem repudiandae possimus ut.",
"size": 534.7,
"mime": "Aut excepturi fugit illum voluptates.",
"download_url": "http://www.daugherty.biz/",
"preview_url": "http://will.info/"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "MDWEam",
"property_id": "D67g0Z",
"property": {
"id": "6Dd90Z",
"title": "Aut ipsa exercitationem voluptatem magni provident ducimus dolor.",
"description": "Voluptas quis molestiae asperiores.",
"name": "Quisquam enim perspiciatis eos neque.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "WMAkb9",
"workspace": {
"_type": "workspace",
"id": "wOyjAD",
"name": "Quaerat odio ut qui quia.",
"company_ident": "Minus consequatur sed et veritatis eum amet omnis.",
"email": "julian81@gmail.com",
"root_folder_id": "aPMKqO"
}
}
}
],
"date_values": [
{
"id": "wOy55O",
"value": "1977-10-25T21:51:35+00:00",
"duration": "P1D",
"basis": "Consequatur voluptatibus rerum reprehenderit minima eaque incidunt eum.",
"property_id": "1DML7O",
"property": {
"id": "Z1mo0N",
"title": "Excepturi laudantium est libero at.",
"description": "Vero ut atque fuga fugiat perspiciatis optio.",
"name": "Rerum quaerat id assumenda.",
"source": "system",
"data_type": "date",
"workspace_id": "1gp6g7L",
"workspace": {
"_type": "workspace",
"id": "LxBoEg",
"name": "Mollitia quia illum asperiores accusamus maiores.",
"company_ident": "Sapiente dolorem commodi neque saepe sed rerum minus officia.",
"email": "koepp.rosanna@yahoo.com",
"root_folder_id": "1mpVNlP"
}
}
}
],
"numeric_values": [
{
"id": "kOR7eD",
"value": 356.9,
"unit": "Doloribus doloremque dolore et.",
"property_id": "Y22EPV",
"property": {
"id": "DYjGoV",
"title": "Ea delectus nostrum quia sed veritatis saepe.",
"description": "Excepturi porro quis ipsum nobis.",
"name": "Sit et sed error quam ullam.",
"source": "user_defined",
"data_type": "date",
"workspace_id": "MDW2eO",
"workspace": {
"_type": "workspace",
"id": "ly83r4",
"name": "Fugit dolorem voluptas porro veniam accusantium.",
"company_ident": "Provident architecto consequuntur nam voluptas architecto nostrum.",
"email": "hilbert28@baumbach.org",
"root_folder_id": "pZG0Ra"
}
}
}
],
"string_values": [
{
"id": "QLdVJL",
"value": "Debitis quis iste nisi.",
"property_id": "MDWGoD",
"property": {
"id": "BaE2YO",
"title": "Cumque voluptatem consequuntur numquam unde accusantium dignissimos dolores.",
"description": "Commodi eius rerum esse.",
"name": "Consequuntur rerum vitae et dignissimos.",
"source": "system",
"data_type": "numeric",
"workspace_id": "ZX9w5P",
"workspace": {
"_type": "workspace",
"id": "Dd95xZ",
"name": "Ducimus dolorem quia quisquam voluptatibus similique asperiores.",
"company_ident": "Ratione non ex quae labore aut odio.",
"email": "adeckow@wilderman.biz",
"root_folder_id": "J91gK2"
}
}
}
],
"jurisdictions": [
{
"id": "bRl64x",
"code": "Molestias repellendus veritatis quasi sint."
}
],
"document_types": [
{
"_type": "document_type",
"id": "9PKPPr",
"name": "Voluptates nobis quo voluptas odit."
}
],
"parties": [
{
"id": "nnxAjv",
"first_name": "Et possimus sint qui nobis.",
"last_name": "Expedita quia vitae et nam.",
"email": "laurianne49@hotmail.com",
"phone": "Minima aut labore dolor est in qui numquam quisquam.",
"title": "Ut explicabo asperiores nobis vel laboriosam ducimus sed.",
"company_name": "Et voluptatem laborum laudantium aperiam qui nostrum iure qui.",
"company_ident": "Animi sit quod perferendis.",
"address_id": "a0dA5a",
"address": {
"id": "Oq4rA8",
"address_type": "Et iste aut tenetur.",
"address_lines": "Et quis et quibusdam ut corporis ad nisi.",
"city": "Dolores aut minima consectetur rem.",
"locality": "Cum voluptatem excepturi vel et nihil officia.",
"administrative_area": "Tempora provident nostrum quod.",
"post_code": "Tempora ut sed in tempore.",
"country": "Et quod exercitationem explicabo et dignissimos."
},
"external_references": [
{
"id": "xQ9WgPj",
"name": "Cum sint odio qui beatae voluptas.",
"title": "Totam dolorum impedit est incidunt aut qui.",
"value": "Impedit beatae error laborum laboriosam fuga sit."
}
]
}
],
"attachments": [
{
"id": "GZgJYD",
"created_at": "1988-06-13T17:30:24+00:00",
"updated_at": "1995-11-20T20:16:31+00:00",
"file_id": "RoMXV3",
"file": {
"_type": "file",
"id": "dBpR3z",
"filename": "example.pdf",
"size": 24054.371050173,
"mime": "application/pdf",
"download_url": "http://kub.com/",
"preview_url": "http://www.carroll.net/exercitationem-ea-culpa-aperiam-maiores-aspernatur-tenetur-quis"
}
}
],
"external_references": [
{
"id": "lQ3RwJo",
"name": "Est et enim ut consectetur qui non.",
"title": "Facilis suscipit est labore rerum nam expedita.",
"value": "Possimus sed natus libero sed."
}
],
"tags": [
{
"tag": "Est ex et sit consequatur et."
}
],
"terms_and_conditions": {
"date": "1988-02-13T18:34:58+00:00",
"effective_date": "1987-03-28T11:37:27+00:00",
"term_end_date": "2025-10-22T00:35:06+00:00",
"signing_date": "1985-09-09T22:14:02+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1977-03-07T03:51:48+00:00"
},
"breadcrumb": [
{
"id": "WMe2lE",
"name": "Facere velit quis praesentium veritatis.",
"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.Delete a reminder
requires authentication
Example request:
curl --request DELETE \
"https://api.docue.com/public/v2/documents/OyA8NK/reminders/56rg3Xe" \
--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/OyA8NK/reminders/56rg3Xe"
);
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/OyA8NK/reminders/56rg3Xe';
$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/OyA8NK/reminders/56rg3Xe'
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\": \"Molestiae est eum facilis.\"
}"
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": "Molestiae est eum facilis."
};
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' => 'Molestiae est eum facilis.',
],
]
);
$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": "Molestiae est eum facilis."
}
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": "Jblqg5g",
"name": "Repellat rerum rerum nostrum impedit dolorem accusantium delectus."
}
}
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": "oazMEZ",
"name": "Consequuntur explicabo voluptatem necessitatibus fugiat velit dicta aliquam."
}
}
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": "JZndzO",
"name": "Et non necessitatibus odio tempore molestias."
}
}
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/BZV36a/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/BZV36a/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/BZV36a/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/BZV36a/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": "Zgd69a",
"name": "Et iure placeat qui quia nihil repellat reiciendis."
}
]
}
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/K7RjGE/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/K7RjGE/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/K7RjGE/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/K7RjGE/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": "rER0Q6",
"name": "Est laboriosam veniam libero provident voluptatibus at et."
}
]
}
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/NObxZW/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/NObxZW/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/NObxZW/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/NObxZW/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": "mO7J5a",
"created_at": "1993-08-26T19:53:44+00:00",
"updated_at": "1987-11-23T08:28:51+00:00",
"file_id": "gD6jDw",
"file": {
"_type": "file",
"id": "MDW7oD",
"filename": "example.pdf",
"size": 38186,
"mime": "application/pdf",
"download_url": "http://okuneva.com/quibusdam-non-alias-voluptatem",
"preview_url": "http://durgan.com/adipisci-est-qui-eum-quis-quisquam-sit.html"
},
"documents": [
{
"download_url": "Quis laborum quidem minima ut rem.",
"id": "Ox7Lw9",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Recusandae non debitis quasi.",
"description": "Natus nisi at dolorem quia iste vel.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "EQkdEP",
"contract": {
"_type": "contract",
"id": "DYjL5Z",
"name": "Sit sit ullam ad error assumenda et.",
"stage": "Molestiae natus necessitatibus modi et inventore impedit ducimus asperiores.",
"document_id": "a2pdmn",
"sign_method": "strong",
"template_id": "Incidunt omnis impedit aliquam amet quia et.",
"template": {
"id": "Oqxl9W",
"name": "Et et enim repellat labore.",
"description": "Molestiae cumque ipsam unde beatae.",
"type": "tailored",
"is_upload_template": true
},
"user": {
"id": "WaBdeD",
"display_name": "Qui inventore dolores quis.",
"first_name": "Blanditiis molestias rerum qui itaque fugit iste eaque.",
"last_name": "Aut amet est facilis dicta.",
"email": "rodger10@nienow.com",
"language": "pl"
},
"signing_settings": {
"id": "azn8X3",
"created_at": "2014-12-04T08:48:32+00:00",
"updated_at": "1979-05-08T20:39:14+00:00",
"contract_id": "Oymyvb",
"message": "Pariatur reprehenderit ut facilis iste at recusandae.",
"expires_at": "1986-07-18T13:57:45+00:00",
"reminders_start": "2002-07-22T19:40:39+00:00",
"reminders_end": "1971-02-14T05:56:52+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "l1Yp2y",
"folder": {
"_type": "folder",
"id": "aeqy4G",
"name": "Qui omnis quasi consequuntur eos veritatis.",
"created_at": "1973-02-11T18:01:59+00:00",
"updated_at": "1994-07-18T18:16:01+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "Q6nBgL",
"name": "Et aut quaerat omnis nam inventore ut excepturi.",
"created_at": "1984-08-02T09:59:38+00:00",
"updated_at": "2011-08-15T00:06:51+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "Zl3knD",
"owner": {
"id": "Dm48nO",
"display_name": "Ut qui ipsam voluptatem necessitatibus.",
"first_name": "Excepturi fugit dicta soluta quae sit.",
"last_name": "Fugit perspiciatis nulla molestiae dolorem qui aut quia.",
"email": "mpacocha@ruecker.com",
"language": "sv"
},
"workspace_id": "aEqwVa",
"workspace": {
"_type": "workspace",
"id": "LZ8dkZ",
"name": "Aliquam dolor eos voluptate asperiores quia minus voluptas.",
"company_ident": "Et omnis animi numquam exercitationem doloremque laboriosam temporibus rem.",
"email": "cole.hodkiewicz@gmail.com",
"root_folder_id": "q8yB38"
},
"file_id": "pZGRDw",
"file": {
"_type": "file",
"id": "9n23onw",
"filename": "Quae provident iure sed cupiditate eos.",
"size": 712445.0309495,
"mime": "Molestias et quam quas laudantium omnis molestiae fugiat voluptas.",
"download_url": "http://kihn.com/enim-possimus-perspiciatis-fugit-est",
"preview_url": "https://osinski.com/nostrum-vel-facere-explicabo-molestiae-architecto.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "wOywZL",
"value": true,
"property_id": "1DM7aR",
"property": {
"id": "wOywZL",
"title": "Qui et cumque aut.",
"description": "Magnam nobis amet eveniet officia.",
"name": "Molestiae voluptatem id maxime quibusdam architecto deleniti enim.",
"source": "system",
"data_type": "string",
"workspace_id": "DM3Xyr",
"workspace": {
"_type": "workspace",
"id": "Ma2naY",
"name": "Occaecati quibusdam ad est voluptate.",
"company_ident": "Odit rem voluptas ut sed praesentium voluptatem odio.",
"email": "napoleon.wisozk@heidenreich.net",
"root_folder_id": "yyemyV9"
}
}
}
],
"date_values": [
{
"id": "4aLPRa",
"value": "2004-08-18T21:19:07+00:00",
"duration": "P1D",
"basis": "Repellat et placeat similique commodi sit.",
"property_id": "0ZABao",
"property": {
"id": "8pQEYmV",
"title": "Sed voluptas vero unde corporis aut error distinctio.",
"description": "Autem labore et ut officia magnam.",
"name": "Itaque pariatur illo rerum cum atque.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "LZKJYD",
"workspace": {
"_type": "workspace",
"id": "ZV68eZ",
"name": "Cum possimus commodi repudiandae corrupti deserunt.",
"company_ident": "Possimus voluptate repellat facere magnam quaerat.",
"email": "ernesto.breitenberg@ebert.com",
"root_folder_id": "5rE7rA"
}
}
}
],
"numeric_values": [
{
"id": "1DM7aR",
"value": 228767528.85,
"unit": "Tempore necessitatibus est voluptas architecto minus.",
"property_id": "BaEqMa",
"property": {
"id": "nzX14w6",
"title": "Error ut dolorem magnam nemo provident consequuntur totam.",
"description": "Placeat ea itaque velit eos omnis sed laudantium autem.",
"name": "Aspernatur quos in in ratione eaque.",
"source": "system",
"data_type": "date",
"workspace_id": "Dm9r7D",
"workspace": {
"_type": "workspace",
"id": "01Knb7Y",
"name": "Rerum et magni voluptate.",
"company_ident": "Rerum iusto dolor maiores consequatur.",
"email": "constantin18@daniel.com",
"root_folder_id": "ZA6Wxa"
}
}
}
],
"string_values": [
{
"id": "wOy8qa",
"value": "Excepturi veniam hic ut eius dolorem vel.",
"property_id": "DJ67XD",
"property": {
"id": "oQBnBo",
"title": "Tenetur ab est maiores est quidem molestiae quo autem.",
"description": "Consequuntur qui consectetur praesentium.",
"name": "Reiciendis ullam quia soluta consequatur illo.",
"source": "system",
"data_type": "boolean",
"workspace_id": "OvgBvD",
"workspace": {
"_type": "workspace",
"id": "Ma2Jna",
"name": "Qui error quia omnis ut dignissimos.",
"company_ident": "Repellat qui illo minus expedita nihil.",
"email": "tdamore@gmail.com",
"root_folder_id": "lLBBY0"
}
}
}
],
"jurisdictions": [
{
"id": "BaERbO",
"code": "Ducimus omnis totam provident aut."
}
],
"document_types": [
{
"_type": "document_type",
"id": "ZNoQya",
"name": "Aperiam ullam deserunt consequatur quidem."
}
],
"parties": [
{
"id": "a0nbND",
"first_name": "Est earum enim iure placeat illo ea.",
"last_name": "Provident et officiis dolorem vero qui rerum vel doloribus.",
"email": "freida.kuvalis@hotmail.com",
"phone": "Quo sapiente in non eum dolorum aspernatur ad.",
"title": "Corporis expedita et dolores voluptatem iure.",
"company_name": "In quidem error dolor molestias.",
"company_ident": "Eum nostrum enim et est in.",
"address_id": "NObxZW",
"address": {
"id": "dw0xqk",
"address_type": "In sequi recusandae expedita porro velit.",
"address_lines": "Totam ab ea voluptas perspiciatis aut.",
"city": "Rerum accusamus quis atque vero.",
"locality": "Quia qui non voluptates aut est.",
"administrative_area": "Et corrupti minus quia distinctio.",
"post_code": "Rerum minima itaque ipsam eligendi quo nisi.",
"country": "Molestiae consequatur placeat aut autem."
},
"external_references": [
{
"id": "Oq8bja",
"name": "Deserunt velit doloribus est impedit aliquam.",
"title": "Expedita ut similique ea omnis.",
"value": "Suscipit voluptas neque optio laudantium animi."
}
]
}
],
"reminders": [
{
"id": "6GdekW",
"event_type": "document.reminder",
"title": "Tempore pariatur minus cum reprehenderit voluptatem asperiores est."
}
],
"external_references": [
{
"id": "EPbKxV",
"name": "Voluptatem quod adipisci eaque perferendis nobis blanditiis repudiandae.",
"title": "Et amet iste nobis et quisquam numquam voluptatem.",
"value": "Ab explicabo labore dolor quis tempora."
}
],
"tags": [
{
"tag": "Repellendus voluptatibus sequi autem at reiciendis et explicabo."
}
],
"terms_and_conditions": {
"date": "2018-05-11T20:48:17+00:00",
"effective_date": "2002-09-29T05:56:57+00:00",
"term_end_date": "2024-04-27T11:41:29+00:00",
"signing_date": "1995-02-10T09:52:25+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "1981-11-23T09:15:03+00:00"
},
"breadcrumb": [
{
"id": "PZpj8O",
"name": "Ut omnis reprehenderit quas laboriosam aut animi non.",
"depth": 14
}
]
}
]
}
]
}
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/ZgJ4YD/attachments" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "file_name=Quo quis veritatis dolore ut."\
--form "file=@/tmp/phpJJafbi" const url = new URL(
"https://api.docue.com/public/v2/documents/ZgJ4YD/attachments"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "multipart/form-data",
"Accept": "application/json",
};
const body = new FormData();
body.append('file_name', 'Quo quis veritatis dolore ut.');
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/ZgJ4YD/attachments';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'multipart/form-data',
'Accept' => 'application/json',
],
'multipart' => [
[
'name' => 'file_name',
'contents' => 'Quo quis veritatis dolore ut.'
],
[
'name' => 'file',
'contents' => fopen('/tmp/phpJJafbi', 'r')
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/ZgJ4YD/attachments'
files = {
'file_name': (None, 'Quo quis veritatis dolore ut.'),
'file': open('/tmp/phpJJafbi', 'rb')}
payload = {
"file_name": "Quo quis veritatis dolore ut."
}
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": "QBvvxbY",
"created_at": "2022-01-31T00:48:20+00:00",
"updated_at": "2006-12-08T09:07:43+00:00",
"file_id": "J1n58X",
"file": {
"_type": "file",
"id": "ZVp5ek",
"filename": "example.pdf",
"size": 34381.10537449,
"mime": "application/pdf",
"download_url": "http://hamill.net/",
"preview_url": "https://thiel.biz/et-consectetur-est-accusantium-saepe.html"
},
"documents": [
{
"download_url": "Nobis vel sapiente sit ipsum consequatur consequatur.",
"id": "0ZABao",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Est quisquam dolorem vel.",
"description": "Enim accusantium ipsa laudantium harum assumenda.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "DQN5k3",
"contract": {
"_type": "contract",
"id": "2Jrn7n",
"name": "Est eius eos et fuga.",
"stage": "Repudiandae ipsam et accusantium ipsa natus qui alias.",
"document_id": "0ZABao",
"sign_method": "docusign",
"template_id": "Nobis in unde provident veniam et ex quam.",
"template": {
"id": "QwweBQ6",
"name": "Optio modi voluptatem vitae qui.",
"description": "Dolorum sequi quia sit enim sint minus harum.",
"type": "tailored",
"is_custom_base_template": true
},
"user": {
"id": "1DM7aR",
"display_name": "Iste quia voluptas sit similique earum velit velit.",
"first_name": "Ratione voluptatibus quidem ut doloribus qui quia dolor et.",
"last_name": "Consequuntur qui sequi culpa recusandae ut esse.",
"email": "mlindgren@hotmail.com",
"language": "de"
},
"signing_settings": {
"id": "BZ3KYZ",
"created_at": "2013-03-05T16:46:41+00:00",
"updated_at": "1979-09-02T07:41:42+00:00",
"contract_id": "Ow3moO",
"message": "Alias omnis quae sunt a.",
"expires_at": "1985-03-12T10:34:41+00:00",
"reminders_start": "1993-09-01T16:15:16+00:00",
"reminders_end": "1984-04-27T16:09:08+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "aBJ0ea",
"folder": {
"_type": "folder",
"id": "vZr7az",
"name": "Suscipit ea illum fuga laborum labore laboriosam et.",
"created_at": "1999-05-29T17:51:34+00:00",
"updated_at": "2019-05-25T09:08:06+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "ZK9A31",
"name": "Labore accusantium quo omnis facere enim dolorem.",
"created_at": "1987-02-10T05:41:51+00:00",
"updated_at": "1987-01-04T06:56:10+00:00",
"parent_id": "0ZABao",
"has_children": true
},
"has_children": true
},
"owner_id": "8OvjXO",
"owner": {
"id": "Oym0Ag",
"display_name": "Non eum adipisci aut optio dolorum quaerat.",
"first_name": "Omnis voluptas rerum placeat corporis incidunt.",
"last_name": "Iure optio magnam debitis voluptas quo.",
"email": "wheathcote@morissette.com",
"language": "de"
},
"workspace_id": "ZpVLNO",
"workspace": {
"_type": "workspace",
"id": "Z9ykop",
"name": "Ut voluptatum impedit mollitia quod.",
"company_ident": "Ullam deserunt atque qui esse dolor.",
"email": "naomi.schaefer@gmail.com",
"root_folder_id": "aP3rvR"
},
"file_id": "ZnyMWD",
"file": {
"_type": "file",
"id": "ZgWo4g",
"filename": "Aut rem accusamus nisi iure.",
"size": 3.78392018,
"mime": "Id enim autem quis ducimus.",
"download_url": "http://www.stiedemann.com/qui-et-distinctio-enim",
"preview_url": "http://bruen.com/"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "1DM7aR",
"property_id": "O77qzB",
"property": {
"id": "aLJl7D",
"title": "Minima fugiat expedita tempora excepturi cum vel aut.",
"description": "Ipsa iusto ut necessitatibus incidunt est.",
"name": "Eum quis nisi necessitatibus.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "DQ4gR6",
"workspace": {
"_type": "workspace",
"id": "Ob4JkZ",
"name": "Nulla earum rerum harum in ipsa dolor.",
"company_ident": "Sit inventore beatae ut commodi exercitationem et.",
"email": "faye76@schaden.com",
"root_folder_id": "WaB3AO"
}
}
}
],
"date_values": [
{
"id": "vOxbJZ",
"value": "1990-02-15T00:46:37+00:00",
"duration": "P1D",
"basis": "Neque laboriosam dolores labore.",
"property_id": "LDQ3aq",
"property": {
"id": "6AordyA",
"title": "Ratione assumenda sit quisquam a officiis.",
"description": "Cumque consequatur quis veritatis totam similique aperiam dignissimos.",
"name": "Esse nam in consequatur aut dignissimos accusantium.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "DJ2AoD",
"workspace": {
"_type": "workspace",
"id": "ga0j5D",
"name": "Sunt ut debitis ea sit mollitia mollitia.",
"company_ident": "Porro saepe rem sed libero sint.",
"email": "qwindler@yahoo.com",
"root_folder_id": "Z9WWpp"
}
}
}
],
"numeric_values": [
{
"id": "ORPJkZ",
"value": 834.07996,
"unit": "Nobis facilis quia illo ut.",
"property_id": "Obe0wa",
"property": {
"id": "GDmlVO",
"title": "Qui blanditiis iusto tempora aut exercitationem.",
"description": "Provident cupiditate esse ab ipsum officiis hic.",
"name": "Ipsam itaque et placeat modi qui eum eius necessitatibus.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "NObxZW",
"workspace": {
"_type": "workspace",
"id": "eDJNRD",
"name": "Nesciunt tempora voluptas odio eius repellendus eos dolorem.",
"company_ident": "Temporibus doloribus voluptatem sed optio aut excepturi dolorum ut.",
"email": "faye.mills@hessel.com",
"root_folder_id": "ZgWWwg"
}
}
}
],
"string_values": [
{
"id": "ga07zZ",
"value": "Ipsam sit ut quaerat et qui officiis rem culpa.",
"property_id": "OR7nkD",
"property": {
"id": "jZN4WO",
"title": "Sequi eos consequatur error quaerat consequuntur numquam libero.",
"description": "Aperiam incidunt ut dolorem numquam.",
"name": "Voluptatem hic sit soluta tempore.",
"source": "system",
"data_type": "boolean",
"workspace_id": "JZnQDl",
"workspace": {
"_type": "workspace",
"id": "6MeRBY",
"name": "Dolores tempora sequi dolore.",
"company_ident": "Id sunt voluptas repudiandae doloribus eos.",
"email": "pbecker@gmail.com",
"root_folder_id": "NDkdZo"
}
}
}
],
"jurisdictions": [
{
"id": "aEWE2P",
"code": "Aspernatur nobis recusandae non odio."
}
],
"document_types": [
{
"_type": "document_type",
"id": "Z3l34a",
"name": "Distinctio ex error adipisci sunt."
}
],
"parties": [
{
"id": "wOywZL",
"first_name": "Voluptates quam harum alias.",
"last_name": "Commodi quas ut aut numquam voluptatem eaque.",
"email": "moen.jakayla@bergstrom.com",
"phone": "Et amet et voluptas ut sapiente voluptatem in.",
"title": "Deserunt rerum quia quam dolores recusandae ab esse.",
"company_name": "Error consequatur tempora tenetur reprehenderit aliquid dignissimos.",
"company_ident": "Reiciendis dignissimos magnam est et minus repellat velit.",
"address_id": "DQBq8Z",
"address": {
"id": "OqRy8D",
"address_type": "Et eos aliquam animi.",
"address_lines": "Modi odit est nobis vero velit.",
"city": "Dolor soluta sed in.",
"locality": "Deserunt consequatur amet dolor libero id aut.",
"administrative_area": "Sed eos aliquam qui possimus.",
"post_code": "Voluptatibus rem distinctio ipsa ut officiis recusandae.",
"country": "Est consequatur sit dicta necessitatibus qui suscipit."
},
"external_references": [
{
"id": "67kNMG",
"name": "Veniam recusandae quia rerum eius molestias non perspiciatis.",
"title": "Officia delectus dignissimos culpa libero quo.",
"value": "Omnis deleniti laudantium et."
}
]
}
],
"reminders": [
{
"id": "ZNePMq",
"event_type": "document.reminder",
"title": "Quasi eius totam sapiente velit harum."
}
],
"external_references": [
{
"id": "7Ayl06",
"name": "Repellat suscipit maxime aut aliquid.",
"title": "Sequi quis et iste dignissimos provident.",
"value": "Id consequatur aliquam eum quis ad inventore quod."
}
],
"tags": [
{
"tag": "Esse et architecto non quaerat."
}
],
"terms_and_conditions": {
"date": "1986-09-19T13:45:04+00:00",
"effective_date": "1996-05-14T09:48:35+00:00",
"term_end_date": "2018-01-24T02:14:42+00:00",
"signing_date": "1983-07-10T00:54:39+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "fixed"
},
"retention": {
"end_date": "1977-06-14T00:31:40+00:00"
},
"breadcrumb": [
{
"id": "wOywZL",
"name": "Corrupti asperiores iusto ipsum quis repellat ut in.",
"depth": 2121734
}
]
}
]
}
}
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/LDQ3aq/attachments/a0jQzD" \
--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/LDQ3aq/attachments/a0jQzD"
);
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/LDQ3aq/attachments/a0jQzD';
$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/LDQ3aq/attachments/a0jQzD'
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": "2025-08-09T14:01:12+00:00",
"updated_at": "1991-01-08T10:29:40+00:00",
"file_id": "DYmKjD",
"file": {
"_type": "file",
"id": "oazo7O",
"filename": "example.pdf",
"size": 22949,
"mime": "application/pdf",
"download_url": "http://hoppe.com/omnis-eos-ut-aut-quibusdam-qui",
"preview_url": "http://www.tromp.org/"
},
"documents": [
{
"download_url": "Et ea recusandae numquam reiciendis unde ullam quo cupiditate.",
"id": "JZnoKa",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Minima aspernatur voluptatibus.",
"description": "Sit minima dolores ut harum voluptatibus facere perferendis sequi.",
"archive_status": "completed",
"contains_pii": "contains_pii",
"contract_id": "O495AD",
"contract": {
"_type": "contract",
"id": "a2874D",
"name": "Aliquid et voluptatum voluptatem eum ab molestias adipisci error.",
"stage": "Cumque est perferendis beatae adipisci perspiciatis culpa.",
"document_id": "DQ4K3O",
"sign_method": "docusign",
"template_id": "Asperiores numquam iusto non occaecati cum harum enim alias.",
"template": {
"id": "eDJqgO",
"name": "Vel voluptates et itaque exercitationem.",
"description": "Distinctio reiciendis minima est velit.",
"type": "tailored",
"is_upload_template": true,
"is_custom_base_template": true
},
"user": {
"id": "Jrb2Pn",
"display_name": "Ratione eligendi odio dolorem alias nesciunt dolor vitae nihil.",
"first_name": "Labore dolores accusantium aperiam similique totam soluta esse id.",
"last_name": "Et illo quibusdam voluptate in et.",
"email": "salma.goodwin@rodriguez.com",
"language": "fi"
},
"signing_settings": {
"id": "NDkeda",
"created_at": "2003-08-07T17:25:55+00:00",
"updated_at": "1970-02-21T18:33:52+00:00",
"contract_id": "ZN7jJG",
"message": "Enim placeat quis nam voluptas assumenda.",
"expires_at": "2006-05-20T03:50:52+00:00",
"reminders_start": "1987-03-28T18:23:16+00:00",
"reminders_end": "1977-02-05T02:36:05+00:00",
"reminders_duration": "P3D"
}
},
"folder_id": "DYbpKR",
"folder": {
"_type": "folder",
"id": "verWR4d",
"name": "Nesciunt porro autem natus soluta.",
"created_at": "1974-08-13T02:19:15+00:00",
"updated_at": "1998-12-23T05:37:31+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "9GGo83r",
"name": "Sed qui ipsam fuga suscipit reiciendis nostrum.",
"created_at": "2013-06-10T12:09:07+00:00",
"updated_at": "1987-06-01T20:44:00+00:00",
"parent_id": "0ZABao"
}
},
"owner_id": "JL1511",
"owner": {
"id": "ZNLyjO",
"display_name": "Dignissimos nisi aliquam eius eius.",
"first_name": "Eum dolor sint facere quia tenetur.",
"last_name": "Iure ipsum recusandae qui qui.",
"email": "rubye.kulas@fadel.com",
"language": "en"
},
"workspace_id": "LDQ3aq",
"workspace": {
"_type": "workspace",
"id": "Ove7Ra",
"name": "Est incidunt fugit beatae et dolorem quia.",
"company_ident": "Eum amet consectetur consectetur doloremque fuga.",
"email": "bernadette83@lockman.com",
"root_folder_id": "BaEMaV"
},
"file_id": "zpJgyk",
"file": {
"_type": "file",
"id": "Z9KdKQ",
"filename": "Ipsum fugiat ipsa veniam dolorem inventore eaque neque.",
"size": 14504153.305,
"mime": "Eligendi magnam et assumenda itaque quaerat sit eos.",
"download_url": "http://www.hand.com/voluptas-quia-quis-nesciunt-molestias-est-in-voluptatum.html",
"preview_url": "http://kunze.info/"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "lQAqX8n",
"property_id": "nzJAL1P",
"property": {
"id": "NDkdZo",
"title": "Illo qui non natus deleniti laborum.",
"description": "Deleniti officiis alias perferendis illo veritatis.",
"name": "Laudantium laborum corporis a itaque accusantium autem quidem.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "WaB3AO",
"workspace": {
"_type": "workspace",
"id": "Oo4oqD",
"name": "Ab consequuntur explicabo ipsam repellat et quia distinctio minima.",
"company_ident": "Accusamus deleniti minus rem eos vero adipisci autem.",
"email": "andy70@wolf.com",
"root_folder_id": "MLeyjnq"
}
}
}
],
"date_values": [
{
"id": "KOq8Wa",
"value": "2000-09-03T00:18:47+00:00",
"duration": "P1D",
"basis": "Rerum corporis est dolorem aut.",
"property_id": "MEXMEq",
"property": {
"id": "DJbKL1",
"title": "Saepe nihil mollitia nostrum ab eaque aut.",
"description": "Ullam sed odio quis.",
"name": "Saepe eos officiis cumque dolorem.",
"source": "system",
"data_type": "date",
"workspace_id": "eDJ20D",
"workspace": {
"_type": "workspace",
"id": "Ool8EY",
"name": "Ea et et amet unde explicabo deleniti quis.",
"company_ident": "Qui et quia nesciunt facere.",
"email": "chelsey33@hotmail.com",
"root_folder_id": "jZN4WO"
}
}
}
],
"numeric_values": [
{
"id": "0ZABao",
"value": 1268.36,
"unit": "Saepe fugit ut quisquam aperiam.",
"property_id": "YoLxn2B",
"property": {
"id": "1DML7O",
"title": "Repellendus rerum qui quas ex expedita assumenda.",
"description": "Ut ea autem vel deleniti provident.",
"name": "Culpa adipisci aut corrupti.",
"source": "system",
"data_type": "numeric",
"workspace_id": "Z9GWQO",
"workspace": {
"_type": "workspace",
"id": "0ZABao",
"name": "Nostrum assumenda repudiandae facere ex asperiores eum.",
"company_ident": "Iste facere optio quidem quas ut at.",
"email": "jordan.senger@harber.info",
"root_folder_id": "RQK8Xp"
}
}
}
],
"string_values": [
{
"id": "2ZlqMa",
"value": "Doloremque dolores quidem minima adipisci.",
"property_id": "po71pR",
"property": {
"id": "ZN7NG5",
"title": "Dolores doloribus adipisci sint quidem quo quis necessitatibus modi.",
"description": "Voluptas velit quae sunt ratione ut nobis assumenda.",
"name": "Nobis fugiat illum quia voluptate.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "0ZAGkO",
"workspace": {
"_type": "workspace",
"id": "Z3NpbP",
"name": "Amet dicta doloremque et assumenda iste omnis assumenda.",
"company_ident": "Facere sit distinctio soluta eos iste vel.",
"email": "jett.heathcote@torphy.com",
"root_folder_id": "BZ3JDp"
}
}
}
],
"jurisdictions": [
{
"id": "DJxWXw",
"code": "Omnis hic consequatur minus aut natus quisquam."
}
],
"document_types": [
{
"_type": "document_type",
"id": "DJXnEa",
"name": "Quisquam quidem officia ut vitae corporis rerum."
}
],
"parties": [
{
"id": "ZV3x8a",
"first_name": "Molestiae quam ut dolore provident eligendi et omnis.",
"last_name": "Est consequatur et est sit.",
"email": "beahan.alanis@gmail.com",
"phone": "Ducimus velit enim autem.",
"title": "Qui delectus odio quia et.",
"company_name": "Architecto eum impedit ut.",
"company_ident": "Quisquam in eos qui libero in autem.",
"address_id": "J2gzLn",
"address": {
"id": "X7225L",
"address_type": "Doloremque ipsum omnis aut numquam sunt itaque corrupti.",
"address_lines": "Earum quia libero fuga aut adipisci.",
"city": "Aut quia ut officia occaecati harum neque autem.",
"locality": "Voluptate laborum ea eius quaerat.",
"administrative_area": "Sed qui officiis omnis deleniti ut blanditiis.",
"post_code": "Commodi id illum suscipit nesciunt eum.",
"country": "Iste nam facere in quasi officia."
},
"external_references": [
{
"id": "MAAqN8",
"name": "Voluptatem quia non quam natus reprehenderit nihil quae.",
"title": "Eius provident earum blanditiis.",
"value": "Occaecati harum aut possimus in."
}
]
}
],
"reminders": [
{
"id": "8WERJR",
"event_type": "document.reminder",
"title": "Maxime occaecati totam et ut commodi molestias."
}
],
"external_references": [
{
"id": "ebKwom5",
"name": "Ut rerum illum doloribus occaecati non dolor porro.",
"title": "At non aut animi ducimus.",
"value": "Nisi voluptas doloremque ratione perspiciatis recusandae illum quis reiciendis."
}
],
"tags": [
{
"tag": "Aliquam modi exercitationem laborum."
}
],
"terms_and_conditions": {
"date": "2008-09-20T20:07:19+00:00",
"effective_date": "1991-11-27T02:01:16+00:00",
"term_end_date": "2024-09-24T13:16:28+00:00",
"signing_date": "2017-07-03T08:20:40+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
},
"retention": {
"end_date": "1983-08-31T12:41:29+00:00"
},
"breadcrumb": [
{
"id": "jnRR26",
"name": "Tempora eum aspernatur labore explicabo.",
"depth": 23089041
}
]
}
]
}
}
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/WaBkyO/attachments/D50wqO" \
--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/WaBkyO/attachments/D50wqO"
);
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/WaBkyO/attachments/D50wqO';
$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/WaBkyO/attachments/D50wqO'
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\": \"Mollitia minima id occaecati alias mollitia enim repellendus.\",
\"title\": \"Aliquid voluptatem est maiores sapiente harum ut.\",
\"description\": \"Aut quam illo eos ut magni fugiat aut porro.\",
\"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": "Mollitia minima id occaecati alias mollitia enim repellendus.",
"title": "Aliquid voluptatem est maiores sapiente harum ut.",
"description": "Aut quam illo eos ut magni fugiat aut porro.",
"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' => 'Mollitia minima id occaecati alias mollitia enim repellendus.',
'title' => 'Aliquid voluptatem est maiores sapiente harum ut.',
'description' => 'Aut quam illo eos ut magni fugiat aut porro.',
'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": "Mollitia minima id occaecati alias mollitia enim repellendus.",
"title": "Aliquid voluptatem est maiores sapiente harum ut.",
"description": "Aut quam illo eos ut magni fugiat aut porro.",
"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": "EGEb8e7",
"title": "Dolor nobis sit aliquid quia nihil aut facere.",
"description": "Non nemo nostrum eos nostrum neque iure rerum.",
"name": "Delectus aut maiores reprehenderit magni.",
"source": "system",
"data_type": "string",
"workspace_id": "DJqrKR",
"workspace": {
"_type": "workspace",
"id": "Oq4k6a",
"name": "Quasi cumque fuga sint provident sunt voluptatem distinctio unde.",
"company_ident": "Rerum magni repellat reprehenderit.",
"email": "hayden.haley@hotmail.com",
"root_folder_id": "mOojXa"
}
}
}
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/k6P1py4" \
--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/k6P1py4"
);
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/k6P1py4';
$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/k6P1py4'
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": "eDJKRZ",
"title": "Impedit debitis et et eligendi.",
"description": "Enim at temporibus dolorem illum accusantium.",
"name": "Sed quas quia eum et eligendi quis officiis.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "KOq8Wa",
"workspace": {
"_type": "workspace",
"id": "D5Q93M",
"name": "Quas et in nihil perspiciatis eius aut aut.",
"company_ident": "Animi sed qui voluptatem expedita illum.",
"email": "rhianna17@gmail.com",
"root_folder_id": "Z9G3qO"
}
}
}
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/GDmB8Z" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"Repudiandae sunt repellendus quo accusamus nihil.\",
\"description\": \"Laboriosam qui et ut.\"
}"
const url = new URL(
"https://api.docue.com/public/v2/metadata/properties/GDmB8Z"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "Repudiandae sunt repellendus quo accusamus nihil.",
"description": "Laboriosam qui et ut."
};
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/GDmB8Z';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'title' => 'Repudiandae sunt repellendus quo accusamus nihil.',
'description' => 'Laboriosam qui et ut.',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/metadata/properties/GDmB8Z'
payload = {
"title": "Repudiandae sunt repellendus quo accusamus nihil.",
"description": "Laboriosam qui et ut."
}
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": "Zr9G7D",
"title": "Fuga quisquam ea placeat officia ut.",
"description": "Voluptas in delectus laborum sit sit.",
"name": "Quia aut dolores veniam cumque.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "NObxZW",
"workspace": {
"_type": "workspace",
"id": "1WX6Ke",
"name": "Laudantium autem culpa dolorem distinctio reiciendis.",
"company_ident": "Illum similique quibusdam deleniti ex nisi.",
"email": "koepp.krystal@jerde.com",
"root_folder_id": "Oyy7bO"
}
}
}
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/Oo5Mr8" \
--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/Oo5Mr8"
);
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/Oo5Mr8';
$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/Oo5Mr8'
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/aEQ1Wa/properties/0ZArBa/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/aEQ1Wa/properties/0ZArBa/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/aEQ1Wa/properties/0ZArBa/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/aEQ1Wa/properties/0ZArBa/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": "zp0oxmY",
"value": "Veniam fugit qui minima optio.",
"property_id": "2ZlA8a",
"property": {
"id": "V3v0Wpw",
"title": "Beatae neque eligendi quos minima praesentium.",
"description": "Repellat et omnis quis necessitatibus culpa facilis.",
"name": "Quam magnam soluta qui qui.",
"source": "system",
"data_type": "numeric",
"workspace_id": "1DM7aR",
"workspace": {
"_type": "workspace",
"id": "wqbJQG3",
"name": "Occaecati nam id maxime quasi officiis accusantium aut nostrum.",
"company_ident": "Doloremque sed est quasi autem sequi possimus saepe.",
"email": "wyman.kameron@dooley.biz",
"root_folder_id": "1gYd4Mv"
}
}
}
]
}
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/96Rqor/properties/DmBQWZ/values" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": \"1979-09-19T08:51:54+00:00\",
\"duration\": \"P1Y\",
\"basis\": \"Contract terms\",
\"unit\": \"EUR\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/96Rqor/properties/DmBQWZ/values"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"value": "1979-09-19T08:51:54+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/96Rqor/properties/DmBQWZ/values';
$response = $client->post(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'value' => '1979-09-19T08:51:54+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/96Rqor/properties/DmBQWZ/values'
payload = {
"value": "1979-09-19T08:51:54+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": "aEqpya",
"value": "Esse placeat asperiores autem debitis quia ex dignissimos.",
"property_id": "e8pGPA8",
"property": {
"id": "b636Yqn",
"title": "Totam odio harum odio consequatur possimus sed aut.",
"description": "Aliquam quibusdam qui a molestiae laboriosam.",
"name": "Fugit qui debitis est eos nulla beatae.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "pM8AQx",
"workspace": {
"_type": "workspace",
"id": "eDJ0a1",
"name": "Cumque dolores minima quam dolore et quod.",
"company_ident": "Quaerat sit aut quaerat ut dolores expedita.",
"email": "bhirthe@gmail.com",
"root_folder_id": "7kkk1n"
}
}
}
}
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/ZG0x6R/properties/AoYnk6/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/ZG0x6R/properties/AoYnk6/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/ZG0x6R/properties/AoYnk6/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/ZG0x6R/properties/AoYnk6/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": "Z3144b",
"value": "Eum culpa sit voluptates quaerat autem inventore vitae consequatur.",
"property_id": "pZG0Ra",
"property": {
"id": "OblkpZ",
"title": "Repellat enim tenetur qui.",
"description": "Atque voluptatibus at quia.",
"name": "Rem sit natus molestiae asperiores accusamus.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "0ZABao",
"workspace": {
"_type": "workspace",
"id": "JZnq6D",
"name": "Qui voluptatem voluptatem nihil sunt.",
"company_ident": "Voluptas adipisci laboriosam enim perspiciatis tempora.",
"email": "green.viva@yost.biz",
"root_folder_id": "D6k0JY"
}
}
}
}
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/O7WB1B/properties/ZApX1k/values/1" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"value\": \"1981-07-13T04:52:33+00:00\",
\"duration\": \"P1Y\",
\"basis\": \"Contract terms\",
\"unit\": \"EUR\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/O7WB1B/properties/ZApX1k/values/1"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"value": "1981-07-13T04:52:33+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/O7WB1B/properties/ZApX1k/values/1';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'value' => '1981-07-13T04:52:33+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/O7WB1B/properties/ZApX1k/values/1'
payload = {
"value": "1981-07-13T04:52:33+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": "LZKzwD",
"value": "Excepturi totam porro animi consequatur dolorem.",
"property_id": "Ow0w4m",
"property": {
"id": "LZKYOo",
"title": "Modi omnis qui maxime animi quod.",
"description": "Aliquid in facere commodi aspernatur est ipsa dolores.",
"name": "Dolores consequatur facilis enim itaque iure aut voluptatem.",
"source": "user_defined",
"data_type": "boolean",
"workspace_id": "R75K3B3",
"workspace": {
"_type": "workspace",
"id": "VwpNQA",
"name": "Dolorem quos harum voluptas ipsa eum.",
"company_ident": "Et et quod iure voluptate.",
"email": "heller.clarabelle@gmail.com",
"root_folder_id": "6A1n5AB"
}
}
}
}
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/oyn0M2/properties/eDJbwD/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/oyn0M2/properties/eDJbwD/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/oyn0M2/properties/eDJbwD/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/oyn0M2/properties/eDJbwD/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/mOoMZx/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/mOoMZx/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/mOoMZx/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/mOoMZx/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/27WEJ0/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/27WEJ0/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/27WEJ0/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/27WEJ0/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/4NR2m5/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/4NR2m5/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/4NR2m5/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/4NR2m5/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": "aL7eKG",
"first_name": "Aut deleniti inventore quo iste temporibus.",
"last_name": "Nulla commodi debitis voluptas voluptate architecto voluptatem et.",
"email": "hiram67@feest.com",
"phone": "Et qui voluptatibus fugit porro ea.",
"title": "Quasi occaecati sapiente magnam sit.",
"company_name": "Excepturi magni excepturi mollitia earum quia consequuntur.",
"company_ident": "Et dolor ipsam exercitationem aut iusto repellat.",
"address_id": "Zp2xdO",
"address": {
"id": "jJpB3B",
"address_type": "Hic rem adipisci non odit ea rem et.",
"address_lines": "Adipisci iure harum natus quo est incidunt iusto distinctio.",
"city": "Suscipit earum dolores nihil est omnis.",
"locality": "Rerum consectetur sit qui explicabo impedit et qui accusamus.",
"administrative_area": "Corporis facilis officia at quos officia minima non.",
"post_code": "Minus aliquam ex voluptatem qui.",
"country": "Placeat quam omnis sapiente corporis minima."
},
"external_references": [
{
"id": "omzNMX",
"name": "Pariatur et a facilis laboriosam sunt eos.",
"title": "Voluptatem alias dicta consectetur illo quisquam est aliquam.",
"value": "Explicabo hic quia reiciendis quos quas qui omnis."
}
]
}
]
}
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/DMAvqD/parties" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": \"Jane\",
\"last_name\": \"Doe\",
\"email\": \"oconner.edgardo@yahoo.com\",
\"phone\": \"+358401231231\",
\"title\": \"President\",
\"company_name\": \"Ut fugiat molestiae consequatur harum voluptatum blanditiis.\",
\"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\": \"Et harum molestiae ut eos.\",
\"title\": \"Autem quo quo numquam quia rerum aperiam qui.\",
\"value\": \"Eos hic ducimus dolore sed sint quo ad.\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/DMAvqD/parties"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"first_name": "Jane",
"last_name": "Doe",
"email": "oconner.edgardo@yahoo.com",
"phone": "+358401231231",
"title": "President",
"company_name": "Ut fugiat molestiae consequatur harum voluptatum blanditiis.",
"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": "Et harum molestiae ut eos.",
"title": "Autem quo quo numquam quia rerum aperiam qui.",
"value": "Eos hic ducimus dolore sed sint quo ad."
}
]
};
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/DMAvqD/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' => 'oconner.edgardo@yahoo.com',
'phone' => '+358401231231',
'title' => 'President',
'company_name' => 'Ut fugiat molestiae consequatur harum voluptatum blanditiis.',
'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' => 'Et harum molestiae ut eos.',
'title' => 'Autem quo quo numquam quia rerum aperiam qui.',
'value' => 'Eos hic ducimus dolore sed sint quo ad.',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/DMAvqD/parties'
payload = {
"first_name": "Jane",
"last_name": "Doe",
"email": "oconner.edgardo@yahoo.com",
"phone": "+358401231231",
"title": "President",
"company_name": "Ut fugiat molestiae consequatur harum voluptatum blanditiis.",
"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": "Et harum molestiae ut eos.",
"title": "Autem quo quo numquam quia rerum aperiam qui.",
"value": "Eos hic ducimus dolore sed sint quo ad."
}
]
}
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": "aP091a",
"first_name": "Ratione aut expedita ut et.",
"last_name": "Fugit architecto rerum et quos neque.",
"email": "peter60@orn.com",
"phone": "Deserunt ut pariatur unde animi.",
"title": "Temporibus delectus consequuntur odit repellendus vero accusamus omnis.",
"company_name": "Commodi esse reprehenderit vel accusantium saepe.",
"company_ident": "Asperiores ex voluptatem et sapiente possimus sunt dolorum qui.",
"address_id": "NDkdZo",
"address": {
"id": "ZA3p2O",
"address_type": "Et ex quia aut odio et ullam quasi qui.",
"address_lines": "Sapiente quibusdam non ut velit rerum esse.",
"city": "Soluta saepe facilis voluptatem fugit officiis rerum.",
"locality": "Reiciendis voluptatem culpa eos aliquam ut facilis et.",
"administrative_area": "Necessitatibus sequi ipsam nihil tenetur rerum est et.",
"post_code": "Ut aut modi rerum unde suscipit quis.",
"country": "Maiores minus voluptates dolorum minima vitae suscipit dolorem."
},
"external_references": [
{
"id": "YZ9Nva",
"name": "Sunt placeat ea quo alias sed.",
"title": "Incidunt tempora non reiciendis in cupiditate rerum.",
"value": "Veritatis odit alias quo repellat."
}
]
}
}
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/BaEGMD/parties/ZN1813" \
--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/BaEGMD/parties/ZN1813"
);
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/BaEGMD/parties/ZN1813';
$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/BaEGMD/parties/ZN1813'
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": "R7yllP",
"first_name": "Non quia qui suscipit facilis et adipisci.",
"last_name": "Non nisi nisi mollitia id assumenda.",
"email": "jaskolski.arvilla@jones.com",
"phone": "Veniam et consequuntur dolorem ipsam illo ullam vel.",
"title": "Quia perspiciatis impedit quia vitae qui tempore occaecati.",
"company_name": "Placeat sit voluptas autem tempora est.",
"company_ident": "Quaerat consectetur sed suscipit deserunt nihil.",
"address_id": "OqR76K",
"address": {
"id": "m4JKQm",
"address_type": "Unde itaque omnis molestiae nemo error.",
"address_lines": "Ipsum et sed autem qui.",
"city": "Consequatur excepturi quia et quia quae voluptatem.",
"locality": "Sed ut soluta et totam numquam perspiciatis.",
"administrative_area": "Dicta et animi numquam ea deleniti minus.",
"post_code": "Distinctio aut ut rerum cum.",
"country": "Iusto laboriosam aut molestiae porro."
},
"external_references": [
{
"id": "aBw2MO",
"name": "Libero nisi illo repellat sapiente et excepturi.",
"title": "Ea consequatur incidunt qui rerum.",
"value": "Reprehenderit sit laborum eum ducimus eos repudiandae repellendus repellat."
}
]
}
}
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/aEqqKb/parties/Ovl3ov" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"first_name\": \"Veritatis similique velit distinctio doloremque itaque.\",
\"last_name\": \"Tenetur est repellendus consequuntur nihil blanditiis.\",
\"email\": \"schimmel.maddison@gmail.com\",
\"phone\": \"+358401231231\",
\"title\": \"Molestiae magnam maxime aut nulla corporis sit.\",
\"company_name\": \"In repellendus maiores dicta nisi quo ex.\",
\"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\": \"Odit quaerat cum nihil qui.\",
\"title\": \"Maiores ad doloribus voluptatum aut culpa.\",
\"value\": \"Cupiditate voluptatibus est provident vero sapiente a ea.\"
}
]
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/aEqqKb/parties/Ovl3ov"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"first_name": "Veritatis similique velit distinctio doloremque itaque.",
"last_name": "Tenetur est repellendus consequuntur nihil blanditiis.",
"email": "schimmel.maddison@gmail.com",
"phone": "+358401231231",
"title": "Molestiae magnam maxime aut nulla corporis sit.",
"company_name": "In repellendus maiores dicta nisi quo ex.",
"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": "Odit quaerat cum nihil qui.",
"title": "Maiores ad doloribus voluptatum aut culpa.",
"value": "Cupiditate voluptatibus est provident vero sapiente a ea."
}
]
};
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/aEqqKb/parties/Ovl3ov';
$response = $client->put(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'first_name' => 'Veritatis similique velit distinctio doloremque itaque.',
'last_name' => 'Tenetur est repellendus consequuntur nihil blanditiis.',
'email' => 'schimmel.maddison@gmail.com',
'phone' => '+358401231231',
'title' => 'Molestiae magnam maxime aut nulla corporis sit.',
'company_name' => 'In repellendus maiores dicta nisi quo ex.',
'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' => 'Odit quaerat cum nihil qui.',
'title' => 'Maiores ad doloribus voluptatum aut culpa.',
'value' => 'Cupiditate voluptatibus est provident vero sapiente a ea.',
],
],
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/aEqqKb/parties/Ovl3ov'
payload = {
"first_name": "Veritatis similique velit distinctio doloremque itaque.",
"last_name": "Tenetur est repellendus consequuntur nihil blanditiis.",
"email": "schimmel.maddison@gmail.com",
"phone": "+358401231231",
"title": "Molestiae magnam maxime aut nulla corporis sit.",
"company_name": "In repellendus maiores dicta nisi quo ex.",
"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": "Odit quaerat cum nihil qui.",
"title": "Maiores ad doloribus voluptatum aut culpa.",
"value": "Cupiditate voluptatibus est provident vero sapiente a ea."
}
]
}
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": "7Awrv4",
"first_name": "Aut ea blanditiis consectetur qui non optio aut.",
"last_name": "Suscipit blanditiis cupiditate dolores neque.",
"email": "shanna07@gmail.com",
"phone": "Repellendus eaque sit quod magnam.",
"title": "Porro culpa similique est est placeat nulla quam.",
"company_name": "Ullam aut eveniet quidem consequatur aut quisquam perferendis.",
"company_ident": "Esse ex ipsa libero laborum.",
"address_id": "MWK9x8",
"address": {
"id": "aL7EvQ",
"address_type": "Dolorem illum natus delectus debitis dolor molestiae.",
"address_lines": "Dignissimos sit sint unde est odit.",
"city": "Quia id omnis impedit molestiae et labore quia.",
"locality": "Quo earum nisi eos omnis maxime facilis neque rem.",
"administrative_area": "Voluptates laboriosam magni consequuntur suscipit non.",
"post_code": "Voluptate reprehenderit rerum nobis ut molestias atque.",
"country": "Esse rerum quia in nihil."
},
"external_references": [
{
"id": "PGo5AQq",
"name": "Sit dolorem est non earum autem dolor quia.",
"title": "Omnis recusandae quo et et cum ut atque.",
"value": "Ipsa omnis non error deserunt reprehenderit."
}
]
}
}
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/O73nqO/parties/7ajwBO" \
--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/O73nqO/parties/7ajwBO"
);
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/O73nqO/parties/7ajwBO';
$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/O73nqO/parties/7ajwBO'
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/wOyBpD/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/wOyBpD/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/wOyBpD/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/wOyBpD/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": "1993-03-12T10:09:10+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/NObxZW/retention" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"end_date\": \"2016-03-25T08:17:14+00:00\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/NObxZW/retention"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"end_date": "2016-03-25T08:17:14+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/NObxZW/retention';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'end_date' => '2016-03-25T08:17:14+00:00',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/NObxZW/retention'
payload = {
"end_date": "2016-03-25T08:17:14+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": "1987-03-18T11:43:28+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/v9XPGjd/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/v9XPGjd/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/v9XPGjd/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/v9XPGjd/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/Z3xxmb/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/Z3xxmb/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/Z3xxmb/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/Z3xxmb/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": "2002-12-29T11:43:42+00:00",
"effective_date": "2021-05-13T17:47:28+00:00",
"term_end_date": "2010-09-02T23:21:44+00:00",
"signing_date": "1982-11-17T09:35:31+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
}
}
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/mpBwml/terms-and-conditions" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"date\": \"1975-01-03T10:11:44+00:00\",
\"effective_date\": \"2023-12-18T20:28:21+00:00\",
\"term_end_date\": \"1972-09-24T22:40:29+00:00\",
\"signing_date\": \"1998-11-01T01:45:38+00:00\",
\"contract_period\": \"P1D\",
\"notice_period\": \"P1D\",
\"duration_type\": \"optional\"
}"
const url = new URL(
"https://api.docue.com/public/v2/documents/mpBwml/terms-and-conditions"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"date": "1975-01-03T10:11:44+00:00",
"effective_date": "2023-12-18T20:28:21+00:00",
"term_end_date": "1972-09-24T22:40:29+00:00",
"signing_date": "1998-11-01T01:45:38+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
};
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/mpBwml/terms-and-conditions';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'date' => '1975-01-03T10:11:44+00:00',
'effective_date' => '2023-12-18T20:28:21+00:00',
'term_end_date' => '1972-09-24T22:40:29+00:00',
'signing_date' => '1998-11-01T01:45:38+00:00',
'contract_period' => 'P1D',
'notice_period' => 'P1D',
'duration_type' => 'optional',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/documents/mpBwml/terms-and-conditions'
payload = {
"date": "1975-01-03T10:11:44+00:00",
"effective_date": "2023-12-18T20:28:21+00:00",
"term_end_date": "1972-09-24T22:40:29+00:00",
"signing_date": "1998-11-01T01:45:38+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "optional"
}
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": "1976-02-29T10:11:56+00:00",
"effective_date": "2019-01-23T05:53:38+00:00",
"term_end_date": "1990-08-12T06:57:49+00:00",
"signing_date": "1990-07-30T16:45:36+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "one-off"
}
}
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/Z1gbPO/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/Z1gbPO/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/Z1gbPO/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/Z1gbPO/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": "ae8J7E",
"name": "Quia nihil qui id qui.",
"created_at": "2005-03-13T03:35:15+00:00",
"updated_at": "1974-10-06T07:44:19+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "1DML7O",
"name": "Qui dolore dolorum saepe numquam maxime corporis.",
"created_at": "1988-07-02T05:27:58+00:00",
"updated_at": "2021-02-25T15:09:08+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/aBmGQZ" \
--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/aBmGQZ"
);
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/aBmGQZ';
$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/aBmGQZ'
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": "laeK7D",
"name": "Natus suscipit ex quam non nam aperiam quaerat.",
"created_at": "1982-08-11T18:08:13+00:00",
"updated_at": "1985-01-30T15:24:21+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "Z3eewK",
"name": "Natus rerum deserunt earum voluptatum provident debitis dolore voluptatibus.",
"created_at": "1973-11-06T10:42:28+00:00",
"updated_at": "1970-10-20T12:21:40+00:00",
"parent_id": "0ZABao"
}
}
}
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\": \"Qui qui fugit maiores tempore amet sed.\",
\"parent_id\": \"Ow6b8a\"
}"
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": "Qui qui fugit maiores tempore amet sed.",
"parent_id": "Ow6b8a"
};
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' => 'Qui qui fugit maiores tempore amet sed.',
'parent_id' => 'Ow6b8a',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/folders'
payload = {
"name": "Qui qui fugit maiores tempore amet sed.",
"parent_id": "Ow6b8a"
}
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": "LDQ3aq",
"name": "Rerum sed aut quod natus.",
"created_at": "1993-08-24T21:13:46+00:00",
"updated_at": "2012-03-04T21:23:39+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "Zrg7Aa",
"name": "Voluptates voluptas quisquam sed est reiciendis porro.",
"created_at": "1985-06-03T06:02:14+00:00",
"updated_at": "1989-10-19T20:25:38+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/aebVGO" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Animi quasi sint voluptas.\",
\"parent_id\": \"oeJKp8\"
}"
const url = new URL(
"https://api.docue.com/public/v2/folders/aebVGO"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Animi quasi sint voluptas.",
"parent_id": "oeJKp8"
};
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/aebVGO';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Animi quasi sint voluptas.',
'parent_id' => 'oeJKp8',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));import requests
import json
url = 'https://api.docue.com/public/v2/folders/aebVGO'
payload = {
"name": "Animi quasi sint voluptas.",
"parent_id": "oeJKp8"
}
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": "OwL84D",
"name": "Nihil magni ut sed perferendis consequatur iste quos dolorum.",
"created_at": "1990-05-03T13:08:03+00:00",
"updated_at": "2017-06-08T22:49:51+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "0ZABao",
"name": "Recusandae quis iure laborum aliquam et beatae facere.",
"created_at": "2020-04-07T19:37:56+00:00",
"updated_at": "1999-08-12T13:29:31+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/0ZABao" \
--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/0ZABao"
);
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/0ZABao';
$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/0ZABao'
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=Magnam veritatis ea sequi necessitatibus odit itaque corporis."\
--form "language=de"\
--form "folder_id=LxvbWR"\
--form "signature_method=manual"\
--form "parties[][first_name]=Aliquam repellendus aut velit rerum praesentium culpa."\
--form "parties[][last_name]=Sint ea saepe eaque in."\
--form "parties[][company_title]=Hic praesentium quia rerum magnam qui sunt tempora."\
--form "parties[][company_ident]=Eos quia sed recusandae officiis minima vitae."\
--form "parties[][title]=Sapiente corrupti commodi facilis ducimus velit dolor architecto quia."\
--form "parties[][email]=heaney.buddy@yahoo.com"\
--form "parties[][phone]=Saepe quia rerum laboriosam voluptatem molestias architecto."\
--form "parties[][message]=Omnis et rerum sint iste assumenda."\
--form "parties[][language]=de"\
--form "parties[][country]=SE"\
--form "parties[][order]=8580511"\
--form "parties[][include_completed_in_email]=1"\
--form "signing_settings[expires_at]=1984-04-12T22:19:00+00:00"\
--form "signing_settings[sender_name]=John Doe"\
--form "signing_settings[message]=Animi impedit ut molestiae error repellat itaque eaque."\
--form "signing_settings[reminders_start]=1975-02-13T16:30:12+00:00"\
--form "signing_settings[reminders_end]=1993-10-18T13:30:35+00:00"\
--form "signing_settings[reminders_duration]=P3D"\
--form "send_invitations="\
--form "file=@/tmp/phpGMCOmG" 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', 'Magnam veritatis ea sequi necessitatibus odit itaque corporis.');
body.append('language', 'de');
body.append('folder_id', 'LxvbWR');
body.append('signature_method', 'manual');
body.append('parties[][first_name]', 'Aliquam repellendus aut velit rerum praesentium culpa.');
body.append('parties[][last_name]', 'Sint ea saepe eaque in.');
body.append('parties[][company_title]', 'Hic praesentium quia rerum magnam qui sunt tempora.');
body.append('parties[][company_ident]', 'Eos quia sed recusandae officiis minima vitae.');
body.append('parties[][title]', 'Sapiente corrupti commodi facilis ducimus velit dolor architecto quia.');
body.append('parties[][email]', 'heaney.buddy@yahoo.com');
body.append('parties[][phone]', 'Saepe quia rerum laboriosam voluptatem molestias architecto.');
body.append('parties[][message]', 'Omnis et rerum sint iste assumenda.');
body.append('parties[][language]', 'de');
body.append('parties[][country]', 'SE');
body.append('parties[][order]', '8580511');
body.append('parties[][include_completed_in_email]', '1');
body.append('signing_settings[expires_at]', '1984-04-12T22:19:00+00:00');
body.append('signing_settings[sender_name]', 'John Doe');
body.append('signing_settings[message]', 'Animi impedit ut molestiae error repellat itaque eaque.');
body.append('signing_settings[reminders_start]', '1975-02-13T16:30:12+00:00');
body.append('signing_settings[reminders_end]', '1993-10-18T13:30:35+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' => 'Magnam veritatis ea sequi necessitatibus odit itaque corporis.'
],
[
'name' => 'language',
'contents' => 'de'
],
[
'name' => 'folder_id',
'contents' => 'LxvbWR'
],
[
'name' => 'signature_method',
'contents' => 'manual'
],
[
'name' => 'parties[][first_name]',
'contents' => 'Aliquam repellendus aut velit rerum praesentium culpa.'
],
[
'name' => 'parties[][last_name]',
'contents' => 'Sint ea saepe eaque in.'
],
[
'name' => 'parties[][company_title]',
'contents' => 'Hic praesentium quia rerum magnam qui sunt tempora.'
],
[
'name' => 'parties[][company_ident]',
'contents' => 'Eos quia sed recusandae officiis minima vitae.'
],
[
'name' => 'parties[][title]',
'contents' => 'Sapiente corrupti commodi facilis ducimus velit dolor architecto quia.'
],
[
'name' => 'parties[][email]',
'contents' => 'heaney.buddy@yahoo.com'
],
[
'name' => 'parties[][phone]',
'contents' => 'Saepe quia rerum laboriosam voluptatem molestias architecto.'
],
[
'name' => 'parties[][message]',
'contents' => 'Omnis et rerum sint iste assumenda.'
],
[
'name' => 'parties[][language]',
'contents' => 'de'
],
[
'name' => 'parties[][country]',
'contents' => 'SE'
],
[
'name' => 'parties[][order]',
'contents' => '8580511'
],
[
'name' => 'parties[][include_completed_in_email]',
'contents' => '1'
],
[
'name' => 'signing_settings[expires_at]',
'contents' => '1984-04-12T22:19:00+00:00'
],
[
'name' => 'signing_settings[sender_name]',
'contents' => 'John Doe'
],
[
'name' => 'signing_settings[message]',
'contents' => 'Animi impedit ut molestiae error repellat itaque eaque.'
],
[
'name' => 'signing_settings[reminders_start]',
'contents' => '1975-02-13T16:30:12+00:00'
],
[
'name' => 'signing_settings[reminders_end]',
'contents' => '1993-10-18T13:30:35+00:00'
],
[
'name' => 'signing_settings[reminders_duration]',
'contents' => 'P3D'
],
[
'name' => 'send_invitations',
'contents' => ''
],
[
'name' => 'file',
'contents' => fopen('/tmp/phpGMCOmG', '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, 'Magnam veritatis ea sequi necessitatibus odit itaque corporis.'),
'language': (None, 'de'),
'folder_id': (None, 'LxvbWR'),
'signature_method': (None, 'manual'),
'parties[][first_name]': (None, 'Aliquam repellendus aut velit rerum praesentium culpa.'),
'parties[][last_name]': (None, 'Sint ea saepe eaque in.'),
'parties[][company_title]': (None, 'Hic praesentium quia rerum magnam qui sunt tempora.'),
'parties[][company_ident]': (None, 'Eos quia sed recusandae officiis minima vitae.'),
'parties[][title]': (None, 'Sapiente corrupti commodi facilis ducimus velit dolor architecto quia.'),
'parties[][email]': (None, 'heaney.buddy@yahoo.com'),
'parties[][phone]': (None, 'Saepe quia rerum laboriosam voluptatem molestias architecto.'),
'parties[][message]': (None, 'Omnis et rerum sint iste assumenda.'),
'parties[][language]': (None, 'de'),
'parties[][country]': (None, 'SE'),
'parties[][order]': (None, '8580511'),
'parties[][include_completed_in_email]': (None, '1'),
'signing_settings[expires_at]': (None, '1984-04-12T22:19:00+00:00'),
'signing_settings[sender_name]': (None, 'John Doe'),
'signing_settings[message]': (None, 'Animi impedit ut molestiae error repellat itaque eaque.'),
'signing_settings[reminders_start]': (None, '1975-02-13T16:30:12+00:00'),
'signing_settings[reminders_end]': (None, '1993-10-18T13:30:35+00:00'),
'signing_settings[reminders_duration]': (None, 'P3D'),
'send_invitations': (None, ''),
'file': open('/tmp/phpGMCOmG', 'rb')}
payload = {
"title": "Magnam veritatis ea sequi necessitatibus odit itaque corporis.",
"language": "de",
"folder_id": "LxvbWR",
"signature_method": "manual",
"attachments": [
[]
],
"parties": [
{
"first_name": "Aliquam repellendus aut velit rerum praesentium culpa.",
"last_name": "Sint ea saepe eaque in.",
"company_title": "Hic praesentium quia rerum magnam qui sunt tempora.",
"company_ident": "Eos quia sed recusandae officiis minima vitae.",
"title": "Sapiente corrupti commodi facilis ducimus velit dolor architecto quia.",
"email": "heaney.buddy@yahoo.com",
"phone": "Saepe quia rerum laboriosam voluptatem molestias architecto.",
"message": "Omnis et rerum sint iste assumenda.",
"language": "de",
"country": "SE",
"order": 8580511,
"include_completed_in_email": true
}
],
"signing_settings": {
"expires_at": "1984-04-12T22:19:00+00:00",
"sender_name": "John Doe",
"message": "Animi impedit ut molestiae error repellat itaque eaque.",
"reminders_start": "1975-02-13T16:30:12+00:00",
"reminders_end": "1993-10-18T13:30:35+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": "GZgAO9",
"name": "Vel molestiae cum nostrum qui.",
"stage": "Tenetur doloribus quisquam voluptatem ea sed.",
"document_id": "gD6jDw",
"sign_method": "manual",
"document": {
"download_url": "Inventore quia architecto officiis nisi.",
"id": "a2ngNa",
"created_at": "2026-01-30T09:08:29.000000Z",
"updated_at": "2026-01-30T09:08:29.000000Z",
"title": "Aut blanditiis sed.",
"description": "Tenetur enim magnam error nisi qui.",
"archive_status": "completed",
"contains_pii": "no_pii",
"contract_id": "ObYz84",
"folder_id": "DMMplj",
"folder": {
"_type": "folder",
"id": "YZ9GWO",
"name": "Nobis dolore repellendus quia quo cupiditate.",
"created_at": "2024-05-12T22:47:22+00:00",
"updated_at": "1981-06-11T00:02:19+00:00",
"parent_id": "0ZABao",
"parent": {
"_type": "folder",
"id": "rxwMr6",
"name": "Et non sunt et velit exercitationem optio.",
"created_at": "1997-12-03T17:45:53+00:00",
"updated_at": "1971-05-26T09:06:40+00:00",
"parent_id": "0ZABao"
},
"has_children": true
},
"owner_id": "Z9YB1Z",
"owner": {
"id": "7ajyyZ",
"display_name": "Possimus aperiam ut fuga.",
"first_name": "Sint nobis voluptatum velit aut quasi maxime excepturi.",
"last_name": "Rerum est illum quia enim odio.",
"email": "okon.shaniya@carroll.biz",
"language": "pl"
},
"workspace_id": "nqj3rK",
"workspace": {
"_type": "workspace",
"id": "Zl2P4O",
"name": "Rerum quo repellat dolores non similique nisi commodi aut.",
"company_ident": "Molestiae consequuntur minus voluptas natus velit consequuntur consequatur.",
"email": "tamara05@yahoo.com",
"root_folder_id": "NObxZW"
},
"file_id": "ZNeYWD",
"file": {
"_type": "file",
"id": "OxQBjD",
"filename": "Quam et eos nostrum voluptatem ipsum est et saepe.",
"size": 538.30037435,
"mime": "Voluptatem nisi dolorem blanditiis nisi maxime eum.",
"download_url": "http://yundt.com/quidem-maxime-vel-et-quis-sint-dignissimos-accusamus.html",
"preview_url": "http://www.schneider.biz/aliquid-voluptates-pariatur-esse-quia-sequi-voluptas.html"
},
"languages": [
{
"code": "EN"
}
],
"boolean_values": [
{
"id": "DJ6NWA",
"property_id": "ZAkQYx",
"property": {
"id": "Z1g63O",
"title": "Sunt porro ut et laborum.",
"description": "Exercitationem non necessitatibus pariatur nemo dignissimos molestias voluptas.",
"name": "Nam exercitationem sunt consectetur eos explicabo doloribus.",
"source": "system",
"data_type": "boolean",
"workspace_id": "1APPdo",
"workspace": {
"_type": "workspace",
"id": "DdzKea",
"name": "Sit ipsum labore error quo.",
"company_ident": "Repellat omnis non iste hic.",
"email": "xrogahn@herzog.com",
"root_folder_id": "Zll90Z"
}
}
}
],
"date_values": [
{
"id": "Oq5LNA",
"value": "1976-06-25T04:21:29+00:00",
"duration": "P1D",
"basis": "Quia ipsum et ut ut omnis accusantium.",
"property_id": "ZG0bx0",
"property": {
"id": "ZVPlkO",
"title": "Et voluptas eos explicabo earum quia corporis.",
"description": "Quod eum suscipit adipisci labore eos omnis.",
"name": "Fuga quod in error.",
"source": "system",
"data_type": "date",
"workspace_id": "NObgxD",
"workspace": {
"_type": "workspace",
"id": "O7AgnZ",
"name": "Culpa accusantium numquam quae id quam adipisci.",
"company_ident": "Sunt ut distinctio debitis est.",
"email": "rschultz@paucek.com",
"root_folder_id": "dw4RgR0"
}
}
}
],
"numeric_values": [
{
"id": "pZ1va0",
"value": 92223319.67107193,
"unit": "Officiis et provident ut.",
"property_id": "AlK0B2",
"property": {
"id": "JZnkea",
"title": "Et et maiores voluptas quia.",
"description": "Dolor sunt qui aut iste.",
"name": "Maiores odio reiciendis in cupiditate.",
"source": "user_defined",
"data_type": "numeric",
"workspace_id": "aL76yB",
"workspace": {
"_type": "workspace",
"id": "Ma2naY",
"name": "Sunt quisquam saepe sit debitis qui adipisci.",
"company_ident": "Porro velit veniam ipsa sed.",
"email": "grayson31@cruickshank.com",
"root_folder_id": "A7Lw49"
}
}
}
],
"string_values": [
{
"id": "LZ88RZ",
"value": "Eum maiores voluptates modi cupiditate.",
"property_id": "Qwrn6wj",
"property": {
"id": "wOywZL",
"title": "Deleniti esse distinctio autem.",
"description": "Omnis expedita beatae quisquam eaque ducimus et non.",
"name": "Et et illum aut inventore soluta iure doloribus odio.",
"source": "user_defined",
"data_type": "string",
"workspace_id": "ED5MDl",
"workspace": {
"_type": "workspace",
"id": "PZprO0",
"name": "Molestias nihil temporibus perferendis voluptas.",
"company_ident": "Ut est sunt expedita corrupti vitae.",
"email": "dbotsford@yahoo.com",
"root_folder_id": "a0MzvO"
}
}
}
],
"jurisdictions": [
{
"id": "Ddle8k",
"code": "Eligendi perspiciatis blanditiis voluptates est optio voluptate voluptatibus."
}
],
"document_types": [
{
"_type": "document_type",
"id": "x09yxG",
"name": "Reiciendis vitae earum est."
}
],
"parties": [
{
"id": "4NwAWq",
"first_name": "Vitae perspiciatis magni dolorum quis iusto maiores.",
"last_name": "Eius nesciunt non minus exercitationem.",
"email": "thiel.felix@williamson.com",
"phone": "Quidem saepe non sequi totam.",
"title": "Nisi sit fugit totam in neque.",
"company_name": "Adipisci omnis rerum qui occaecati.",
"company_ident": "Amet ea et a esse.",
"address_id": "dwj37p",
"address": {
"id": "eDJb0D",
"address_type": "Tempore perspiciatis velit nulla quam sunt.",
"address_lines": "Aut asperiores molestias nostrum consequatur eos fuga quam.",
"city": "Rerum natus et quo consequatur earum cupiditate.",
"locality": "Illum et quibusdam voluptas porro.",
"administrative_area": "Et rerum qui doloremque quo minus.",
"post_code": "Temporibus molestias cum ut amet quos dolorum deserunt.",
"country": "Reprehenderit quidem neque enim et eveniet ut."
},
"external_references": [
{
"id": "NObxZW",
"name": "Sapiente beatae ex dignissimos omnis.",
"title": "Beatae quae optio quia eum.",
"value": "Quae quis voluptatibus dolorem non."
}
]
}
],
"reminders": [
{
"id": "D6Bm6D",
"event_type": "document.reminder",
"title": "Fugit quod et et non rerum."
}
],
"attachments": [
{
"id": "VwyQQw",
"created_at": "2021-11-13T21:50:41+00:00",
"updated_at": "1998-02-27T22:25:18+00:00",
"file_id": "LDQ3aq",
"file": {
"_type": "file",
"id": "vZr97D",
"filename": "example.pdf",
"size": 7185,
"mime": "application/pdf",
"download_url": "http://www.casper.com/",
"preview_url": "http://www.doyle.com/rerum-ea-et-qui-rerum-doloribus"
}
}
],
"external_references": [
{
"id": "DMLvAq",
"name": "Laboriosam ducimus et id soluta pariatur.",
"title": "Reiciendis reprehenderit ratione quo facere atque quos eum quia.",
"value": "Deserunt cum est expedita voluptas nihil."
}
],
"tags": [
{
"tag": "Ea culpa ullam facere consequatur."
}
],
"terms_and_conditions": {
"date": "2002-11-23T11:52:30+00:00",
"effective_date": "2010-04-28T12:31:45+00:00",
"term_end_date": "1986-03-20T18:56:26+00:00",
"signing_date": "1987-08-07T18:17:57+00:00",
"contract_period": "P1D",
"notice_period": "P1D",
"duration_type": "indefinite"
},
"retention": {
"end_date": "2001-06-21T19:41:53+00:00"
},
"breadcrumb": [
{
"id": "DYkdG2",
"name": "Omnis eos nisi vitae totam.",
"depth": 65664653
}
]
},
"template_id": "Facilis vel eveniet alias excepturi.",
"template": {
"id": "jZNNqZ",
"name": "Eligendi rem eum et ipsa deserunt perspiciatis sequi.",
"description": "Repellat neque qui inventore eveniet ut voluptas sequi.",
"type": "tailored"
},
"user": {
"id": "6Ddbja",
"display_name": "Ut labore voluptatem ullam a.",
"first_name": "Illum dolorem ut consequatur facilis consequatur.",
"last_name": "Eligendi quo in eligendi quidem natus ducimus.",
"email": "niko97@roberts.org",
"language": "de"
},
"is_paid": true,
"signing_settings": {
"id": "03LnKN",
"created_at": "1984-03-04T04:15:39+00:00",
"updated_at": "1990-08-29T11:30:52+00:00",
"contract_id": "Jbwgj3o",
"message": "Aut excepturi amet sint quae modi velit.",
"expires_at": "1985-08-11T19:45:01+00:00",
"reminders_start": "2019-08-27T20:28:36+00:00",
"reminders_end": "1986-05-09T11:20:02+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": "7ajpED",
"name": "Incidunt quis eos et architecto repellat.",
"description": "Ipsum nesciunt assumenda sequi enim ut itaque sit.",
"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": "ZX4wLn",
"created_at": "2012-08-05T09:43:54+00:00",
"updated_at": "1975-12-27T04:18:37+00:00",
"name": "Dolorem rerum recusandae rem ea.",
"enabled": true,
"description": "Porro et labore sit incidunt sapiente adipisci eos. Sit necessitatibus distinctio nesciunt ut voluptas eligendi. Id amet maiores temporibus aut occaecati sed. Aspernatur qui enim dolore nesciunt quisquam reprehenderit ut sit.",
"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/Zny5KD" \
--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/Zny5KD"
);
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/Zny5KD';
$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/Zny5KD'
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": "azG1pn",
"created_at": "1993-12-07T14:55:04+00:00",
"updated_at": "1997-05-07T04:39:42+00:00",
"name": "Occaecati perspiciatis animi est occaecati in ducimus hic.",
"enabled": true,
"description": "Est ut velit ea. Delectus non voluptatem quis porro ab exercitationem. Molestias dolore odio sint. Repellat iure corrupti facilis suscipit distinctio.",
"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\": \"Rerum nostrum tempora repudiandae.\",
\"description\": \"Neque id illo quia nihil.\",
\"enabled\": false,
\"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": "Rerum nostrum tempora repudiandae.",
"description": "Neque id illo quia nihil.",
"enabled": false,
"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' => 'Rerum nostrum tempora repudiandae.',
'description' => 'Neque id illo quia nihil.',
'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'
payload = {
"name": "Rerum nostrum tempora repudiandae.",
"description": "Neque id illo quia nihil.",
"enabled": false,
"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": "Oy5P1g",
"created_at": "1997-06-10T01:09:30+00:00",
"updated_at": "1976-11-12T13:21:37+00:00",
"name": "Iure sit ea nulla et consectetur quos sed.",
"enabled": true,
"description": "Nostrum quia modi illo voluptas. Sunt molestiae voluptas inventore commodi reprehenderit. Earum doloribus sunt minima eius.",
"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/1DM7aR" \
--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/1DM7aR"
);
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/1DM7aR';
$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/1DM7aR'
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/mO7AqZ" \
--header "Authorization: Bearer {YOUR_API_TOKEN}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"name\": \"Et quo porro id provident fugiat perspiciatis eveniet.\",
\"description\": \"Et voluptas fugit sunt commodi.\",
\"enabled\": false,
\"accepted_events\": \"sign-process-completed\",
\"endpoints\": []
}"
const url = new URL(
"https://api.docue.com/public/v2/webhooks/mO7AqZ"
);
const headers = {
"Authorization": "Bearer {YOUR_API_TOKEN}",
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "Et quo porro id provident fugiat perspiciatis eveniet.",
"description": "Et voluptas fugit sunt commodi.",
"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/mO7AqZ';
$response = $client->patch(
$url,
[
'headers' => [
'Authorization' => 'Bearer {YOUR_API_TOKEN}',
'Content-Type' => 'application/json',
'Accept' => 'application/json',
],
'json' => [
'name' => 'Et quo porro id provident fugiat perspiciatis eveniet.',
'description' => 'Et voluptas fugit sunt commodi.',
'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/mO7AqZ'
payload = {
"name": "Et quo porro id provident fugiat perspiciatis eveniet.",
"description": "Et voluptas fugit sunt commodi.",
"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": "ZX2mPO",
"created_at": "1971-05-18T10:13:12+00:00",
"updated_at": "2026-01-28T16:54:37+00:00",
"name": "Nisi nulla quia ipsa.",
"enabled": true,
"description": "Eos libero reiciendis ratione inventore repudiandae. Nostrum temporibus eos facere est dignissimos neque corrupti similique. Qui ut facere iste illo.",
"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/wOywZL/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/wOywZL/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/wOywZL/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/wOywZL/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.