Download OpenAPI specification:Download
The API that provides proofing capability to the Adobe Workfront platform.
The account endpoint in the ProofHQ API retrieves information about accounts.
trusted | boolean ?trusted={true|false} |
[- {
- "token": "string",
- "parentAccountToken": "string",
- "name": "string",
- "modified": 0
}
]
The accounts endpoint in the ProofHQ API retrieves detailed information about a specific account.
token required | string Account Token |
{- "token": "string",
- "parentAccountToken": "string",
- "name": "string",
- "modified": 0
}
The endpoint in ProofHQ API retrieves the account settings for a given account.
token required | string Account Token |
{- "onLoadMessage": "string",
- "onDecisionMessage": "string",
- "confirmButtonLabel": "string",
- "postDecisionMessage": "string",
- "displayPostDecisionMessage": 0,
- "isOnTrial": true,
- "isDecisionSigningEnabled": true,
- "decisionSigningMessage": "string",
- "isSso": true,
- "isUnreadCommentsEnabled": true,
- "isResolvedCommentsEnabled": true,
- "useHttps": true,
- "reviewersSeeAllVersions": true,
- "planTier": 0,
- "desktopViewer": 0,
- "isFolderMandatory": true,
- "isRecipientOnMultipleStagesEnabled": true,
- "newProofFolderMode": 0,
- "hasProofNotificationsEnabled": true,
- "copyOwnerFromOriginalProof": true
}
The endpoint in ProofHQ API retrieves the account decisions for a given account.
token required | string Account Token |
[- {
- "token": "string",
- "name": "string",
- "displayName": "string",
- "isEnabled": true,
- "hasReasons": true,
- "hasPostMessage": true
}
]
The endpoint in ProofHQ API retrieves the account decision reasons for a given account.
token required | string Account Token |
[- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
The endpoint in ProofHQ API retrieves the account membership details for a given account.
token required | string Account Token |
{- "loginRequired": true,
- "loginRequiredMandatory": true,
- "netsuiteIntegration": true,
- "basecampIntegration": true,
- "webCaptureEnhancements": true,
- "interactiveWebContent": true,
- "av": true,
- "customFields": true,
- "sharingControl": true,
- "electronicSignature": true,
- "tags": true,
- "groups": true,
- "automatedWorkflow": true,
- "combine": true,
- "decisionReasons": true,
- "roleCustomization": true
}
The endpoint in ProofHQ API retrieves the account devices for a given account.
token required | string Account Token |
[- {
- "token": "string",
- "name": "string",
- "userAgent": "string",
- "accountToken": "string",
- "width": 0,
- "height": 0,
- "ratio": 0,
- "type": 0,
- "position": 0,
- "isDisabled": true,
- "isDefault": true
}
]
Account Device
token required | string Account Token |
name required | string non-empty |
width required | integer |
height required | integer |
type | any Enum: 1 2 3 4 |
ratio | number |
userAgent | string or null |
isDisabled | boolean |
{- "name": "string",
- "width": 0,
- "height": 0,
- "type": 1,
- "ratio": 0,
- "userAgent": "string",
- "isDisabled": true
}
[- {
- "token": "string",
- "name": "string",
- "userAgent": "string",
- "accountToken": "string",
- "width": 0,
- "height": 0,
- "ratio": 0,
- "type": 0,
- "position": 0,
- "isDisabled": true,
- "isDefault": true
}
]
The endpoint in ProofHQ API retrieves the description for a given account device.
token required | string Account Token |
token1 required | string Device Token |
{- "token": "string",
- "name": "string",
- "userAgent": "string",
- "accountToken": "string",
- "width": 0,
- "height": 0,
- "ratio": 0,
- "type": 0,
- "position": 0,
- "isDisabled": true,
- "isDefault": true
}
The endpoint in ProofHQ API updates the account device for a given account.
token required | string Account Token |
token1 required | string Device Token |
name | string non-empty |
width | integer or null |
height | integer or null |
type | any or null Enum: 1 2 3 4 |
ratio | number or null |
userAgent | string or null |
isDisabled | boolean or null |
{- "name": "string",
- "width": 0,
- "height": 0,
- "type": 1,
- "ratio": 0,
- "userAgent": "string",
- "isDisabled": true
}
[- {
- "token": "string",
- "name": "string",
- "userAgent": "string",
- "accountToken": "string",
- "width": 0,
- "height": 0,
- "ratio": 0,
- "type": 0,
- "position": 0,
- "isDisabled": true,
- "isDefault": true
}
]
The endpoint in ProofHQ API retrieves the account domains for a given account.
token required | string Account Token |
[- {
- "token": "string",
- "type": 1,
- "domain": "string",
- "subdomain": "string",
- "path": "string",
- "modified": 0
}
]
The endpoint in ProofHQ API creates the account domain for a given account.
token required | string Account Token |
type required | any Enum: 1 2 3 |
domain required | string non-empty |
subdomain | string or null |
path | string or null |
{- "type": 1,
- "domain": "string",
- "subdomain": "string",
- "path": "string"
}
{- "token": "string",
- "type": 1,
- "domain": "string",
- "subdomain": "string",
- "path": "string",
- "modified": 0
}
The endpoint in ProofHQ API retrieves the account domain for a given account.
token required | string Account Token |
token1 required | string Domain Token |
{- "token": "string",
- "type": 1,
- "domain": "string",
- "subdomain": "string",
- "path": "string",
- "modified": 0
}
The endpoint in ProofHQ API updates the account domain for a given account.
token required | string Account Token |
token1 required | string Domain Token |
type | any Enum: 1 2 3 |
domain | string non-empty |
subdomain | string or null |
path | string or null |
{- "type": 1,
- "domain": "string",
- "subdomain": "string",
- "path": "string"
}
{- "token": "string",
- "type": 1,
- "domain": "string",
- "subdomain": "string",
- "path": "string",
- "modified": 0
}
The endpoint in ProofHQ API authorizes the user.
email required | string |
authtoken required | string |
{- "email": "string",
- "authtoken": "string"
}
{- "sessionId": "string"
}
The endpoint in ProofHQ API retrieves the authorized user information.
{- "context": "user",
- "permissions": {
- "can_create_proofs": true,
- "can_create_files": true,
- "can_create_folders": true,
- "can_edit_all_proofs": true
}, - "userToken": "string",
- "accountToken": "string",
- "contactToken": "string",
- "name": "string",
- "email": "string",
- "avatar": "string",
- "proofToken": "string"
}
The endpoint in ProofHQ API decodes the URL.
url required | string ?url={url} |
compare | string ?compare={compare} |
{- "token": "string",
- "code": "string",
- "compareToken": "string",
- "codeToCompare": "string"
}
The endpoint in ProofHQ API retrieves the Basecamp project contacts.
id required | integer Basecamp Project ID |
refresh | boolean ?refresh={true} |
[- {
- "id": 0,
- "name": "string",
- "email": "string",
- "company": "string",
- "isUser": true
}
]
The endpoint in ProofHQ API retrieves the Basecamp information.
{- "basecampActivated": true,
- "basecampVersion": 0,
- "integrationType": 0,
- "projectId": 0,
- "messageCategoryId": 0,
- "isPrivate": true,
- "defaultStagePosition": 0,
- "defaultDueDate": 0,
- "recipients": [
- {
- "email": "string",
- "dueDate": 0,
- "stagePosition": 0
}
]
}
The endpoint in ProofHQ API creates the Basecamp information.
proofToken required | string |
projectId required | number |
messageCategoryId | number or null |
private | boolean or null |
defaultDueDate | number or null |
defaultStagePosition | number or null |
required | Array of objects |
{- "proofToken": "string",
- "projectId": 0,
- "messageCategoryId": 0,
- "private": true,
- "defaultDueDate": 0,
- "defaultStagePosition": 0,
- "recipients": [
- {
- "email": "string",
- "dueDate": 0,
- "stagePosition": 0
}
]
}
{- "basecampActivated": true,
- "basecampVersion": 0,
- "integrationType": 0,
- "projectId": 0,
- "messageCategoryId": 0,
- "isPrivate": true,
- "defaultStagePosition": 0,
- "defaultDueDate": 0,
- "recipients": [
- {
- "email": "string",
- "dueDate": 0,
- "stagePosition": 0
}
]
}
The endpoint in ProofHQ API retrieves the proof comments.
token required | string Proof Token |
include_deleted | boolean ?include_deleted={true|false} |
recipient | string ?recipient={token} |
stage | string ?stage={token} |
limit | integer ?limit=N (max 500) |
offset | integer ?offset=N |
[- {
- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
]
The endpoint in ProofHQ API creates the proof comment.
token required | string Proof Token |
text required | string non-empty |
drawings | Array of objects or null non-empty |
metadata | object |
textDirection | integer |
pins | object |
page | integer |
pages | integer |
timestampBegin | integer |
timestampEnd | integer |
layout | number |
isLocked | boolean |
actionToken | string or null |
{- "text": "string",
- "drawings": [
- { }
], - "metadata": { },
- "textDirection": 0,
- "pins": { },
- "page": 0,
- "pages": 0,
- "timestampBegin": 0,
- "timestampEnd": 0,
- "layout": 0,
- "isLocked": true,
- "actionToken": "string"
}
{- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
The endpoint in ProofHQ API updates the proof comment.
token required | string Proof Token |
token required | string |
isRead | boolean |
[- {
- "token": "string",
- "isRead": true
}
]
{- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
The endpoint in ProofHQ API retrieves the proof comment.
token required | string Proof Token |
token1 required | string Comment Token |
{- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
The endpoint in ProofHQ API updates the proof comment.
token required | string Proof Token |
token1 required | string Comment Token |
text | string non-empty |
drawings | Array of objects or null non-empty |
metadata | object |
textDirection | integer |
pins | object |
page | integer |
pages | integer |
timestampBegin | integer |
timestampEnd | integer |
editedAt | integer |
layout | number |
isLocked | boolean |
isResolved | boolean |
isReserved | boolean |
actionToken | string or null |
{- "text": "string",
- "drawings": [
- { }
], - "metadata": { },
- "textDirection": 0,
- "pins": { },
- "page": 0,
- "pages": 0,
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "layout": 0,
- "isLocked": true,
- "isResolved": true,
- "isReserved": true,
- "actionToken": "string"
}
{- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
The endpoint in ProofHQ API creates the proof comment attachments.
token required | string Proof Token |
token1 required | string Comment Token |
assetId required | string non-empty |
name | string or null |
{- "assetId": "string",
- "name": "string"
}
{- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
The endpoint in ProofHQ API retrieves the proof comment attachments.
token required | string Proof Token |
token1 required | string Comment Token |
[- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
The endpoint in ProofHQ API retrieves the proof comment attachment.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Attachment Token |
{- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
The endpoint in ProofHQ API updates the proof comment attachment.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Attachment Token |
name | string or null |
{- "name": "string"
}
{- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
The endpoint in ProofHQ API deletes the proof comment attachment.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Attachment Token |
{ }
The endpoint in ProofHQ API retrieves the proof comment file attachments.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Description Token |
download | boolean ?download=true |
The endpoint in ProofHQ API retrieves all the contacts in an user context.
sortBy | string ?sortBy={name|email|created} |
order | string ?order={asc|desc} |
fields | string ?fields=groups |
groupToken | string ?groupToken={tokenGroup} |
accountToken | string ?accountToken={accountGroup} |
loginRequired | boolean ?loginRequired={true|false} |
electronicSignature | boolean ?electronicSignature={true|false} |
sharingControl | integer ?sharingControl={1|2} |
limit | integer ?limit=N (max 100) |
offset | integer ?offset=N |
emails | string ?emails=email1,email2,...,emailn |
[- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
The endpoint in ProofHQ API retrieves a contact.
token required | string Contact Token |
{- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
The endpoint in ProofHQ API retrieves the contact autocomplete.
phrase required | string ?phrase={phrase} |
loginRequired | boolean ?loginRequired={true|false} |
electronicSignature | boolean ?electronicSignature={true|false} |
sharingControl | integer ?sharingControl={0|1|2} |
excludeLight | boolean ?excludeLight={true|false} |
useElasticSearch | boolean ?useElasticSearch={true|false} |
useDatabase | boolean ?useDatabase={true|false} |
onlyContacts | boolean ?onlyContacts={true|false} |
onlyActive | boolean ?onlyActive={true|false} |
credentials | string ?credentials={credential1},...,{credentialN} |
limit | integer ?limit={number} |
{- "contacts": [
- {
- "token": "string",
- "name": "string",
- "email": "string",
- "profileToken": "string"
}
], - "groups": [
- {
- "token": "string",
- "name": "string"
}
], - "accounts": [
- {
- "token": "string",
- "name": "string"
}
]
}
Convert
object required | string Enum: "proof" "account" |
token required | string |
id | integer |
[- {
- "object": "proof",
- "token": "string",
- "id": 0
}
]
[- {
- "object": "proof",
- "token": "string",
- "id": 0
}
]
Crawl
url required | string |
limit | integer or null > 0 |
exceptions | Array of strings or null |
{- "url": "string",
- "limit": 0,
- "exceptions": [
- "string"
]
}
{- "pages": [
- {
- "url": "string",
- "label": "string",
- "hash": "string"
}
], - "metadata": {
- "pageLeftCount": 0
}
}
The endpoint in ProofHQ API retrieves the custom data for custom fields created.
proof | string ?proof={token} |
[- {
- "token": "string",
- "name": "string",
- "order": 0,
- "fields": [
- {
- "id": "string",
- "type": "string",
- "name": "string",
- "controlling": true,
- "help": "string",
- "order": 0,
- "value": "string",
- "defaultValue": "string",
- "options": [
- {
- "token": "string",
- "value": "string",
- "selected": true,
- "selectedDefault": true
}
], - "validation": {
- "mandatory": true,
- "max_length": 0
}
}
]
}
]
The endpoint in ProofHQ API creates the custom file for custom data provided.
token required | string |
name required | string |
order required | number |
required | Array of objects (Schema for an array of CUSTOMDATA FIELD) |
[- {
- "token": "string",
- "name": "string",
- "order": 0,
- "fields": [
- {
- "token": "string",
- "type": 0,
- "name": "string",
- "controlling": true,
- "help": "string",
- "order": 0,
- "value": "string",
- "defaultValue": "string",
- "options": [
- {
- "token": "string",
- "value": "string",
- "selected": true,
- "selectedDefault": true
}
], - "validation": {
- "mandatory": true,
- "max_length": 0
}
}
]
}
]
[- {
- "token": "string",
- "name": "string",
- "order": 0,
- "fields": [
- {
- "id": "string",
- "type": "string",
- "name": "string",
- "controlling": true,
- "help": "string",
- "order": 0,
- "value": "string",
- "defaultValue": "string",
- "options": [
- {
- "token": "string",
- "value": "string",
- "selected": true,
- "selectedDefault": true
}
], - "validation": {
- "mandatory": true,
- "max_length": 0
}
}
]
}
]
The endpoint in ProofHQ API retrieves the email settings for a given account.
email required | string Email Address |
{- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "type": 0,
- "mailingLevel": 0,
- "defaultRole": 0,
- "isFromPartnerOrganization": true
}
The endpoint in ProofHQ API retrieves the folders.
phrase | string ?phrase={phrase} |
parent | string ?parent={token} |
include_partners | boolean ?include_partners={true|false} |
level | integer ?level={level} |
offset | integer ?offset={offset} |
limit | integer ?limit={limit} (max 1000) |
fields | string ?fields=subfoldersCount,itemsCount |
[- {
- "token": "string",
- "name": "string",
- "description": "string",
- "itemsCount": 0,
- "subfoldersCount": 0,
- "level": 0,
- "parentFolderToken": "string",
- "canCreateFolders": true
}
]
The endpoint in ProofHQ API creates the folder.
parentFolderToken | string or null^[a-zA-Z0-9\-]{30,120}$ |
name required | string |
description | string or null |
client | string or null |
project | string or null |
personal | boolean |
ownerToken | string or null^[a-zA-Z0-9\-]{30,120}$ |
[- {
- "parentFolderToken": "string",
- "name": "string",
- "description": "string",
- "client": "string",
- "project": "string",
- "personal": true,
- "ownerToken": "string"
}
]
[- {
- "token": "string",
- "name": "string",
- "description": "string",
- "itemsCount": 0,
- "subfoldersCount": 0,
- "level": 0,
- "parentFolderToken": "string",
- "canCreateFolders": true
}
]
The endpoint in ProofHQ API retrieves the folder information.
token required | string Folder Token |
{- "token": "string",
- "name": "string",
- "description": "string",
- "itemsCount": 0,
- "subfoldersCount": 0,
- "level": 0,
- "parentFolderToken": "string",
- "canCreateFolders": true
}
The endpoint in ProofHQ API retrieves the folder items.
token required | string Folder Token |
display | string ?display={proofs|files} |
offset | integer ?offset=N |
limit | integer ?limit=N (max 200) |
[- {
- "token": "string",
- "name": "string",
- "type": "string",
- "progress": { },
- "decision": "string",
- "mime": "string",
- "fileType": "string",
- "ownerName": "string",
- "commentsCount": 0,
- "repliesCount": 0,
- "itemsCount": 0,
- "thumbnailUrl": "string",
- "downloadUrl": "string",
- "proofingCode": "string",
- "isArchived": true,
- "isProcessed": true,
- "createdAt": "string"
}
]
The endpoint in ProofHQ API retrieves the folder recipients.
token required | string Folder Token |
offset | integer ?offset={offset} |
limit | integer ?limit={limit} (max 1000) |
[- {
- "token": "string",
- "userToken": "string",
- "name": "string",
- "email": "string",
- "company": "string",
- "role": 0
}
]
The endpoint in ProofHQ API retrieves the all proofs for the given user session and the information can be paginated.
name | string ?name={phrase} |
owner | string ?owner={user-token} |
match_parent | string ?match_parent={name} |
tokens | string ?tokens={proof-token-1},{proof-token-2},...,{proof-token-n} |
include_archived | boolean ?include_archived={true|false} |
view | integer ?view={0 - All items (default)|1 - Active proofs|2 - Locked proofs|3 - Archived proofs|4 - Proofs to manage|5 - Proofs awaiting decision|6 - Late proofs} |
string ?email=someone@example.net | |
disable_source | string ?disable_source={lucene|database|legacy_lucene} |
limit | integer ?limit=N (max 100) |
offset | integer ?offset=N |
[- {
- "id": 0,
- "token": "string",
- "type": "string",
- "settingsPreset": "standalone",
- "name": "string",
- "sourceName": "string",
- "created": 0,
- "mime": "string",
- "size": 0,
- "version": 0,
- "versions": 0,
- "number": 0,
- "state": 0,
- "archiveStatus": 0,
- "isArchived": true,
- "processingStatus": "string",
- "pages": 0,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "parentFileToken": "string",
- "ownerUserName": "string",
- "ownerUserToken": "string",
- "ownerImsUserId": "string",
- "creatorUserName": "string",
- "creatorUserToken": "string",
- "creatorImsUserId": "string",
- "creatorEmail": "string",
- "isAutomatedWorkflow": true,
- "hasSelfClose": true,
- "isLoginRequired": true,
- "isOneApproval": true,
- "hasElectronicSignatures": true,
- "canDownload": true,
- "hasPublicSharing": true,
- "hasSubscription": true,
- "defaultNotifications": 0,
- "defaultRole": 0,
- "subscriptionNotification": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "embedCode": "string",
- "teamUrl": "string",
- "folderToken": "string",
- "commentsCount": 0,
- "repliesCount": 0,
- "accountToken": "string",
- "referenceId": "string",
- "stageBasedVisibility": 0,
- "permissions": {
- "edit": true,
- "delete": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
], - "stages": [
- {
- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": null,
- "name": null,
- "type": null,
- "role": null,
- "notifications": null
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
], - "comments": [
- {
- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "templates": [
- {
- "token": "string",
- "name": "string",
- "timezone": "string",
- "ownerToken": "string",
- "groupToken": 0,
- "groupName": "string",
- "isPrimaryGroup": true,
- "permissions": {
- "canAddStage": true,
- "canChangeStageNames": true,
- "canChangeStageDeadline": true,
- "canChangeStageSettings": true,
- "canAddPeopleToStages": true,
- "canRemovePeopleFromStages": true,
- "canEditPeopleInStages": true
}
}
]
}
]
The endpoint in ProofHQ API creates the new proof.
name | string or null |
type | string or null Enum: "swf-animation" "swf-application" currently supports: 'swf-animation', 'swf-application' |
settingsPreset | string or null Enum: "standalone" "integrated" "workfront" currently supports: 'standalone', 'integrated', 'workfront'. If parameter is not passed is uses integrated by default |
isAutomatedWorkflow | boolean or null |
hasMessage | boolean or null |
hasCustomMessage | boolean or null |
subject | string or null |
message | string or null |
ownerUserToken | string or null |
parentFileToken | string or null |
hasSelfClose | boolean or null |
isLoginRequired | boolean or null |
isOneApproval | boolean or null |
hasElectronicSignatures | boolean or null |
canDownload | boolean or null |
hasPublicSharing | boolean or null |
hasSubscription | boolean or null |
stageBasedVisibility | integer or null |
defaultNotifications | integer or null |
defaultRole | integer or null |
subscriptionNotification | any or null Enum: 0 1 2 |
folderToken | string or null^[a-zA-Z0-9\-]{30,120}$ |
formHash | string or null^[a-zA-Z0-9\-]{5,120}$ |
(integer or null) or (string or null) | |
Array of objects or null (Schema for an array of POST on STAGE) | |
Array of objects | |
Array of objects or null | |
Array of objects or null |
[- {
- "name": "string",
- "type": "swf-animation",
- "settingsPreset": "standalone",
- "isAutomatedWorkflow": true,
- "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "ownerUserToken": "string",
- "parentFileToken": "string",
- "hasSelfClose": true,
- "isLoginRequired": true,
- "isOneApproval": true,
- "hasElectronicSignatures": true,
- "canDownload": true,
- "hasPublicSharing": true,
- "hasSubscription": true,
- "stageBasedVisibility": 0,
- "defaultNotifications": 0,
- "defaultRole": 0,
- "subscriptionNotification": 0,
- "folderToken": "string",
- "formHash": "string",
- "referenceId": 0,
- "stages": [
- {
- "name": "string",
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": 0,
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "isPrivate": true,
- "isOneApproval": true,
- "isMandatory": true,
- "recipients": [
- {
- "name": "string",
- "email": "string",
- "notifications": 1,
- "isPrimaryDecisionMaker": true,
- "state": 0,
- "role": -1,
- "position": "string",
- "deadline": 0,
- "referenceId": 0,
- "permissions": {
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}
}
]
}
], - "sourceFiles": [
- {
- "sourceName": "string",
- "hash": "string",
- "resolution": 0
}
], - "customfields": [
- {
- "token": "string",
- "value": "string"
}
], - "templates": [
- {
- "token": "string"
}
]
}
]
[- {
- "id": 0,
- "token": "string",
- "type": "string",
- "settingsPreset": "standalone",
- "name": "string",
- "sourceName": "string",
- "created": 0,
- "mime": "string",
- "size": 0,
- "version": 0,
- "versions": 0,
- "number": 0,
- "state": 0,
- "archiveStatus": 0,
- "isArchived": true,
- "processingStatus": "string",
- "pages": 0,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "parentFileToken": "string",
- "ownerUserName": "string",
- "ownerUserToken": "string",
- "ownerImsUserId": "string",
- "creatorUserName": "string",
- "creatorUserToken": "string",
- "creatorImsUserId": "string",
- "creatorEmail": "string",
- "isAutomatedWorkflow": true,
- "hasSelfClose": true,
- "isLoginRequired": true,
- "isOneApproval": true,
- "hasElectronicSignatures": true,
- "canDownload": true,
- "hasPublicSharing": true,
- "hasSubscription": true,
- "defaultNotifications": 0,
- "defaultRole": 0,
- "subscriptionNotification": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "embedCode": "string",
- "teamUrl": "string",
- "folderToken": "string",
- "commentsCount": 0,
- "repliesCount": 0,
- "accountToken": "string",
- "referenceId": "string",
- "stageBasedVisibility": 0,
- "permissions": {
- "edit": true,
- "delete": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
], - "stages": [
- {
- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": null,
- "name": null,
- "type": null,
- "role": null,
- "notifications": null
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
], - "comments": [
- {
- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "templates": [
- {
- "token": "string",
- "name": "string",
- "timezone": "string",
- "ownerToken": "string",
- "groupToken": 0,
- "groupName": "string",
- "isPrimaryGroup": true,
- "permissions": {
- "canAddStage": true,
- "canChangeStageNames": true,
- "canChangeStageDeadline": true,
- "canChangeStageSettings": true,
- "canAddPeopleToStages": true,
- "canRemovePeopleFromStages": true,
- "canEditPeopleInStages": true
}
}
]
}
]
The endpoint in ProofHQ API updates the proof deadline for a basic proof.
token required | string Proof Token |
deadline required | number |
{- "deadline": 0
}
{- "fileId": 0,
- "deadline": 0
}
The endpoint in ProofHQ API retrieves the proof information for a given proof token.
token required | string Proof Token |
fields | string ?fields=templates |
{- "id": 0,
- "token": "string",
- "type": "string",
- "settingsPreset": "standalone",
- "name": "string",
- "sourceName": "string",
- "created": 0,
- "mime": "string",
- "size": 0,
- "version": 0,
- "versions": 0,
- "number": 0,
- "state": 0,
- "archiveStatus": 0,
- "isArchived": true,
- "processingStatus": "string",
- "pages": 0,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "parentFileToken": "string",
- "ownerUserName": "string",
- "ownerUserToken": "string",
- "ownerImsUserId": "string",
- "creatorUserName": "string",
- "creatorUserToken": "string",
- "creatorImsUserId": "string",
- "creatorEmail": "string",
- "isAutomatedWorkflow": true,
- "hasSelfClose": true,
- "isLoginRequired": true,
- "isOneApproval": true,
- "hasElectronicSignatures": true,
- "canDownload": true,
- "hasPublicSharing": true,
- "hasSubscription": true,
- "defaultNotifications": 0,
- "defaultRole": 0,
- "subscriptionNotification": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "embedCode": "string",
- "teamUrl": "string",
- "folderToken": "string",
- "commentsCount": 0,
- "repliesCount": 0,
- "accountToken": "string",
- "referenceId": "string",
- "stageBasedVisibility": 0,
- "permissions": {
- "edit": true,
- "delete": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
], - "stages": [
- {
- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
], - "comments": [
- {
- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "templates": [
- {
- "token": "string",
- "name": "string",
- "timezone": "string",
- "ownerToken": "string",
- "groupToken": 0,
- "groupName": "string",
- "isPrimaryGroup": true,
- "permissions": {
- "canAddStage": true,
- "canChangeStageNames": true,
- "canChangeStageDeadline": true,
- "canChangeStageSettings": true,
- "canAddPeopleToStages": true,
- "canRemovePeopleFromStages": true,
- "canEditPeopleInStages": true
}
}
]
}
The endpoint in ProofHQ API updates the proof.
token required | string Proof Token |
state | any or null Enum: 0 1 (lock, unlock) |
ownerUserToken | string or null non-empty |
hasSelfClose | boolean |
isLoginRequired | boolean |
isOneApproval | boolean |
hasElectronicSignatures | boolean |
canDownload | boolean |
hasPublicSharing | boolean |
hasSubscription | boolean |
defaultNotifications | any or null Enum: 1 2 3 4 5 6 9 |
defaultRole | any or null Enum: 1 3 4 5 |
subscriptionNotification | any or null Enum: 0 1 2 |
{- "state": 0,
- "ownerUserToken": "string",
- "hasSelfClose": true,
- "isLoginRequired": true,
- "isOneApproval": true,
- "hasElectronicSignatures": true,
- "canDownload": true,
- "hasPublicSharing": true,
- "hasSubscription": true,
- "defaultNotifications": 1,
- "defaultRole": 1,
- "subscriptionNotification": 0
}
{- "id": 0,
- "token": "string",
- "type": "string",
- "settingsPreset": "standalone",
- "name": "string",
- "sourceName": "string",
- "created": 0,
- "mime": "string",
- "size": 0,
- "version": 0,
- "versions": 0,
- "number": 0,
- "state": 0,
- "archiveStatus": 0,
- "isArchived": true,
- "processingStatus": "string",
- "pages": 0,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "parentFileToken": "string",
- "ownerUserName": "string",
- "ownerUserToken": "string",
- "ownerImsUserId": "string",
- "creatorUserName": "string",
- "creatorUserToken": "string",
- "creatorImsUserId": "string",
- "creatorEmail": "string",
- "isAutomatedWorkflow": true,
- "hasSelfClose": true,
- "isLoginRequired": true,
- "isOneApproval": true,
- "hasElectronicSignatures": true,
- "canDownload": true,
- "hasPublicSharing": true,
- "hasSubscription": true,
- "defaultNotifications": 0,
- "defaultRole": 0,
- "subscriptionNotification": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "embedCode": "string",
- "teamUrl": "string",
- "folderToken": "string",
- "commentsCount": 0,
- "repliesCount": 0,
- "accountToken": "string",
- "referenceId": "string",
- "stageBasedVisibility": 0,
- "permissions": {
- "edit": true,
- "delete": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
], - "stages": [
- {
- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
], - "comments": [
- {
- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "templates": [
- {
- "token": "string",
- "name": "string",
- "timezone": "string",
- "ownerToken": "string",
- "groupToken": 0,
- "groupName": "string",
- "isPrimaryGroup": true,
- "permissions": {
- "canAddStage": true,
- "canChangeStageNames": true,
- "canChangeStageDeadline": true,
- "canChangeStageSettings": true,
- "canAddPeopleToStages": true,
- "canRemovePeopleFromStages": true,
- "canEditPeopleInStages": true
}
}
]
}
The endpoint in ProofHQ API patches the proof.
token required | string Proof Token |
name | string or null [ 1 .. 2000 ] characters (name) |
state | any or null Enum: 0 1 (lock, unlock) |
isArchived | boolean or null (archive, unarchive) |
ownerUserToken | string or null (owner of the proof) |
subject | string or null (custom subject) |
message | string or null (custom message) |
isAutomatedWorkflow | boolean or null (change workflow from basic to automated) |
{- "name": "string",
- "state": 0,
- "isArchived": true,
- "ownerUserToken": "string",
- "subject": "string",
- "message": "string",
- "isAutomatedWorkflow": true
}
{ }
The endpoint in ProofHQ API creates the proof copy for the given proof token.
token required | string Proof Token |
uploadHash required | string |
sourceName | string or null |
name | string or null |
(integer or null) or (string or null) | |
newVersion | boolean or null Creates copy as new version |
{- "uploadHash": "string",
- "sourceName": "string",
- "name": "string",
- "referenceId": 0,
- "newVersion": true
}
{- "file_id": 0,
- "token": "string"
}
The endpoint in ProofHQ API retrieves the proof activity.
token required | string Proof Token |
limit | integer ?limit=N (max 200) |
offset | integer ?offset=N |
[- {
- "created": 0,
- "person": "string",
- "action": 0,
- "actionLabel": "string",
- "detailsPhrase": "string",
- "detailsParams": [
- "string"
]
}
]
The endpoint in ProofHQ API retrieves the proof tags.
token required | string Proof Token |
sortBy | string ?sortBy={name|created} |
order | string ?order={asc|desc} |
limit | integer ?limit=N (max 1000) |
offset | integer ?offset=N |
[- {
- "token": "string",
- "name": "string",
- "usage": 0,
- "created": 0,
- "modified": 0,
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
The endpoint in ProofHQ API creates the proof tags.
token required | string Proof Token |
token required | string^[a-zA-Z0-9\-]{30,120}$ |
[- {
- "token": "string"
}
]
[- {
- "token": "string",
- "name": "string",
- "usage": 0,
- "created": 0,
- "modified": 0,
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
The endpoint in ProofHQ API retrieves the proof controls.
token required | string Proof Token |
{- "buttons": {
- "newProof": true,
- "newFile": true,
- "newVersion": true,
- "newFolder": true,
- "newContact": true,
- "newGroup": true,
- "dashboard": true,
- "folder": true,
- "versions": true,
- "customLink": true,
- "shareProof": true,
- "remindProof": true,
- "copyProof": true,
- "shareLinks": true,
- "deleteProof": true,
- "lockProof": true,
- "downloadSourceFile": true,
- "proofDetailsLink": true,
- "closeButton": true,
- "finishReview": true,
- "proofDetails": true,
- "proofWorkflow": true,
- "delegateOwnership": true
}, - "display": {
- "seeCustomLink": true,
- "seeCustomMenu": true,
- "seeDashboard": true,
- "seeWorkspace": true,
- "seeSummaryPage": true,
- "seeVersions": true,
- "seeName": true,
- "seeTools": true,
- "seeWindowSettings": true,
- "seeSidebarOnLaunch": true,
- "seeControlsOnLaunch": true,
- "seeMarkupsOnLaunch": true,
- "seePinsOnLaunch": true,
- "seeOverviewOnLaunch": true,
- "seeTooltips": true,
- "seeHelp": true,
- "seeBlog": true,
- "seeForum": true,
- "seeQuickStart": true,
- "seeUserGuide": true,
- "seeCloseButton": true,
- "seeCurrentWorkspace": true,
- "seeOtherWorkspace": true,
- "seeWorkspaceDetails": true,
- "seeProofsList": true,
- "seeWelcomeScreen": true,
- "seeAllItems": true,
- "seeProofDetails": true,
- "seePublishToTheWeb": true,
- "seeSendDecisionConfirmationCheckbox": true,
- "canSeeActivity": true
}, - "functions": {
- "canMark": true,
- "canEditOwnMarker": true,
- "canDeleteOwnMarker": true,
- "canDeleteOwnReply": true,
- "canEditOtherMarker": true,
- "canDeleteOtherMarker": true,
- "canDeleteOtherReply": true,
- "canDeleteThread": true,
- "canDecide": true,
- "addReviewer": true,
- "removeReviewer": true,
- "remindPerson": true,
- "changeEmailPreferences": true,
- "shareTeamURL": true,
- "shareEmbedURL": true,
- "changeOwner": true,
- "lockProof": true,
- "unlockProof": true,
- "deleteProof": true,
- "printComments": true,
- "downloadFile": true,
- "sendFile": true,
- "addNewVersion": true,
- "compareVersions": true,
- "canEditActions": true,
- "canMakeNewFile": true,
- "canMakeSubFolders": true,
- "canMakeProof": true,
- "copyProof": true,
- "editStage": true,
- "canSetTextDirection": true,
- "canResolveComments": true,
- "canUseMentions": true,
- "canSendNotifications": true,
- "canUseReasons": true,
- "canMentionContact": true
}
}
The endpoint in ProofHQ API retrieves the proof custom fields.
token required | string Proof Token |
[- {
- "id": "string",
- "name": "string",
- "items": [
- {
- "id": "string",
- "type": "string",
- "label": "string",
- "value": "string",
- "disabled": true
}
]
}
]
The endpoint in ProofHQ API retrieves the proof decisions.
token required | string Proof Token |
{- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}
Method allows to send email notifications with proof team or download links.
token required | string Proof Token |
send_download_url required | boolean |
send_team_url required | boolean |
emails required | Array of strings <email> non-empty [ items <email > ] List of recipients emails |
message_subject | string or null |
message_body | string or null |
{- "send_download_url": true,
- "send_team_url": true,
- "emails": [
- "user@example.com"
], - "message_subject": "string",
- "message_body": "string"
}
{ }
The endpoint in ProofHQ API retrieves the proof settings.
token required | string Proof Token |
{- "subscriptionRole": 0,
- "subscriptionNotifications": 0,
- "isEmbedEnabled": true,
- "isTeamUrlEnabled": true,
- "isAutoLockingEnabled": true,
- "isLoginRequired": true,
- "isOneDecisionRequiredEnabled": true,
- "isDecisionSigningEnabled": true,
- "isProofNumberingEnabled": true,
- "isDownloadEnabled": true,
- "isStreamingEnabled": true,
- "isCalculationToolEnabled": true,
- "hasNewProofNotificationEnabled": true,
- "zoomLevel": 0,
- "cloudService": 0,
- "framerate": 0,
- "width": 0,
- "height": 0,
- "codec": "string",
- "format": "string",
- "size": 0,
- "length": 0,
- "reasonsTitle": "string",
- "reasonsMultipleSelection": true,
- "reasonsAllowNone": true,
- "reasonsCanSet": true,
- "storageMethod": 0,
- "resolutionLabel": "string"
}
The endpoint in ProofHQ API retrieves the proof settings based on profile settings.
token required | string Proof Token |
{- "subject": "string",
- "message": "string",
- "subscriptions": true,
- "defaultRole": 0,
- "validateSubscriptions": 0,
- "emailNotifications": 0,
- "newProofNotification": true,
- "hasProofNotificationsEnabled": true,
- "loginRequired": 0,
- "allowPublicSharing": true,
- "autoclose": true,
- "oneDecision": true,
- "blockDownload": true,
- "automatedWorkflow": true,
- "electronicSignature": 0,
- "sharingControl": 0,
- "defaultDeadlineOffset": 0,
- "proofStageBasedVisibility": 0,
- "basecampActivated": true,
- "basecampVersion": 0,
- "desktopViewer": 0
}
The endpoint in ProofHQ API retrieves the proof source files.
token required | string Proof Token |
[- {
- "name": "string",
- "size": 0,
- "mime": "string",
- "pagesFrom": 0,
- "pagesTo": 0,
- "resolutionLabel": "string"
}
]
The endpoint in ProofHQ API retrieves the proof URLs.
token required | string Proof Token |
{- "download": "string",
- "print": "string",
- "public": "string",
- "proofDetails": "string",
- "folderDetails": "string",
- "dashboard": "string",
- "views": "string",
- "folders": "string",
- "newProof": "string",
- "newVersion": "string",
- "addRecipient": "string",
- "shareProof": "string",
- "remindRecipient": "string",
- "logout": "string",
- "redirection": "string",
- "basecamp": {
- "label": "string",
- "url": "string"
}, - "custom": {
- "label": "string",
- "url": "string"
}, - "helpFaq": {
- "label": "string",
- "url": "string"
}, - "helpDemo": {
- "label": "string",
- "url": "string"
}, - "helpBlog": {
- "label": "string",
- "url": "string"
}, - "helpForum": {
- "label": "string",
- "url": "string"
}, - "cloudUrl": "string",
- "cloudFileUrl": "string",
- "cloudStreamingUrl": "string",
- "richMediaUrl": "string",
- "sso": "string",
- "ssoDecision": "string",
- "attask": {
- "label": "string",
- "url": "string"
}, - "netsuite": {
- "label": "string",
- "url": "string"
}, - "newFile": "string",
- "newFolder": "string",
- "newContact": "string",
- "newGroup": "string",
- "copyProof": "string",
- "baseUrl": "string",
- "outputUrl": "string",
- "masterBaseUrl": "string",
- "pagesBaseUrl": "string",
- "excelSummary": "string",
- "printImageUrl": "string",
- "thumbnailUrl": "string"
}
The endpoint in ProofHQ API retrieves the proof versions.
token required | string Proof Token |
strict | string ?strict=true |
processed_only | boolean ?processed_only=false |
[- {
- "id": 0,
- "token": "string",
- "type": "string",
- "settingsPreset": "standalone",
- "name": "string",
- "sourceName": "string",
- "created": 0,
- "mime": "string",
- "size": 0,
- "version": 0,
- "versions": 0,
- "number": 0,
- "state": 0,
- "archiveStatus": 0,
- "isArchived": true,
- "processingStatus": "string",
- "pages": 0,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "parentFileToken": "string",
- "ownerUserName": "string",
- "ownerUserToken": "string",
- "ownerImsUserId": "string",
- "creatorUserName": "string",
- "creatorUserToken": "string",
- "creatorImsUserId": "string",
- "creatorEmail": "string",
- "isAutomatedWorkflow": true,
- "hasSelfClose": true,
- "isLoginRequired": true,
- "isOneApproval": true,
- "hasElectronicSignatures": true,
- "canDownload": true,
- "hasPublicSharing": true,
- "hasSubscription": true,
- "defaultNotifications": 0,
- "defaultRole": 0,
- "subscriptionNotification": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "embedCode": "string",
- "teamUrl": "string",
- "folderToken": "string",
- "commentsCount": 0,
- "repliesCount": 0,
- "accountToken": "string",
- "referenceId": "string",
- "stageBasedVisibility": 0,
- "permissions": {
- "edit": true,
- "delete": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
], - "stages": [
- {
- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": null,
- "name": null,
- "type": null,
- "role": null,
- "notifications": null
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
], - "comments": [
- {
- "token": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "authorToken": "string",
- "stageToken": "string",
- "created": 0,
- "modified": 0,
- "drawings": [
- { }
], - "pins": { },
- "pages": [
- 0
], - "layout": 0,
- "number": 0,
- "metadata": { },
- "url": "string",
- "timestampBegin": 0,
- "timestampEnd": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "reservedBy": 0,
- "isReserved": true,
- "isLocked": true,
- "isDeleted": true,
- "isResolved": true,
- "isRead": true,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "replies": [
- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
], - "templates": [
- {
- "token": "string",
- "name": "string",
- "timezone": "string",
- "ownerToken": "string",
- "groupToken": 0,
- "groupName": "string",
- "isPrimaryGroup": true,
- "permissions": {
- "canAddStage": true,
- "canChangeStageNames": true,
- "canChangeStageDeadline": true,
- "canChangeStageSettings": true,
- "canAddPeopleToStages": true,
- "canRemovePeopleFromStages": true,
- "canEditPeopleInStages": true
}
}
]
}
]
The endpoint in ProofHQ API retrieves the proof exported to excel format.
token required | string Proof Token |
allVersions | boolean ?allVersions=true |
authors | string ?authors={recipientToken1},...,{recipientTokenN} |
actions | string ?actions={actionToken1},...,{actionTokenN} |
hideResolved | boolean ?hideResolved=true |
The endpoint in ProofHQ API creates the proof export request for PDF format.
token required | string Proof Token |
allVersions | string true|false |
hideResolved | string true|false |
actions | string CSV of action tokens + unactioned keyword |
authors | string CSV of recipients tokens |
{- "allVersions": "string",
- "hideResolved": "string",
- "actions": "string",
- "authors": "string"
}
{ }
The endpoint in ProofHQ API retrieves all the proof stages.
token required | string Proof Token |
fields | boolean ?fields=(recipients) |
hideInvisible | boolean ?hideInvisible=true |
hideBlocked | string ?hideBlocked=true |
hideFromInactiveStages | boolean ?hideFromInactiveStages=true |
[- {
- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
]
The endpoint in ProofHQ API creates the proof stages.
token required | string Proof Token |
name | string |
position | number |
parentPosition | number or null |
deadlineCalculateOn | any or null Enum: 1 2 |
deadlineDate | number or null |
deadlineBusinessDays | number or null |
(number or null) or (string or null) | |
activateOn | any or null Enum: 1 2 3 6 7 8 |
activateOnDecision | any or null Enum: 1 2 |
activateOnDate | number or null |
lockOn | any or null Enum: 1 2 3 4 |
isPrivate | boolean or null |
isOneApproval | boolean or null |
isMandatory | boolean or null |
Array of objects (Schema for POST on RECIPIENT) |
[- {
- "name": "string",
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": 0,
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "isPrivate": true,
- "isOneApproval": true,
- "isMandatory": true,
- "recipients": [
- {
- "name": "string",
- "email": "string",
- "notifications": 1,
- "isPrimaryDecisionMaker": true,
- "state": 0,
- "role": -1,
- "position": "string",
- "deadline": 0,
- "referenceId": 0,
- "permissions": {
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}
}
]
}
]
[- {
- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
]
The endpoint in ProofHQ API retrieves the proof stage.
token required | string Proof Token |
token1 required | string Stage Token |
{- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
The endpoint in ProofHQ API updates the proof stage settings.
token required | string Proof Token |
token1 required | string Stage Token |
name | string |
parentPosition | number or null |
deadlineCalculateOn | any Enum: 1 2 |
deadlineDate | number or null |
activateOn | any Enum: 1 2 3 6 7 8 null |
activateOnDecision | any Enum: 1 2 null |
activateOnDate | number or null |
lockOn | any Enum: 1 2 3 4 |
isPrivate | boolean |
isOneApproval | boolean |
{- "name": "string",
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadlineDate": 0,
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "isPrivate": true,
- "isOneApproval": true
}
{- "token": "string",
- "name": "string",
- "number": 0,
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 1,
- "deadline": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": "string",
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "lockOn": 1,
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "decisionAt": 0
}, - "hasMessage": true,
- "hasCustomMessage": true,
- "subject": "string",
- "message": "string",
- "isPrivate": true,
- "isActive": true,
- "isLocked": true,
- "isOneApproval": true,
- "isMandatory": true,
- "commentsCount": 0,
- "repliesCount": 0,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "permissions": {
- "edit": true,
- "delete": true,
- "activate": true,
- "lock": true
}, - "recipients": [
- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
}
The endpoint in ProofHQ API patches the proof stage settings.
token required | string Proof Token |
token1 required | string Stage Token |
subject | string or null (custom subject) |
message | string or null (custom message) |
{- "subject": "string",
- "message": "string"
}
{ }
The endpoint in ProofHQ API retrieves the proof stage decisions.
token required | string Proof Token |
token1 required | string Stage Token |
{- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}
The endpoint in ProofHQ API retrieves the proof stage recipients.
token required | string Proof Token |
token1 required | string Stage Token |
fields | string ?fields=contacts |
hideInvisible | boolean ?hideInvisible=true |
hideBlocked | string ?hideBlocked=true |
hideFromInactiveStages | boolean ?hideFromInactiveStages=true |
[- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
The endpoint in ProofHQ API creates the proof stage recipients.
token required | string Proof Token |
token1 required | string Stage Token |
[- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
The endpoint in ProofHQ API retrieves a proof stage recipient.
token required | string Proof Token |
token1 required | string Stage Token |
token2 required | string Recipient Token |
{- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
The endpoint in ProofHQ API updates the proof stage recipient.
token required | string Proof Token |
token1 required | string Stage Token |
token2 required | string Recipient Token |
name | string or null |
notifications | any or null Enum: 1 2 3 4 5 6 7 8 9 |
object | |
role | any or null Enum: 1 2 3 4 5 6 7 |
isPrimaryDecisionMaker | boolean or null |
state | number or null defines review state |
isOwner | any or null Value: true |
{- "name": "string",
- "notifications": 1,
- "decision": {
- "token": "string",
- "reasons": [
- {
- "token": "string",
- "reasonText": "string"
}
]
}, - "role": 1,
- "isPrimaryDecisionMaker": true,
- "state": 0,
- "isOwner": true
}
{- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
The endpoint in ProofHQ API retrieves the proof recipients.
token required | string Proof Token |
string ?email=someone@example.net | |
hideInvisible | boolean ?hideInvisible=true |
hideBlocked | string ?hideBlocked=true |
hideFromInactiveStages | boolean ?hideFromInactiveStages=true |
[- {
- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
]
The endpoint in ProofHQ API creates the proof recipients.
token required | string Proof Token |
name | string or null |
email required | string |
notifications | any or null Enum: 1 2 3 4 5 6 7 8 9 |
isPrimaryDecisionMaker | boolean or null |
state | number or null defines review state |
role | any or null Enum: -1 0 1 2 3 4 5 6 7 recipient proof role |
position | string or null |
deadline | number or null Sets deadline for basic proof recipient |
(integer or null) or (string or null) | |
object (Schema for POST on RECIPIENT PERMISSIONS) |
{- "name": "string",
- "email": "string",
- "notifications": 1,
- "isPrimaryDecisionMaker": true,
- "state": 0,
- "role": -1,
- "position": "string",
- "deadline": 0,
- "referenceId": 0,
- "permissions": {
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}
}
{- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
The endpoint in ProofHQ API searches the proof recipients.
token required | string Proof Token |
string or null | |
token | string or null^[a-zA-Z0-9\-]{30,120}$ |
referenceId | string or null |
{- "email": "string",
- "token": "string",
- "referenceId": "string"
}
[- {
- "token": "string",
- "email": "string",
- "role": 0,
- "roleName": "string",
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}
}
]
The endpoint in ProofHQ API retrieves the proof recipient.
token required | string Proof Token |
token1 required | string Recipient Token |
{- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
The endpoint in ProofHQ API updates the proof recipient.
token required | string Proof Token |
token1 required | string Recipient Token |
name | string or null |
notifications | any or null Enum: 1 2 3 4 5 6 7 8 9 |
object | |
role | any or null Enum: 1 2 3 4 5 6 7 |
isPrimaryDecisionMaker | boolean or null |
state | number or null defines review state |
isOwner | any or null Value: true |
{- "name": "string",
- "notifications": 1,
- "decision": {
- "token": "string",
- "reasons": [
- {
- "token": "string",
- "reasonText": "string"
}
]
}, - "role": 1,
- "isPrimaryDecisionMaker": true,
- "state": 0,
- "isOwner": true
}
{- "token": "string",
- "userToken": "string",
- "imsUserId": "string",
- "stageToken": "string",
- "name": "string",
- "email": "string",
- "created": 0,
- "role": 0,
- "roleName": "string",
- "decision": {
- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}, - "commentsCount": 0,
- "repliesCount": 0,
- "notifications": 1,
- "progress": {
- "sent": 0,
- "opened": 0,
- "commented": 0,
- "decided": 0
}, - "isPrimaryDecisionMaker": true,
- "isVerified": true,
- "isUser": true,
- "isCreator": true,
- "isOwner": true,
- "state": 0,
- "referenceId": "string",
- "permissions": {
- "edit": true,
- "delete": true,
- "canBecomeOwner": true,
- "editAll": true,
- "resolveCommentsAndActions": true,
- "shareProof": true,
- "canView": true,
- "canContribute": true,
- "canManage": true,
- "canDecide": true,
- "canDownload": true,
- "canShare": true,
- "canEditWorkflow": true,
- "canDelete": true
}, - "contacts": [
- {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}
]
}
The endpoint in ProofHQ API retrieves the proof recipient decision.
token required | string Proof Token |
token1 required | string Recipient Token |
{- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}
The endpoint in ProofHQ API updates the proof recipient decision.
token required | string Proof Token |
token1 required | string Recipient Token |
decision required | string |
(Array of Schema for an array of Reasons (objects or null)) | |
send_confirmation | boolean or null |
login | string or null |
password | string or null |
{- "decision": "string",
- "reasons": [
- {
- "token": "string",
- "reasonText": "string"
}
], - "send_confirmation": true,
- "login": "string",
- "password": "string"
}
{- "token": "string",
- "decision": 0,
- "name": "string",
- "displayName": "string",
- "isSignedDecision": true,
- "decisionAt": 0,
- "hasReasons": true,
- "reasons": [
- {
- "token": "string",
- "name": "string",
- "hasText": true,
- "reasonText": "string"
}
]
}
The endpoint in ProofHQ API retrieves the proof recipient URLs.
token required | string Proof Token |
token1 required | string Recipient Token |
{- "remind": "string",
- "edit": "string",
- "attask": "string",
- "basecamp": "string",
- "netsuite": "string"
}
The endpoint in ProofHQ API retrieves the proof comment replies.
token required | string Proof Token |
token1 required | string Comment Token |
include_action_replies | boolean ?include_action_replies={true|false} |
[- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
]
The endpoint in ProofHQ API creates the proof comment replies.
token required | string Proof Token |
token1 required | string Comment Token |
text required | string non-empty |
textDirection | integer |
{- "text": "string",
- "textDirection": 0
}
{- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
The endpoint in ProofHQ API updates the proof comment replies.
token required | string Proof Token |
token1 required | string Comment Token |
token required | string |
isRead | boolean |
[- {
- "token": "string",
- "isRead": true
}
]
[- {
- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
]
The endpoint in ProofHQ API retrieves the proof comment reply.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
{- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
The endpoint in ProofHQ API updates the proof comment reply.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
text | string non-empty |
editedAt | integer |
{- "text": "string",
- "editedAt": 0
}
{- "token": "string",
- "type": 0,
- "displayType": "string",
- "text": "string",
- "textDirection": 0,
- "author": "string",
- "created": 0,
- "modified": 0,
- "editedAt": 0,
- "editorName": "string",
- "actionToken": "string",
- "actionName": "string",
- "isRead": true,
- "isDeleted": true,
- "number": 0,
- "permissions": {
- "edit": true,
- "delete": true,
- "lock": true,
- "action": true,
- "resolve": true,
- "markAsRead": true
}, - "attachments": [
- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
}
The endpoint in ProofHQ API creates the proof comment reply attachments.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
assetId required | string non-empty |
name | string or null |
{- "assetId": "string",
- "name": "string"
}
{- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
The endpoint in ProofHQ API retrieves the proof comment reply attachments.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
[- {
- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
The endpoint in ProofHQ API retrieves the proof comment reply attachment.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
token3 required | string Attachment Token |
{- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
The endpoint in ProofHQ API updates the proof comment reply attachment.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
token3 required | string Attachment Token |
name | string or null |
{- "name": "string"
}
{- "token": "string",
- "mime": "string",
- "name": "string",
- "size": 0,
- "downloadUrl": "string",
- "permissions": {
- "edit": true,
- "delete": true
}
}
The endpoint in ProofHQ API deletes the proof comment reply attachment.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
token3 required | string Attachment Token |
{ }
The endpoint in ProofHQ API retrieves the proof comment reply attachment file.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
token3 required | string Attachment Token |
download | boolean ?download=true |
The endpoint in ProofHQ API retrieves the proof comment reply attachment thumbnail.
token required | string Proof Token |
token1 required | string Comment Token |
token2 required | string Reply Token |
token3 required | string Attachment Token |
The endpoint in ProofHQ API retrieves the profile settings for proofing.
{- "subject": "string",
- "message": "string",
- "subscriptions": true,
- "defaultRole": 0,
- "validateSubscriptions": 0,
- "emailNotifications": 0,
- "newProofNotification": true,
- "hasProofNotificationsEnabled": true,
- "loginRequired": 0,
- "allowPublicSharing": true,
- "autoclose": true,
- "oneDecision": true,
- "blockDownload": true,
- "automatedWorkflow": true,
- "electronicSignature": 0,
- "sharingControl": 0,
- "defaultDeadlineOffset": 0,
- "proofStageBasedVisibility": 0,
- "basecampActivated": true,
- "basecampVersion": 0,
- "desktopViewer": 0
}
The endpoint in ProofHQ API retrieves the tags list and can be filtered by limit and offset.
limit | integer ?limit=N (max 100) |
offset | integer ?offset=N |
[- {
- "token": "string",
- "name": "string",
- "usage": 0,
- "created": 0,
- "modified": 0,
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
The endpoint in ProofHQ API creates the tags.
name required | string <= 30 characters |
[- {
- "name": "string"
}
]
[- {
- "token": "string",
- "name": "string",
- "usage": 0,
- "created": 0,
- "modified": 0,
- "permissions": {
- "edit": true,
- "delete": true
}
}
]
The endpoint in ProofHQ API retrieves the tag.
token required | string Tage Token |
{- "token": "string",
- "name": "string",
- "usage": 0,
- "created": 0,
- "modified": 0,
- "permissions": {
- "edit": true,
- "delete": true
}
}
The endpoint in ProofHQ API uploads a document.
url | string |
object |
[- {
- "url": "string",
- "encodedFiles": {
- "name": "string",
- "type": "string",
- "size": 0,
- "data": "string"
}
}
]
[- {
- "token": "string",
- "canBeCombined": true,
- "canBeInteractive": 0,
- "httpLinks": [
- "string"
], - "type": "string",
- "url": "string"
}
]
The endpoint in ProofHQ API retrieves the users list.
[- {
- "token": "string",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "dateFormat": "string",
- "dateTimezone": "string",
- "language": "string"
}
]
The endpoint in ProofHQ API retrieves the user.
token required | string User Token |
{- "token": "string",
- "name": "string",
- "firstName": "string",
- "lastName": "string",
- "dateFormat": "string",
- "dateTimezone": "string",
- "language": "string"
}
The endpoint in ProofHQ API retrieves the workflow templates list.
[- {
- "token": "string",
- "name": "string",
- "timezone": "string",
- "ownerToken": "string",
- "groupToken": 0,
- "groupName": "string",
- "isPrimaryGroup": true,
- "permissions": {
- "canAddStage": true,
- "canChangeStageNames": true,
- "canChangeStageDeadline": true,
- "canChangeStageSettings": true,
- "canAddPeopleToStages": true,
- "canRemovePeopleFromStages": true,
- "canEditPeopleInStages": true
}
}
]
The endpoint in ProofHQ API retrieves the workflow template.
token required | string Template Token |
{- "token": "string",
- "name": "string",
- "timezone": "string",
- "ownerToken": "string",
- "groupToken": 0,
- "groupName": "string",
- "isPrimaryGroup": true,
- "permissions": {
- "canAddStage": true,
- "canChangeStageNames": true,
- "canChangeStageDeadline": true,
- "canChangeStageSettings": true,
- "canAddPeopleToStages": true,
- "canRemovePeopleFromStages": true,
- "canEditPeopleInStages": true
}
}
The endpoint in ProofHQ API retrieves the workflow template stages.
token required | string Template Token |
[- {
- "token": "string",
- "name": "string",
- "parentStageToken": "string",
- "position": 0,
- "parentPosition": 0,
- "deadlineCalculateOn": 0,
- "deadlineDate": 0,
- "deadlineBusinessDays": 0,
- "deadlineTime": 0,
- "activateOn": 1,
- "activateOnDecision": 1,
- "activateOnDate": 0,
- "activateOnBusinessDays": 0,
- "activateOnTime": 0,
- "lockOn": 0,
- "primaryRecipientToken": "string",
- "isPrivate": true,
- "isMandatory": true,
- "isOneApproval": true,
- "isDisabled": true
}
]
The endpoint in ProofHQ API retrieves the workflow template stage recipients.
token required | string Template Token |
token1 required | string Stage Token |
fields | string ?fields=contacts |
[- {
- "token": "string",
- "stageToken": "string",
- "workflowTemplateToken": "string",
- "userToken": "string",
- "name": "string",
- "email": "string",
- "role": 0,
- "roleName": "string",
- "notifications": 1,
- "isPlaceholder": true,
- "isUser": true,
- "isOwner": true,
- "isPrimaryDecisionMaker": true,
- "permissions": {
- "canResolveComments": true,
- "canActionComments": true,
- "canShareByMention": true
}, - "contacts": {
- "firstName": "string",
- "lastName": "string",
- "email": "string",
- "token": "string",
- "type": 0,
- "accountToken": "string",
- "profileToken": "string",
- "mailingLevel": 0,
- "defaultRole": 0,
- "image": "string",
- "reference_id": "string",
- "isFromPartnerOrganization": true,
- "groups": [
- {
- "token": "string",
- "name": "string",
- "type": 0,
- "role": 0,
- "notifications": 0
}
], - "permissions": {
- "editAll": true
}
}, - "imsUserId": "string"
}
]
The endpoint in ProofHQ API retrieves the workfront user.
referenceId required | string Workfront's user guid |
WF-CustomerID required | string <uuid> Workfront's account guid |
{- "contactToken": "string",
- "email": "string",
- "profileToken": "string",
- "referenceId": "string",
- "apiToken": "string"
}
The endpoint in ProofHQ API updates the workfront user.
referenceId required | string Workfront's user guid |
WF-CustomerID required | string <uuid> Workfront's account guid |
email required | string <email> |
firstName required | string |
lastName required | string |
hasProofingLicense required | boolean |
isExternal required | boolean |
permissionId required | integer |
defaultRecipientRole required | integer |
isActive required | boolean |
isFromSso | boolean |
imsUserId | string |
imsOrgId | string |
{- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "hasProofingLicense": true,
- "isExternal": true,
- "permissionId": 0,
- "defaultRecipientRole": 0,
- "isActive": true,
- "isFromSso": true,
- "imsUserId": "string",
- "imsOrgId": "string"
}
{- "contactToken": "string",
- "email": "string",
- "profileToken": "string",
- "referenceId": "string",
- "apiToken": "string"
}
The endpoint in ProofHQ API deletes the workfront user.
referenceId required | string Workfront's user guid |
WF-CustomerID required | string <uuid> Workfront's account guid |
{ }
The endpoint in ProofHQ API creates the workfront user in proofing.
WF-CustomerID required | string <uuid> Workfront's account guid |
referenceId required | string |
email required | string <email> |
firstName required | string |
lastName required | string |
hasProofingLicense required | boolean |
isExternal required | boolean |
permissionId required | integer |
defaultRecipientRole required | integer |
isActive | boolean |
isFromSso | boolean |
imsUserId | string |
imsOrgId | string |
{- "referenceId": "string",
- "email": "user@example.com",
- "firstName": "string",
- "lastName": "string",
- "hasProofingLicense": true,
- "isExternal": true,
- "permissionId": 0,
- "defaultRecipientRole": 0,
- "isActive": true,
- "isFromSso": true,
- "imsUserId": "string",
- "imsOrgId": "string"
}
{- "contactToken": "string",
- "email": "string",
- "profileToken": "string",
- "referenceId": "string",
- "apiToken": "string"
}