rest.proofhq.com
Open in
urlscan Pro
44.238.127.102
Public Scan
Submitted URL: http://rest.proofhq.com/
Effective URL: https://rest.proofhq.com/
Submission: On July 08 via manual from MX — Scanned from DE
Effective URL: https://rest.proofhq.com/
Submission: On July 08 via manual from MX — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* Accounts
* getAccounts
* getgetAccount
* getgetAccountLimits
* getgetAccountSettings
* getgetAccountSettingsActions
* getgetAccountSettingsDecisions
* getgetAccountSettingsDecisionsReasons
* getgetAccountMembership
* getgetAccountDevices
* postcreateAccountDevice
* getgetAccountDevice
* deldeleteAccountDevice
* puteditAccountDevice
* getgetAccountDomains
* postcreateAccountDomain
* getgetAccountDomain
* deldeleteAccountDomain
* puteditAccountDomain
* Authorize
* postpostAuthorize
* getgetAuthorizeUser
* getgetLogout
* getgetDecodeUrl
* Basecamp
* getgetBasecampProjects
* getgetBasecampProjectContacts
* getgetBasecampProjectCategories
* getgetBasecampData
* postcreateBaseCampData
* Comments
* getgetProofComments
* postcreateProofComment
* puteditProofComments
* getgetProofComment
* deldeleteProofComment
* puteditProofComment
* postcreateProofCommentAttachments
* getgetProofCommentAttachments
* getgetProofCommentAttachment
* puteditProofCommentAttachment
* deldeleteProofCommentAttachment
* getgetProofCommentAttachmentFile
* getgetProofCommentAttachmentThumbnail
* getgetProofCommentCapture
* postcreateProofCommentCapture
* Contacts
* getgetContacts
* getgetContact
* getgetContactAutocomplete
* Convert
* postcreateConvert
* Crawler
* postcreateCrawl
* Custom Data
* getgetCustomData
* postcreateCustomData
* Email
* getgetEmail
* Error Messages
* getgetErrorMessages
* Folders
* getgetFolders
* postcreateFolder
* getgetFolder
* getgetFolderItems
* getgetFolderBreadcrumbs
* getgetFolderThumbnail
* getgetFolderRecipients
* Health
* getgetHealth
* Proofs
* getgetProofs
* postcreateProof
* getgetProof
* deldeleteProof
* puteditProof
* patchpatchProof
* postcreateProofCopy
* getgetProofActivity
* getgetProofTags
* postcreateProofTag
* getgetProofControls
* getgetProofCustomFields
* getgetProofDecisions
* postcreateNotificationUrls
* postcreateNotificationShare
* getgetProofSettings
* getgetProofSettingsProofing
* getgetProofSourceFiles
* getgetProofThumbnail
* getgetProofUpdates
* postcreateProofTokenUpload
* getgetProofUrls
* getgetProofVersions
* Proof Exports
* getgetProofExportedExcel
* postcreateProofExportRequestPdf
* Proof Token Stages
* getgetProofStages
* postcreateProofStage
* getgetProofStage
* puteditProofStageSettings
* patchpatchProofStageProperties
* getgetProofStageDecisions
* getgetProofStageRecipients
* postcreateProofStageRecipients
* getgetProofStageRecipient
* puteditProofStageRecipient
* Recipients
* getgetProofRecipients
* postcreateProofRecipients
* postcreateProofRecipientSearch
* getgetProofRecipient
* puteditProofRecipient
* deldeleteProofRecipient
* getgetProofRecipientDecision
* puteditProofRecipientDecision
* getgetProofRecipientUrls
* Replies
* getgetProofCommentReplies
* postcreateProofCommentReplies
* puteditProofCommentReplies
* getgetProofCommentReply
* deldeleteProofCommentReply
* puteditProofCommentReply
* postcreateProofCommentReplyAttachment
* getgetProofCommentReplyAttachments
* getgetProofCommentReplyAttachment
* puteditProofCommentReplyAttachment
* deldeleteProofCommentReplyAttachment
* getgetProofCommentReplyAttachmentFile
* getgetProofCommentReplyAttachmentThumbnail
* Settings
* getgetProofLimits
* getgetProofingSettings
* Swagger
* getgetSwaggerJson
* Tags
* getgetTags
* postcreateTag
* getgetTag
* Upload
* postuploadDocument
* Users
* getgetUsers
* getgetUser
* getgetUserAvatar
* Workflow
* getgetWorkflowTemplates
* getgetWorkflowTemplate
* getgetWorkflowTemaplateStages
* getgetWorkflowTemplateStageRecipients
* Workfront User
* getgetWorkfrontUser
* putupdateWorkfrontUser
* deldeleteWorkfrontUser
* postcreateWorkfrontUser
API docs by Redocly
WORKFRONT PROOFHQ REST API (1.0.32)
Download OpenAPI specification:Download
License: proprietary
The API that provides proofing capability to The Workfront.com HUB application.
ACCOUNTS
ACCOUNTS
This is the accounts descriptions
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
trusted
boolean
?trusted={true|false}
RESPONSES
200
TBD
get/accounts
Production US server
https://rest.proofhq.com/api/v1/accounts
Production EU server
https://rest.proofhq.eu/api/v1/accounts
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "parentAccountToken": "string",
* "name": "string",
* "modified": 0
}
]
GETACCOUNT
Account
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "parentAccountToken": "string",
* "name": "string",
* "modified": 0
}
GETACCOUNTLIMITS
Account Limits
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/limits
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/limits
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/limits
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/limits
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/limits
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/limits
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/limits
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/limits
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/limits
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/limits
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "proofs": 0,
* "storage": 0
}
GETACCOUNTSETTINGS
Account Settings
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/settings
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/settings
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/settings
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/settings
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/settings
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/settings
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/settings
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/settings
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/settings
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/settings
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "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
}
GETACCOUNTSETTINGSACTIONS
Account Actions
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/settings/actions
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/settings/actions
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/settings/actions
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/settings/actions
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/settings/actions
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/settings/actions
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/settings/actions
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/settings/actions
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/settings/actions
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/settings/actions
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string"
}
]
GETACCOUNTSETTINGSDECISIONS
Account Decisions
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/settings/decisions
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/settings/decisions
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/settings/decisions
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/settings/decisions
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/settings/decisions
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/settings/decisions
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/settings/decisions
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/settings/decisions
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/settings/decisions
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/settings/decisions
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "displayName": "string",
* "isEnabled": true,
* "hasReasons": true,
* "hasPostMessage": true
}
]
GETACCOUNTSETTINGSDECISIONSREASONS
Account Decision Reasons
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/settings/decisionreasons
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/settings/decisionreasons
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/settings/decisionreasons
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/settings/decisionreasons
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/settings/decisionreasons
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/settings/decisionreasons
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/settings/decisionreasons
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/settings/decisionreasons
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/settings/decisionreasons
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/settings/decisionreasons
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "hasText": true,
* "reasonText": "string"
}
]
GETACCOUNTMEMBERSHIP
Account Membership
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/membership
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/membership
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/membership
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/membership
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/membership
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/membership
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/membership
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/membership
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/membership
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/membership
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "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
}
GETACCOUNTDEVICES
Account Devices
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/devices
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/devices
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/devices
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/devices
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/devices
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/devices
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/devices
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/devices
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/devices
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/devices
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "userAgent": "string",
* "accountToken": "string",
* "width": 0,
* "height": 0,
* "ratio": 0,
* "type": 0,
* "position": 0,
* "isDisabled": true,
* "isDefault": true
}
]
CREATEACCOUNTDEVICE
Account Device
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
REQUEST BODY SCHEMA: APPLICATION/JSON
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
RESPONSES
200
TBD
post/accounts/{token}/devices
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/devices
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/devices
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/devices
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/devices
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/devices
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/devices
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/devices
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/devices
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/devices
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string",
* "width": 0,
* "height": 0,
* "type": 1,
* "ratio": 0,
* "userAgent": "string",
* "isDisabled": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "userAgent": "string",
* "accountToken": "string",
* "width": 0,
* "height": 0,
* "ratio": 0,
* "type": 0,
* "position": 0,
* "isDisabled": true,
* "isDefault": true
}
]
GETACCOUNTDEVICE
Account Device
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
token1
required
string
Device Token
RESPONSES
200
TBD
get/accounts/{token}/devices/{token1}
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/devices/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/devices/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "name": "string",
* "userAgent": "string",
* "accountToken": "string",
* "width": 0,
* "height": 0,
* "ratio": 0,
* "type": 0,
* "position": 0,
* "isDisabled": true,
* "isDefault": true
}
DELETEACCOUNTDEVICE
Account Device
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
token1
required
string
Device Token
RESPONSES
200
TBD
delete/accounts/{token}/devices/{token1}
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/devices/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/devices/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
EDITACCOUNTDEVICE
Account Device
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
token1
required
string
Device Token
REQUEST BODY SCHEMA: APPLICATION/JSON
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
RESPONSES
200
TBD
put/accounts/{token}/devices/{token1}
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/devices/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/devices/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/devices/{token1}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string",
* "width": 0,
* "height": 0,
* "type": 1,
* "ratio": 0,
* "userAgent": "string",
* "isDisabled": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "userAgent": "string",
* "accountToken": "string",
* "width": 0,
* "height": 0,
* "ratio": 0,
* "type": 0,
* "position": 0,
* "isDisabled": true,
* "isDefault": true
}
]
GETACCOUNTDOMAINS
Account Domains
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
RESPONSES
200
TBD
get/accounts/{token}/domains
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/domains
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/domains
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/domains
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/domains
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/domains
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/domains
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/domains
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/domains
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/domains
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "type": 1,
* "domain": "string",
* "subdomain": "string",
* "path": "string",
* "modified": 0
}
]
CREATEACCOUNTDOMAIN
Account Domain
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
REQUEST BODY SCHEMA: APPLICATION/JSON
type
required
any
Enum: 1 2 3
domain
required
string non-empty
subdomain
string or null
path
string or null
RESPONSES
200
TBD
post/accounts/{token}/domains
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/domains
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/domains
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/domains
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/domains
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/domains
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/domains
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/domains
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/domains
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/domains
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "type": 1,
* "domain": "string",
* "subdomain": "string",
* "path": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "type": 1,
* "domain": "string",
* "subdomain": "string",
* "path": "string",
* "modified": 0
}
GETACCOUNTDOMAIN
Account Domain
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
token1
required
string
Domain Token
RESPONSES
200
TBD
get/accounts/{token}/domains/{token1}
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/domains/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/domains/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "type": 1,
* "domain": "string",
* "subdomain": "string",
* "path": "string",
* "modified": 0
}
DELETEACCOUNTDOMAIN
Account Domain
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
token1
required
string
Domain Token
RESPONSES
200
TBD
delete/accounts/{token}/domains/{token1}
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/domains/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/domains/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
EDITACCOUNTDOMAIN
Account Domain
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Account Token
token1
required
string
Domain Token
REQUEST BODY SCHEMA: APPLICATION/JSON
type
any
Enum: 1 2 3
domain
string non-empty
subdomain
string or null
path
string or null
RESPONSES
200
TBD
put/accounts/{token}/domains/{token1}
Production US server
https://rest.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/accounts/{token}/domains/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/accounts/{token}/domains/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/accounts/{token}/domains/{token1}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "type": 1,
* "domain": "string",
* "subdomain": "string",
* "path": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "type": 1,
* "domain": "string",
* "subdomain": "string",
* "path": "string",
* "modified": 0
}
AUTHORIZE
POSTAUTHORIZE
Authorize
REQUEST BODY SCHEMA: APPLICATION/JSON
One of
Schema for POST on AUTHORIZE (apikey context)Schema for POST on AUTHORIZE
(token, sessionId)Schema for POST on AUTHORIZE (guest context)Schema for POST on
AUTHORIZE (recipient context)Schema for POST on AUTHORIZE (soap context)Schema
for POST on AUTHORIZE (user context)Schema for POST on AUTHORIZE
(wfServiceToken, email, token)
email
required
string
authtoken
required
string
RESPONSES
200
TBD
post/authorize
Production US server
https://rest.proofhq.com/api/v1/authorize
Production EU server
https://rest.proofhq.eu/api/v1/authorize
Preview US server
https://rest.preview.proofhq.com/api/v1/authorize
Preview EU server
https://rest.preview.proofhq.eu/api/v1/authorize
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/authorize
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/authorize
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/authorize
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/authorize
Devbox server
https://rest.local.int.proofhq.com/api/v1/authorize
REQUEST SAMPLES
* Payload
Content type
application/json
Example
Schema for POST on AUTHORIZE (apikey context)Schema for POST on AUTHORIZE
(token, sessionId)Schema for POST on AUTHORIZE (guest context)Schema for POST on
AUTHORIZE (recipient context)Schema for POST on AUTHORIZE (soap context)Schema
for POST on AUTHORIZE (user context)Schema for POST on AUTHORIZE
(wfServiceToken, email, token)Schema for POST on AUTHORIZE (apikey context)
Copy
{
* "email": "string",
* "authtoken": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "sessionId": "string"
}
GETAUTHORIZEUSER
Authorize User
AUTHORIZATIONS:
SessionIdAuthJwtAuth
RESPONSES
200
TBD
get/authorize/user
Production US server
https://rest.proofhq.com/api/v1/authorize/user
Production EU server
https://rest.proofhq.eu/api/v1/authorize/user
Preview US server
https://rest.preview.proofhq.com/api/v1/authorize/user
Preview EU server
https://rest.preview.proofhq.eu/api/v1/authorize/user
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/authorize/user
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/authorize/user
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/authorize/user
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/authorize/user
Devbox server
https://rest.local.int.proofhq.com/api/v1/authorize/user
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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"
}
GETLOGOUT
Logout
AUTHORIZATIONS:
SessionIdAuthJwtAuth
RESPONSES
200
TBD
get/logout
Production US server
https://rest.proofhq.com/api/v1/logout
Production EU server
https://rest.proofhq.eu/api/v1/logout
Preview US server
https://rest.preview.proofhq.com/api/v1/logout
Preview EU server
https://rest.preview.proofhq.eu/api/v1/logout
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/logout
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/logout
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/logout
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/logout
Devbox server
https://rest.local.int.proofhq.com/api/v1/logout
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
GETDECODEURL
Decode Url
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
url
required
string
?url={url}
compare
string
?compare={compare}
RESPONSES
200
TBD
get/decode/url
Production US server
https://rest.proofhq.com/api/v1/decode/url
Production EU server
https://rest.proofhq.eu/api/v1/decode/url
Preview US server
https://rest.preview.proofhq.com/api/v1/decode/url
Preview EU server
https://rest.preview.proofhq.eu/api/v1/decode/url
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/decode/url
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/decode/url
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/decode/url
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/decode/url
Devbox server
https://rest.local.int.proofhq.com/api/v1/decode/url
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "code": "string",
* "compareToken": "string",
* "codeToCompare": "string"
}
BASECAMP
GETBASECAMPPROJECTS
Basecamp Projects
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
refresh
boolean
?refresh={true}
RESPONSES
200
TBD
get/basecamp/projects
Production US server
https://rest.proofhq.com/api/v1/basecamp/projects
Production EU server
https://rest.proofhq.eu/api/v1/basecamp/projects
Preview US server
https://rest.preview.proofhq.com/api/v1/basecamp/projects
Preview EU server
https://rest.preview.proofhq.eu/api/v1/basecamp/projects
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/basecamp/projects
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/basecamp/projects
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/basecamp/projects
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/basecamp/projects
Devbox server
https://rest.local.int.proofhq.com/api/v1/basecamp/projects
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": 0,
* "name": "string"
}
]
GETBASECAMPPROJECTCONTACTS
Basecamp Project Contacts
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
id
required
integer
Basecamp Project ID
QUERY PARAMETERS
refresh
boolean
?refresh={true}
RESPONSES
200
TBD
get/basecamp/projects/{id}/contacts
Production US server
https://rest.proofhq.com/api/v1/basecamp/projects/{id}/contacts
Production EU server
https://rest.proofhq.eu/api/v1/basecamp/projects/{id}/contacts
Preview US server
https://rest.preview.proofhq.com/api/v1/basecamp/projects/{id}/contacts
Preview EU server
https://rest.preview.proofhq.eu/api/v1/basecamp/projects/{id}/contacts
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/basecamp/projects/{id}/contacts
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/basecamp/projects/{id}/contacts
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/basecamp/projects/{id}/contacts
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/basecamp/projects/{id}/contacts
Devbox server
https://rest.local.int.proofhq.com/api/v1/basecamp/projects/{id}/contacts
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": 0,
* "name": "string",
* "email": "string",
* "company": "string",
* "isUser": true
}
]
GETBASECAMPPROJECTCATEGORIES
Basecamp Project Categories
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
id
required
integer
Basecamp Project ID
RESPONSES
200
TBD
get/basecamp/projects/{id}/categories
Production US server
https://rest.proofhq.com/api/v1/basecamp/projects/{id}/categories
Production EU server
https://rest.proofhq.eu/api/v1/basecamp/projects/{id}/categories
Preview US server
https://rest.preview.proofhq.com/api/v1/basecamp/projects/{id}/categories
Preview EU server
https://rest.preview.proofhq.eu/api/v1/basecamp/projects/{id}/categories
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/basecamp/projects/{id}/categories
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/basecamp/projects/{id}/categories
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/basecamp/projects/{id}/categories
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/basecamp/projects/{id}/categories
Devbox server
https://rest.local.int.proofhq.com/api/v1/basecamp/projects/{id}/categories
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": 0,
* "name": "string"
}
]
GETBASECAMPDATA
Basecamp Data
AUTHORIZATIONS:
SessionIdAuthJwtAuth
RESPONSES
200
TBD
get/basecamp/data
Production US server
https://rest.proofhq.com/api/v1/basecamp/data
Production EU server
https://rest.proofhq.eu/api/v1/basecamp/data
Preview US server
https://rest.preview.proofhq.com/api/v1/basecamp/data
Preview EU server
https://rest.preview.proofhq.eu/api/v1/basecamp/data
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/basecamp/data
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/basecamp/data
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/basecamp/data
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/basecamp/data
Devbox server
https://rest.local.int.proofhq.com/api/v1/basecamp/data
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "basecampActivated": true,
* "basecampVersion": 0,
* "integrationType": 0,
* "projectId": 0,
* "messageCategoryId": 0,
* "isPrivate": true,
* "defaultStagePosition": 0,
* "defaultDueDate": 0,
* "recipients": [
* {
* "email": "string",
* "dueDate": 0,
* "stagePosition": 0
}
]
}
CREATEBASECAMPDATA
Basecamp Data
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA: APPLICATION/JSON
proofToken
required
string
projectId
required
number
messageCategoryId
number or null
private
boolean or null
defaultDueDate
number or null
defaultStagePosition
number or null
recipients
required
Array of objects
RESPONSES
200
TBD
post/basecamp/data
Production US server
https://rest.proofhq.com/api/v1/basecamp/data
Production EU server
https://rest.proofhq.eu/api/v1/basecamp/data
Preview US server
https://rest.preview.proofhq.com/api/v1/basecamp/data
Preview EU server
https://rest.preview.proofhq.eu/api/v1/basecamp/data
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/basecamp/data
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/basecamp/data
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/basecamp/data
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/basecamp/data
Devbox server
https://rest.local.int.proofhq.com/api/v1/basecamp/data
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "proofToken": "string",
* "projectId": 0,
* "messageCategoryId": 0,
* "private": true,
* "defaultDueDate": 0,
* "defaultStagePosition": 0,
* "recipients": [
* {
* "email": "string",
* "dueDate": 0,
* "stagePosition": 0
}
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "basecampActivated": true,
* "basecampVersion": 0,
* "integrationType": 0,
* "projectId": 0,
* "messageCategoryId": 0,
* "isPrivate": true,
* "defaultStagePosition": 0,
* "defaultDueDate": 0,
* "recipients": [
* {
* "email": "string",
* "dueDate": 0,
* "stagePosition": 0
}
]
}
COMMENTS
GETPROOFCOMMENTS
Proof Comments
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
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
RESPONSES
200
TBD
get/proofs/{token}/comments
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
}
]
CREATEPROOFCOMMENT
Proof Comments
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
Any of
Schema for POST on COMMENTSchema for POST on COMMENT
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
RESPONSES
200
TBD
post/proofs/{token}/comments
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "text": "string",
* "drawings": [
* { }
],
* "metadata": { },
* "textDirection": 0,
* "pins": { },
* "page": 0,
* "pages": 0,
* "timestampBegin": 0,
* "timestampEnd": 0,
* "layout": 0,
* "isLocked": true,
* "actionToken": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
]
}
EDITPROOFCOMMENTS
Proof Comments
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
Array
token
required
string
isRead
boolean
RESPONSES
200
TBD
put/proofs/{token}/comments
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "isRead": true
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
]
}
GETPROOFCOMMENT
Proof Comment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
]
}
DELETEPROOFCOMMENT
Proof Comment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
RESPONSES
200
TBD
delete/proofs/{token}/comments/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
EDITPROOFCOMMENT
Proof Comment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
REQUEST BODY SCHEMA: APPLICATION/JSON
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
RESPONSES
200
TBD
put/proofs/{token}/comments/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "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"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
]
}
CREATEPROOFCOMMENTATTACHMENTS
Proof Comment Attachments
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
REQUEST BODY SCHEMA: APPLICATION/JSON
assetId
required
string non-empty
name
string or null
RESPONSES
200
TBD
post/proofs/{token}/comments/{token1}/attachments
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "assetId": "string",
* "name": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
GETPROOFCOMMENTATTACHMENTS
Proof Comment Attachments
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}/attachments
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
]
GETPROOFCOMMENTATTACHMENT
Proof Comment Attachment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Attachment Token
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}/attachments/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
EDITPROOFCOMMENTATTACHMENT
Proof Comment Attachment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Attachment Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
string or null
RESPONSES
200
TBD
put/proofs/{token}/comments/{token1}/attachments/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
DELETEPROOFCOMMENTATTACHMENT
Proof Comment Attachment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Attachment Token
RESPONSES
200
TBD
delete/proofs/{token}/comments/{token1}/attachments/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
GETPROOFCOMMENTATTACHMENTFILE
Proof Comment Attachment File
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Description Token
QUERY PARAMETERS
download
boolean
?download=true
RESPONSES
302
TDB
get/proofs/{token}/comments/{token1}/attachments/{token2}/file
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/file
GETPROOFCOMMENTATTACHMENTTHUMBNAIL
Proof Comment Attachment Thumbnail
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Attachment Token
RESPONSES
302
TDB
get/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/attachments/{token2}/thumbnail
GETPROOFCOMMENTCAPTURE
Proof Comment Capture
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}/capture
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/capture
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/capture
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
CREATEPROOFCOMMENTCAPTURE
Proof Comment Capture
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
RESPONSES
200
TBD
post/proofs/{token}/comments/{token1}/capture
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/capture
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/capture
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/capture
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
CONTACTS
GETCONTACTS
Contacts
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
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
RESPONSES
200
TBD
get/contacts
Production US server
https://rest.proofhq.com/api/v1/contacts
Production EU server
https://rest.proofhq.eu/api/v1/contacts
Preview US server
https://rest.preview.proofhq.com/api/v1/contacts
Preview EU server
https://rest.preview.proofhq.eu/api/v1/contacts
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/contacts
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/contacts
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/contacts
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/contacts
Devbox server
https://rest.local.int.proofhq.com/api/v1/contacts
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
GETCONTACT
Contact
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Contact Token
RESPONSES
200
TBD
get/contacts/{token}
Production US server
https://rest.proofhq.com/api/v1/contacts/{token}
Production EU server
https://rest.proofhq.eu/api/v1/contacts/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/contacts/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/contacts/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/contacts/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/contacts/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/contacts/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/contacts/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/contacts/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
GETCONTACTAUTOCOMPLETE
Contact Autocomplete
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
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}
RESPONSES
200
TBD
get/contacts/autocomplete
Production US server
https://rest.proofhq.com/api/v1/contacts/autocomplete
Production EU server
https://rest.proofhq.eu/api/v1/contacts/autocomplete
Preview US server
https://rest.preview.proofhq.com/api/v1/contacts/autocomplete
Preview EU server
https://rest.preview.proofhq.eu/api/v1/contacts/autocomplete
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/contacts/autocomplete
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/contacts/autocomplete
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/contacts/autocomplete
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/contacts/autocomplete
Devbox server
https://rest.local.int.proofhq.com/api/v1/contacts/autocomplete
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "contacts": [
* {
* "token": "string",
* "name": "string",
* "email": "string",
* "profileToken": "string"
}
],
* "groups": [
* {
* "token": "string",
* "name": "string"
}
],
* "accounts": [
* {
* "token": "string",
* "name": "string"
}
]
}
CONVERT
CREATECONVERT
Convert
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA: APPLICATION/JSON
Array
One of
Schema for POST on CONVERTSchema for POST on CONVERT
object
required
string
Enum: "proof" "account"
token
required
string
id
integer
RESPONSES
200
TBD
post/convert
Production US server
https://rest.proofhq.com/api/v1/convert
Production EU server
https://rest.proofhq.eu/api/v1/convert
Preview US server
https://rest.preview.proofhq.com/api/v1/convert
Preview EU server
https://rest.preview.proofhq.eu/api/v1/convert
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/convert
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/convert
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/convert
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/convert
Devbox server
https://rest.local.int.proofhq.com/api/v1/convert
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "object": "proof",
* "token": "string",
* "id": 0
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "object": "proof",
* "token": "string",
* "id": 0
}
]
CRAWLER
CREATECRAWL
Crawl
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA: APPLICATION/JSON
url
required
string
limit
integer or null > 0
exceptions
Array of strings or null
RESPONSES
200
TBD
post/crawler
Production US server
https://rest.proofhq.com/api/v1/crawler
Production EU server
https://rest.proofhq.eu/api/v1/crawler
Preview US server
https://rest.preview.proofhq.com/api/v1/crawler
Preview EU server
https://rest.preview.proofhq.eu/api/v1/crawler
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/crawler
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/crawler
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/crawler
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/crawler
Devbox server
https://rest.local.int.proofhq.com/api/v1/crawler
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "url": "string",
* "limit": 0,
* "exceptions": [
* "string"
]
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "pages": [
* {
* "url": "string",
* "label": "string",
* "hash": "string"
}
],
* "metadata": {
* "pageLeftCount": 0
}
}
CUSTOM DATA
GETCUSTOMDATA
Custom Data
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
proof
string
?proof={token}
RESPONSES
200
TBD
get/customdata
Production US server
https://rest.proofhq.com/api/v1/customdata
Production EU server
https://rest.proofhq.eu/api/v1/customdata
Preview US server
https://rest.preview.proofhq.com/api/v1/customdata
Preview EU server
https://rest.preview.proofhq.eu/api/v1/customdata
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/customdata
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/customdata
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/customdata
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/customdata
Devbox server
https://rest.local.int.proofhq.com/api/v1/customdata
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
}
]
CREATECUSTOMDATA
Custom Data
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA: APPLICATION/JSON
Array
token
required
string
name
required
string
order
required
number
fields
required
Array of objects (Schema for an array of CUSTOMDATA FIELD)
RESPONSES
200
TBD
post/customdata
Production US server
https://rest.proofhq.com/api/v1/customdata
Production EU server
https://rest.proofhq.eu/api/v1/customdata
Preview US server
https://rest.preview.proofhq.com/api/v1/customdata
Preview EU server
https://rest.preview.proofhq.eu/api/v1/customdata
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/customdata
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/customdata
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/customdata
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/customdata
Devbox server
https://rest.local.int.proofhq.com/api/v1/customdata
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
}
]
EMAIL
GETEMAIL
Email
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
email
required
string
Email Address
RESPONSES
200
TBD
get/email/{email}
Production US server
https://rest.proofhq.com/api/v1/email/{email}
Production EU server
https://rest.proofhq.eu/api/v1/email/{email}
Preview US server
https://rest.preview.proofhq.com/api/v1/email/{email}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/email/{email}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/email/{email}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/email/{email}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/email/{email}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/email/{email}
Devbox server
https://rest.local.int.proofhq.com/api/v1/email/{email}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "firstName": "string",
* "lastName": "string",
* "email": "string",
* "type": 0,
* "mailingLevel": 0,
* "defaultRole": 0,
* "isFromPartnerOrganization": true
}
ERROR MESSAGES
GETERRORMESSAGES
Error Messages
RESPONSES
200
TBD
get/error-messages
Production US server
https://rest.proofhq.com/api/v1/error-messages
Production EU server
https://rest.proofhq.eu/api/v1/error-messages
Preview US server
https://rest.preview.proofhq.com/api/v1/error-messages
Preview EU server
https://rest.preview.proofhq.eu/api/v1/error-messages
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/error-messages
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/error-messages
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/error-messages
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/error-messages
Devbox server
https://rest.local.int.proofhq.com/api/v1/error-messages
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
[
* "string"
]
FOLDERS
GETFOLDERS
Folders
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
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
RESPONSES
200
TBD
get/folders
Production US server
https://rest.proofhq.com/api/v1/folders
Production EU server
https://rest.proofhq.eu/api/v1/folders
Preview US server
https://rest.preview.proofhq.com/api/v1/folders
Preview EU server
https://rest.preview.proofhq.eu/api/v1/folders
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/folders
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/folders
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/folders
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/folders
Devbox server
https://rest.local.int.proofhq.com/api/v1/folders
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "description": "string",
* "itemsCount": 0,
* "subfoldersCount": 0,
* "level": 0,
* "parentFolderToken": "string",
* "canCreateFolders": true
}
]
CREATEFOLDER
Folder
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA: APPLICATION/JSON
Array (non-empty)
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}$
RESPONSES
200
TBD
post/folders
Production US server
https://rest.proofhq.com/api/v1/folders
Production EU server
https://rest.proofhq.eu/api/v1/folders
Preview US server
https://rest.preview.proofhq.com/api/v1/folders
Preview EU server
https://rest.preview.proofhq.eu/api/v1/folders
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/folders
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/folders
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/folders
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/folders
Devbox server
https://rest.local.int.proofhq.com/api/v1/folders
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "parentFolderToken": "string",
* "name": "string",
* "description": "string",
* "client": "string",
* "project": "string",
* "personal": true,
* "ownerToken": "string"
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "description": "string",
* "itemsCount": 0,
* "subfoldersCount": 0,
* "level": 0,
* "parentFolderToken": "string",
* "canCreateFolders": true
}
]
GETFOLDER
Folder
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Folder Token
RESPONSES
200
TBD
get/folders/{token}
Production US server
https://rest.proofhq.com/api/v1/folders/{token}
Production EU server
https://rest.proofhq.eu/api/v1/folders/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/folders/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/folders/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/folders/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/folders/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/folders/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/folders/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/folders/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "name": "string",
* "description": "string",
* "itemsCount": 0,
* "subfoldersCount": 0,
* "level": 0,
* "parentFolderToken": "string",
* "canCreateFolders": true
}
GETFOLDERITEMS
Folder Items
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Folder Token
QUERY PARAMETERS
display
string
?display={proofs|files}
offset
integer
?offset=N
limit
integer
?limit=N (max 200)
RESPONSES
200
TBD
get/folders/{token}/items
Production US server
https://rest.proofhq.com/api/v1/folders/{token}/items
Production EU server
https://rest.proofhq.eu/api/v1/folders/{token}/items
Preview US server
https://rest.preview.proofhq.com/api/v1/folders/{token}/items
Preview EU server
https://rest.preview.proofhq.eu/api/v1/folders/{token}/items
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/folders/{token}/items
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/folders/{token}/items
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/folders/{token}/items
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/folders/{token}/items
Devbox server
https://rest.local.int.proofhq.com/api/v1/folders/{token}/items
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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"
}
]
GETFOLDERBREADCRUMBS
Folder Breadcrumbs
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Folder Token
RESPONSES
200
TBD
get/folders/{token}/crumbs
Production US server
https://rest.proofhq.com/api/v1/folders/{token}/crumbs
Production EU server
https://rest.proofhq.eu/api/v1/folders/{token}/crumbs
Preview US server
https://rest.preview.proofhq.com/api/v1/folders/{token}/crumbs
Preview EU server
https://rest.preview.proofhq.eu/api/v1/folders/{token}/crumbs
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/folders/{token}/crumbs
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/folders/{token}/crumbs
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/folders/{token}/crumbs
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/folders/{token}/crumbs
Devbox server
https://rest.local.int.proofhq.com/api/v1/folders/{token}/crumbs
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "isAccessible": true
}
]
GETFOLDERTHUMBNAIL
Folder Thumbnail
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Folder Token
RESPONSES
200
TBD
get/folders/{token}/thumbnail
Production US server
https://rest.proofhq.com/api/v1/folders/{token}/thumbnail
Production EU server
https://rest.proofhq.eu/api/v1/folders/{token}/thumbnail
Preview US server
https://rest.preview.proofhq.com/api/v1/folders/{token}/thumbnail
Preview EU server
https://rest.preview.proofhq.eu/api/v1/folders/{token}/thumbnail
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/folders/{token}/thumbnail
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/folders/{token}/thumbnail
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/folders/{token}/thumbnail
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/folders/{token}/thumbnail
Devbox server
https://rest.local.int.proofhq.com/api/v1/folders/{token}/thumbnail
GETFOLDERRECIPIENTS
Folder Recipients
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Folder Token
QUERY PARAMETERS
offset
integer
?offset={offset}
limit
integer
?limit={limit} (max 1000)
RESPONSES
200
TBD
get/folders/{token}/recipients
Production US server
https://rest.proofhq.com/api/v1/folders/{token}/recipients
Production EU server
https://rest.proofhq.eu/api/v1/folders/{token}/recipients
Preview US server
https://rest.preview.proofhq.com/api/v1/folders/{token}/recipients
Preview EU server
https://rest.preview.proofhq.eu/api/v1/folders/{token}/recipients
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/folders/{token}/recipients
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/folders/{token}/recipients
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/folders/{token}/recipients
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/folders/{token}/recipients
Devbox server
https://rest.local.int.proofhq.com/api/v1/folders/{token}/recipients
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "userToken": "string",
* "name": "string",
* "email": "string",
* "company": "string",
* "role": 0
}
]
HEALTH
GETHEALTH
Health
RESPONSES
200
TBD
get/health
Production US server
https://rest.proofhq.com/api/v1/health
Production EU server
https://rest.proofhq.eu/api/v1/health
Preview US server
https://rest.preview.proofhq.com/api/v1/health
Preview EU server
https://rest.preview.proofhq.eu/api/v1/health
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/health
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/health
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/health
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/health
Devbox server
https://rest.local.int.proofhq.com/api/v1/health
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
PROOFS
GETPROOFS
Proofs
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
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}
email
string
?email=someone@example.net
disable_source
string
?disable_source={lucene|database|legacy_lucene}
limit
integer
?limit=N (max 100)
offset
integer
?offset=N
RESPONSES
200
TBD
get/proofs
Production US server
https://rest.proofhq.com/api/v1/proofs
Production EU server
https://rest.proofhq.eu/api/v1/proofs
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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",
* "creatorUserName": "string",
* "creatorUserToken": "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",
* "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",
* "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
}
}
]
}
]
CREATEPROOF
Proofs
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA: APPLICATION/JSON
Array
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}$
referenceId
(integer or null) or (string or null)
stages
Array of objects or null (Schema for an array of POST on STAGE)
sourceFiles
Array of objects
customfields
Array of objects or null
templates
Array of objects or null
RESPONSES
200
TBD
post/proofs
Production US server
https://rest.proofhq.com/api/v1/proofs
Production EU server
https://rest.proofhq.eu/api/v1/proofs
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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"
}
]
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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",
* "creatorUserName": "string",
* "creatorUserToken": "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",
* "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",
* "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
}
}
]
}
]
GETPROOF
Proof
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
fields
string
?fields=templates
RESPONSES
200
TBD
get/proofs/{token}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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",
* "creatorUserName": "string",
* "creatorUserToken": "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",
* "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",
* "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
}
}
]
}
DELETEPROOF
Proof
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
delete/proofs/{token}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
EDITPROOF
Proof
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
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
RESPONSES
200
TBD
put/proofs/{token}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "state": 0,
* "ownerUserToken": "string",
* "hasSelfClose": true,
* "isLoginRequired": true,
* "isOneApproval": true,
* "hasElectronicSignatures": true,
* "canDownload": true,
* "hasPublicSharing": true,
* "hasSubscription": true,
* "defaultNotifications": 1,
* "defaultRole": 1,
* "subscriptionNotification": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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",
* "creatorUserName": "string",
* "creatorUserToken": "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",
* "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",
* "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
}
}
]
}
PATCHPROOF
Proof
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
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)
RESPONSES
200
TBD
patch/proofs/{token}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string",
* "state": 0,
* "isArchived": true,
* "ownerUserToken": "string",
* "subject": "string",
* "message": "string",
* "isAutomatedWorkflow": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
CREATEPROOFCOPY
Proof Copy
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
uploadHash
required
string
sourceName
string or null
name
string or null
referenceId
(integer or null) or (string or null)
newVersion
boolean or null
Creates copy as new version
RESPONSES
200
TBD
post/proofs/{token}/copy
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/copy
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/copy
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/copy
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/copy
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/copy
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/copy
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/copy
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/copy
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/copy
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "uploadHash": "string",
* "sourceName": "string",
* "name": "string",
* "referenceId": 0,
* "newVersion": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "file_id": 0,
* "token": "string"
}
GETPROOFACTIVITY
Proof Activity
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
limit
integer
?limit=N (max 200)
offset
integer
?offset=N
RESPONSES
200
TBD
get/proofs/{token}/activity
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/activity
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/activity
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/activity
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/activity
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/activity
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/activity
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/activity
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/activity
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/activity
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "created": 0,
* "person": "string",
* "action": 0,
* "actionLabel": "string",
* "detailsPhrase": "string",
* "detailsParams": [
* "string"
]
}
]
GETPROOFTAGS
Proof Tags
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
sortBy
string
?sortBy={name|created}
order
string
?order={asc|desc}
limit
integer
?limit=N (max 1000)
offset
integer
?offset=N
RESPONSES
200
TBD
get/proofs/{token}/tags
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/tags
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/tags
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/tags
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/tags
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/tags
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/tags
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/tags
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/tags
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/tags
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "usage": 0,
* "created": 0,
* "modified": 0,
* "permissions": {
* "edit": true,
* "delete": true
}
}
]
CREATEPROOFTAG
Proof Tags
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
Array (non-empty)
token
required
string^[a-zA-Z0-9\-]{30,120}$
RESPONSES
200
TBD
post/proofs/{token}/tags
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/tags
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/tags
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/tags
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/tags
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/tags
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/tags
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/tags
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/tags
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/tags
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string"
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "usage": 0,
* "created": 0,
* "modified": 0,
* "permissions": {
* "edit": true,
* "delete": true
}
}
]
GETPROOFCONTROLS
Proof Controls
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/controls
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/controls
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/controls
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/controls
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/controls
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/controls
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/controls
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/controls
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/controls
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/controls
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
GETPROOFCUSTOMFIELDS
Proof Custom Fields
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/customfields
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/customfields
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/customfields
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/customfields
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/customfields
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/customfields
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/customfields
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/customfields
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/customfields
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/customfields
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "id": "string",
* "name": "string",
* "items": [
* {
* "id": "string",
* "type": "string",
* "label": "string",
* "value": "string",
* "disabled": true
}
]
}
]
GETPROOFDECISIONS
Proof Decisions
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/decision
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/decision
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/decision
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/decision
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/decision
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/decision
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/decision
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/decision
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/decision
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/decision
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "decision": 0,
* "name": "string",
* "displayName": "string",
* "isSignedDecision": true,
* "decisionAt": 0,
* "hasReasons": true,
* "reasons": [
* {
* "token": "string",
* "name": "string",
* "hasText": true,
* "reasonText": "string"
}
]
}
CREATENOTIFICATIONURLS
Method allows to send email notifications with proof team or download links.
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
send_download_url
required
boolean
send_team_url
required
boolean
emails
required
Array of strings <email> non-empty
List of recipients emails
message_subject
string or null
message_body
string or null
RESPONSES
200
TBD
post/proofs/{token}/notifications/urls
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/notifications/urls
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/notifications/urls
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/notifications/urls
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/notifications/urls
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/notifications/urls
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/notifications/urls
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/notifications/urls
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/notifications/urls
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/notifications/urls
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "send_download_url": true,
* "send_team_url": true,
* "emails": [
* "user@example.com"
],
* "message_subject": "string",
* "message_body": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
CREATENOTIFICATIONSHARE
Method allows to send email notifications to recipients that proof was shared.
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
recipients
required
Array of strings non-empty
List of recipients tokens
messageSubject
required
string
messageBody
required
string
RESPONSES
200
TBD
post/proofs/{token}/notifications/share
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/notifications/share
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/notifications/share
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/notifications/share
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/notifications/share
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/notifications/share
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/notifications/share
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/notifications/share
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/notifications/share
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/notifications/share
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "recipients": [
* "string"
],
* "messageSubject": "string",
* "messageBody": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
GETPROOFSETTINGS
Proof Settings
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/settings
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/settings
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/settings
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/settings
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/settings
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/settings
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/settings
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/settings
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/settings
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/settings
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "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"
}
GETPROOFSETTINGSPROOFING
Proof Settings Proofing
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/settings/proofing
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/settings/proofing
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/settings/proofing
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/settings/proofing
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/settings/proofing
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/settings/proofing
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/settings/proofing
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/settings/proofing
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/settings/proofing
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/settings/proofing
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "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
}
GETPROOFSOURCEFILES
Proof Source Files
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/sourcefiles
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/sourcefiles
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/sourcefiles
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/sourcefiles
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/sourcefiles
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/sourcefiles
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/sourcefiles
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/sourcefiles
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/sourcefiles
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/sourcefiles
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "name": "string",
* "size": 0,
* "mime": "string",
* "pagesFrom": 0,
* "pagesTo": 0,
* "resolutionLabel": "string"
}
]
GETPROOFTHUMBNAIL
Proof Thumbnail
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/thumbnail
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/thumbnail
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/thumbnail
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/thumbnail
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/thumbnail
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/thumbnail
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/thumbnail
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/thumbnail
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/thumbnail
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/thumbnail
GETPROOFUPDATES
Proof Updates
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/update
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/update
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/update
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/update
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/update
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/update
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/update
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/update
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/update
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/update
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "sender": "string",
* "action": "created",
* "type": "comment",
* "token": "string"
}
]
CREATEPROOFTOKENUPLOAD
Proof Token Upload
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
post/proofs/{token}/upload
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/upload
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/upload
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/upload
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/upload
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/upload
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/upload
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/upload
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/upload
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/upload
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "url": "string",
* "thumbnailUrl": "string"
}
GETPROOFURLS
Proof Urls
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
RESPONSES
200
TBD
get/proofs/{token}/urls
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/urls
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/urls
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/urls
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/urls
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/urls
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/urls
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/urls
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/urls
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/urls
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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"
}
GETPROOFVERSIONS
Proof Versions
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
strict
string
?strict=true
processed_only
boolean
?processed_only=false
RESPONSES
200
TBD
get/proofs/{token}/versions
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/versions
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/versions
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/versions
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/versions
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/versions
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/versions
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/versions
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/versions
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/versions
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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",
* "creatorUserName": "string",
* "creatorUserToken": "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",
* "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",
* "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
}
}
]
}
]
PROOF EXPORTS
GETPROOFEXPORTEDEXCEL
Proof Exported Excel
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
allVersions
boolean
?allVersions=true
authors
string
?authors={recipientToken1},...,{recipientTokenN}
actions
string
?actions={actionToken1},...,{actionTokenN}
hideResolved
boolean
?hideResolved=true
RESPONSES
200
TBD
get/proofs/{token}/export/excel
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/export/excel
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/export/excel
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/export/excel
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/export/excel
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/export/excel
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/export/excel
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/export/excel
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/export/excel
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/export/excel
CREATEPROOFEXPORTREQUESTPDF
Proof Export Request PDF
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
allVersions
string
true|false
hideResolved
string
true|false
actions
string
CSV of action tokens + unactioned keyword
authors
string
CSV of recipients tokens
RESPONSES
200
TBD
post/proofs/{token}/export/request/pdf
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/export/request/pdf
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/export/request/pdf
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/export/request/pdf
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/export/request/pdf
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/export/request/pdf
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/export/request/pdf
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/export/request/pdf
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/export/request/pdf
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/export/request/pdf
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "allVersions": "string",
* "hideResolved": "string",
* "actions": "string",
* "authors": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
PROOF TOKEN STAGES
GETPROOFSTAGES
Proof Stages
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
fields
boolean
?fields=(recipients)
hideInvisible
boolean
?hideInvisible=true
hideBlocked
string
?hideBlocked=true
hideFromInactiveStages
boolean
?hideFromInactiveStages=true
RESPONSES
200
TBD
get/proofs/{token}/stages
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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",
* "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
}
}
]
}
]
}
]
CREATEPROOFSTAGE
Proof Stage
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
Array
name
string
position
number
parentPosition
number or null
deadlineCalculateOn
any or null
Enum: 1 2
deadlineDate
number or null
deadlineBusinessDays
number or null
deadlineTime
(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
recipients
Array of objects (Schema for POST on RECIPIENT)
RESPONSES
200
TBD
post/proofs/{token}/stages
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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",
* "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
}
}
]
}
]
}
]
GETPROOFSTAGE
Proof Stage
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
RESPONSES
200
TBD
get/proofs/{token}/stages/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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",
* "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
}
}
]
}
]
}
EDITPROOFSTAGESETTINGS
Proof Stage Settings
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
REQUEST BODY SCHEMA: APPLICATION/JSON
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
RESPONSES
200
TBD
put/proofs/{token}/stages/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string",
* "parentPosition": 0,
* "deadlineCalculateOn": 1,
* "deadlineDate": 0,
* "activateOn": 1,
* "activateOnDecision": 1,
* "activateOnDate": 0,
* "lockOn": 1,
* "isPrivate": true,
* "isOneApproval": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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",
* "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
}
}
]
}
]
}
PATCHPROOFSTAGEPROPERTIES
Proof Stage Properties
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
REQUEST BODY SCHEMA: APPLICATION/JSON
subject
string or null
(custom subject)
message
string or null
(custom message)
RESPONSES
200
TBD
patch/proofs/{token}/stages/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "subject": "string",
* "message": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
GETPROOFSTAGEDECISIONS
Proof Stage Decisions
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
RESPONSES
200
TBD
get/proofs/{token}/stages/{token1}/decision
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}/decision
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/decision
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}/decision
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/decision
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/decision
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/decision
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/decision
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/decision
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/decision
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "decision": 0,
* "name": "string",
* "displayName": "string",
* "isSignedDecision": true,
* "decisionAt": 0,
* "hasReasons": true,
* "reasons": [
* {
* "token": "string",
* "name": "string",
* "hasText": true,
* "reasonText": "string"
}
]
}
GETPROOFSTAGERECIPIENTS
Proof Stage Recipients
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
QUERY PARAMETERS
fields
string
?fields=contacts
hideInvisible
boolean
?hideInvisible=true
hideBlocked
string
?hideBlocked=true
hideFromInactiveStages
boolean
?hideFromInactiveStages=true
RESPONSES
200
TBD
get/proofs/{token}/stages/{token1}/recipients
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "userToken": "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
}
}
]
}
]
CREATEPROOFSTAGERECIPIENTS
Method allows to add reviewer to the proof stage
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
RESPONSES
200
TBD
post/proofs/{token}/stages/{token1}/recipients
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "userToken": "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
}
}
]
}
]
GETPROOFSTAGERECIPIENT
Proof Stage Recipient
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
token2
required
string
Recipient Token
RESPONSES
200
TBD
get/proofs/{token}/stages/{token1}/recipients/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "userToken": "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
}
}
]
}
EDITPROOFSTAGERECIPIENT
Proof Stage Recipient
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Stage Token
token2
required
string
Recipient Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
string or null
notifications
any or null
Enum: 1 2 3 4 5 6 7 8 9
decision
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
RESPONSES
200
TBD
put/proofs/{token}/stages/{token1}/recipients/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/stages/{token1}/recipients/{token2}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "name": "string",
* "notifications": 1,
* "decision": {
* "token": "string",
* "reasons": [
* {
* "token": "string",
* "reasonText": "string"
}
]
},
* "role": 1,
* "isPrimaryDecisionMaker": true,
* "state": 0,
* "isOwner": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "userToken": "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
}
}
]
}
RECIPIENTS
GETPROOFRECIPIENTS
Proof Recipients
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
QUERY PARAMETERS
email
string
?email=someone@example.net
hideInvisible
boolean
?hideInvisible=true
hideBlocked
string
?hideBlocked=true
hideFromInactiveStages
boolean
?hideFromInactiveStages=true
RESPONSES
200
TBD
get/proofs/{token}/recipients
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "userToken": "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
}
}
]
}
]
CREATEPROOFRECIPIENTS
Proof Recipients
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
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
referenceId
(integer or null) or (string or null)
permissions
object (Schema for POST on RECIPIENT PERMISSIONS)
RESPONSES
200
TBD
post/proofs/{token}/recipients
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "userToken": "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
}
}
]
}
CREATEPROOFRECIPIENTSEARCH
Proof Recipients Search
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
REQUEST BODY SCHEMA: APPLICATION/JSON
email
string or null
token
string or null^[a-zA-Z0-9\-]{30,120}$
referenceId
string or null
RESPONSES
200
TBD
post/proofs/{token}/recipients/search
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients/search
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients/search
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients/search
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients/search
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients/search
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients/search
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients/search
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients/search
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients/search
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "email": "string",
* "token": "string",
* "referenceId": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
GETPROOFRECIPIENT
Proof Recipient
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Recipient Token
RESPONSES
200
TBD
get/proofs/{token}/recipients/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "userToken": "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
}
}
]
}
EDITPROOFRECIPIENT
Proof Recipient
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Recipient Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
string or null
notifications
any or null
Enum: 1 2 3 4 5 6 7 8 9
decision
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
RESPONSES
200
TBD
put/proofs/{token}/recipients/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "name": "string",
* "notifications": 1,
* "decision": {
* "token": "string",
* "reasons": [
* {
* "token": "string",
* "reasonText": "string"
}
]
},
* "role": 1,
* "isPrimaryDecisionMaker": true,
* "state": 0,
* "isOwner": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "userToken": "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
}
}
]
}
DELETEPROOFRECIPIENT
Proof Recipient
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Recipient Token
RESPONSES
200
TBD
delete/proofs/{token}/recipients/{token1}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
GETPROOFRECIPIENTDECISION
Proof Recipient Decision
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Recipient Token
RESPONSES
200
TBD
get/proofs/{token}/recipients/{token1}/decision
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}/decision
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}/decision
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "decision": 0,
* "name": "string",
* "displayName": "string",
* "isSignedDecision": true,
* "decisionAt": 0,
* "hasReasons": true,
* "reasons": [
* {
* "token": "string",
* "name": "string",
* "hasText": true,
* "reasonText": "string"
}
]
}
EDITPROOFRECIPIENTDECISION
Proof Recipient Decision
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Recipient Token
REQUEST BODY SCHEMA: APPLICATION/JSON
decision
required
string
reasons
(Array of Schema for an array of Reasons (objects or null))
send_confirmation
boolean or null
login
string or null
password
string or null
RESPONSES
200
TBD
put/proofs/{token}/recipients/{token1}/decision
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}/decision
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}/decision
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/decision
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "decision": "string",
* "reasons": [
* {
* "token": "string",
* "reasonText": "string"
}
],
* "send_confirmation": true,
* "login": "string",
* "password": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "decision": 0,
* "name": "string",
* "displayName": "string",
* "isSignedDecision": true,
* "decisionAt": 0,
* "hasReasons": true,
* "reasons": [
* {
* "token": "string",
* "name": "string",
* "hasText": true,
* "reasonText": "string"
}
]
}
GETPROOFRECIPIENTURLS
Proof Recipient Urls
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Recipient Token
RESPONSES
200
TBD
get/proofs/{token}/recipients/{token1}/urls
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/urls
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}/urls
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/urls
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/recipients/{token1}/urls
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/urls
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/urls
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/urls
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/urls
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/recipients/{token1}/urls
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "remind": "string",
* "edit": "string",
* "attask": "string",
* "basecamp": "string",
* "netsuite": "string"
}
REPLIES
GETPROOFCOMMENTREPLIES
Proof Comment Replies
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
QUERY PARAMETERS
include_action_replies
boolean
?include_action_replies={true|false}
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}/replies
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
}
]
CREATEPROOFCOMMENTREPLIES
Proof Comment Replies
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
REQUEST BODY SCHEMA: APPLICATION/JSON
text
required
string non-empty
textDirection
integer
RESPONSES
200
TBD
post/proofs/{token}/comments/{token1}/replies
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "text": "string",
* "textDirection": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
]
}
EDITPROOFCOMMENTREPLIES
Proof Comment Replies
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
REQUEST BODY SCHEMA: APPLICATION/JSON
Array
token
required
string
isRead
boolean
RESPONSES
200
TBD
put/proofs/{token}/comments/{token1}/replies
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "isRead": true
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
}
]
GETPROOFCOMMENTREPLY
Proof Comment Reply
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}/replies/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
]
}
DELETEPROOFCOMMENTREPLY
Proof Comment Reply
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
RESPONSES
200
TBD
delete/proofs/{token}/comments/{token1}/replies/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
EDITPROOFCOMMENTREPLY
Proof Comment Reply
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
REQUEST BODY SCHEMA: APPLICATION/JSON
text
string non-empty
editedAt
integer
RESPONSES
200
TBD
put/proofs/{token}/comments/{token1}/replies/{token2}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "text": "string",
* "editedAt": 0
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
]
}
CREATEPROOFCOMMENTREPLYATTACHMENT
Proof Comment Reply Attachment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
REQUEST BODY SCHEMA: APPLICATION/JSON
assetId
required
string non-empty
name
string or null
RESPONSES
200
TBD
post/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "assetId": "string",
* "name": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
GETPROOFCOMMENTREPLYATTACHMENTS
Proof Comment Reply Attachments
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
]
GETPROOFCOMMENTREPLYATTACHMENT
Proof Comment Reply Attachment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
token3
required
string
Attachment Token
RESPONSES
200
TBD
get/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
EDITPROOFCOMMENTREPLYATTACHMENT
Proof Comment Reply Attachment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
token3
required
string
Attachment Token
REQUEST BODY SCHEMA: APPLICATION/JSON
name
string or null
RESPONSES
200
TBD
put/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "name": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "mime": "string",
* "name": "string",
* "size": 0,
* "downloadUrl": "string",
* "permissions": {
* "edit": true,
* "delete": true
}
}
DELETEPROOFCOMMENTREPLYATTACHMENT
Proof Comment Reply Attachment
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
token3
required
string
Attachment Token
RESPONSES
200
TBD
delete/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
GETPROOFCOMMENTREPLYATTACHMENTFILE
Proof Comment Reply Attachment File
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
token3
required
string
Attachment Token
QUERY PARAMETERS
download
boolean
?download=true
RESPONSES
302
TDB
get/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/file
GETPROOFCOMMENTREPLYATTACHMENTTHUMBNAIL
Proof Comment Reply Attachment Thumbnail
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Proof Token
token1
required
string
Comment Token
token2
required
string
Reply Token
token3
required
string
Attachment Token
RESPONSES
302
TDB
get/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
Production US server
https://rest.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
Production EU server
https://rest.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
Preview US server
https://rest.preview.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
Preview EU server
https://rest.preview.proofhq.eu/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
Devbox server
https://rest.local.int.proofhq.com/api/v1/proofs/{token}/comments/{token1}/replies/{token2}/attachments/{token3}/thumbnail
SETTINGS
GETPROOFLIMITS
Limits
AUTHORIZATIONS:
SessionIdAuthJwtAuth
RESPONSES
200
TBD
get/settings/limits
Production US server
https://rest.proofhq.com/api/v1/settings/limits
Production EU server
https://rest.proofhq.eu/api/v1/settings/limits
Preview US server
https://rest.preview.proofhq.com/api/v1/settings/limits
Preview EU server
https://rest.preview.proofhq.eu/api/v1/settings/limits
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/settings/limits
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/settings/limits
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/settings/limits
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/settings/limits
Devbox server
https://rest.local.int.proofhq.com/api/v1/settings/limits
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "proofs": 0,
* "storage": 0
}
GETPROOFINGSETTINGS
Proofing Settings
AUTHORIZATIONS:
SessionIdAuthJwtAuth
RESPONSES
200
TBD
get/settings/proofing
Production US server
https://rest.proofhq.com/api/v1/settings/proofing
Production EU server
https://rest.proofhq.eu/api/v1/settings/proofing
Preview US server
https://rest.preview.proofhq.com/api/v1/settings/proofing
Preview EU server
https://rest.preview.proofhq.eu/api/v1/settings/proofing
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/settings/proofing
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/settings/proofing
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/settings/proofing
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/settings/proofing
Devbox server
https://rest.local.int.proofhq.com/api/v1/settings/proofing
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "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
}
SWAGGER
GETSWAGGERJSON
Swagger JSON
RESPONSES
200
TBD
get/swagger/openapi.json
Production US server
https://rest.proofhq.com/api/v1/swagger/openapi.json
Production EU server
https://rest.proofhq.eu/api/v1/swagger/openapi.json
Preview US server
https://rest.preview.proofhq.com/api/v1/swagger/openapi.json
Preview EU server
https://rest.preview.proofhq.eu/api/v1/swagger/openapi.json
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/swagger/openapi.json
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/swagger/openapi.json
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/swagger/openapi.json
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/swagger/openapi.json
Devbox server
https://rest.local.int.proofhq.com/api/v1/swagger/openapi.json
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
"string"
TAGS
GETTAGS
Tags
AUTHORIZATIONS:
SessionIdAuthJwtAuth
QUERY PARAMETERS
limit
integer
?limit=N (max 100)
offset
integer
?offset=N
RESPONSES
200
TBD
get/tags
Production US server
https://rest.proofhq.com/api/v1/tags
Production EU server
https://rest.proofhq.eu/api/v1/tags
Preview US server
https://rest.preview.proofhq.com/api/v1/tags
Preview EU server
https://rest.preview.proofhq.eu/api/v1/tags
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/tags
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/tags
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/tags
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/tags
Devbox server
https://rest.local.int.proofhq.com/api/v1/tags
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "usage": 0,
* "created": 0,
* "modified": 0,
* "permissions": {
* "edit": true,
* "delete": true
}
}
]
CREATETAG
Tag
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA: APPLICATION/JSON
Array (non-empty)
name
required
string <= 30 characters
RESPONSES
200
TBD
post/tags
Production US server
https://rest.proofhq.com/api/v1/tags
Production EU server
https://rest.proofhq.eu/api/v1/tags
Preview US server
https://rest.preview.proofhq.com/api/v1/tags
Preview EU server
https://rest.preview.proofhq.eu/api/v1/tags
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/tags
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/tags
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/tags
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/tags
Devbox server
https://rest.local.int.proofhq.com/api/v1/tags
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "name": "string"
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "usage": 0,
* "created": 0,
* "modified": 0,
* "permissions": {
* "edit": true,
* "delete": true
}
}
]
GETTAG
Tag
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Tage Token
RESPONSES
200
TBD
get/tags/{token}
Production US server
https://rest.proofhq.com/api/v1/tags/{token}
Production EU server
https://rest.proofhq.eu/api/v1/tags/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/tags/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/tags/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/tags/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/tags/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/tags/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/tags/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/tags/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token": "string",
* "name": "string",
* "usage": 0,
* "created": 0,
* "modified": 0,
* "permissions": {
* "edit": true,
* "delete": true
}
}
UPLOAD
UPLOADDOCUMENT
Upload Document
AUTHORIZATIONS:
SessionIdAuthJwtAuth
REQUEST BODY SCHEMA:
APPLICATION/JSONMULTIPART/FORM-DATAAPPLICATION/JSON
Array
url
string
encodedFiles
object
RESPONSES
200
TBD
post/upload
Production US server
https://rest.proofhq.com/api/v1/upload
Production EU server
https://rest.proofhq.eu/api/v1/upload
Preview US server
https://rest.preview.proofhq.com/api/v1/upload
Preview EU server
https://rest.preview.proofhq.eu/api/v1/upload
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/upload
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/upload
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/upload
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/upload
Devbox server
https://rest.local.int.proofhq.com/api/v1/upload
REQUEST SAMPLES
* Payload
Content type
application/jsonmultipart/form-dataapplication/json
Copy
Expand all Collapse all
[
* {
* "url": "string",
* "encodedFiles": {
* "name": "string",
* "type": "string",
* "size": 0,
* "data": "string"
}
}
]
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "canBeCombined": true,
* "canBeInteractive": 0,
* "httpLinks": [
* "string"
],
* "type": "string",
* "url": "string"
}
]
USERS
GETUSERS
Users
AUTHORIZATIONS:
SessionIdAuthJwtAuth
RESPONSES
200
TBD
get/users
Production US server
https://rest.proofhq.com/api/v1/users
Production EU server
https://rest.proofhq.eu/api/v1/users
Preview US server
https://rest.preview.proofhq.com/api/v1/users
Preview EU server
https://rest.preview.proofhq.eu/api/v1/users
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/users
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/users
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/users
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/users
Devbox server
https://rest.local.int.proofhq.com/api/v1/users
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "token": "string",
* "name": "string",
* "firstName": "string",
* "lastName": "string",
* "dateFormat": "string",
* "dateTimezone": "string",
* "language": "string"
}
]
GETUSER
User
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
User Token
RESPONSES
200
TBD
get/users/{token}
Production US server
https://rest.proofhq.com/api/v1/users/{token}
Production EU server
https://rest.proofhq.eu/api/v1/users/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/users/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/users/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/users/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/users/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/users/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/users/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/users/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "token": "string",
* "name": "string",
* "firstName": "string",
* "lastName": "string",
* "dateFormat": "string",
* "dateTimezone": "string",
* "language": "string"
}
GETUSERAVATAR
User Avatar
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
User Token
RESPONSES
302
TDB
get/users/{token}/avatar
Production US server
https://rest.proofhq.com/api/v1/users/{token}/avatar
Production EU server
https://rest.proofhq.eu/api/v1/users/{token}/avatar
Preview US server
https://rest.preview.proofhq.com/api/v1/users/{token}/avatar
Preview EU server
https://rest.preview.proofhq.eu/api/v1/users/{token}/avatar
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/users/{token}/avatar
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/users/{token}/avatar
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/users/{token}/avatar
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/users/{token}/avatar
Devbox server
https://rest.local.int.proofhq.com/api/v1/users/{token}/avatar
WORKFLOW
GETWORKFLOWTEMPLATES
Workflow Templates
AUTHORIZATIONS:
SessionIdAuthJwtAuth
RESPONSES
200
TBD
get/workflow/templates
Production US server
https://rest.proofhq.com/api/v1/workflow/templates
Production EU server
https://rest.proofhq.eu/api/v1/workflow/templates
Preview US server
https://rest.preview.proofhq.com/api/v1/workflow/templates
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workflow/templates
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workflow/templates
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workflow/templates
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workflow/templates
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workflow/templates
Devbox server
https://rest.local.int.proofhq.com/api/v1/workflow/templates
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
]
GETWORKFLOWTEMPLATE
Workflow Template
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Template Token
RESPONSES
200
TBD
get/workflow/templates/{token}
Production US server
https://rest.proofhq.com/api/v1/workflow/templates/{token}
Production EU server
https://rest.proofhq.eu/api/v1/workflow/templates/{token}
Preview US server
https://rest.preview.proofhq.com/api/v1/workflow/templates/{token}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workflow/templates/{token}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workflow/templates/{token}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workflow/templates/{token}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workflow/templates/{token}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workflow/templates/{token}
Devbox server
https://rest.local.int.proofhq.com/api/v1/workflow/templates/{token}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "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
}
}
GETWORKFLOWTEMAPLATESTAGES
Workflow Template Stages
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Template Token
RESPONSES
200
TBD
get/workflow/templates/{token}/stages
Production US server
https://rest.proofhq.com/api/v1/workflow/templates/{token}/stages
Production EU server
https://rest.proofhq.eu/api/v1/workflow/templates/{token}/stages
Preview US server
https://rest.preview.proofhq.com/api/v1/workflow/templates/{token}/stages
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workflow/templates/{token}/stages
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workflow/templates/{token}/stages
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workflow/templates/{token}/stages
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workflow/templates/{token}/stages
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workflow/templates/{token}/stages
Devbox server
https://rest.local.int.proofhq.com/api/v1/workflow/templates/{token}/stages
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
]
GETWORKFLOWTEMPLATESTAGERECIPIENTS
Workflow Template Stage Recipients
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
token
required
string
Template Token
token1
required
string
Stage Token
QUERY PARAMETERS
fields
string
?fields=contacts
RESPONSES
200
TBD
get/workflow/templates/{token}/stages/{token1}/recipients
Production US server
https://rest.proofhq.com/api/v1/workflow/templates/{token}/stages/{token1}/recipients
Production EU server
https://rest.proofhq.eu/api/v1/workflow/templates/{token}/stages/{token1}/recipients
Preview US server
https://rest.preview.proofhq.com/api/v1/workflow/templates/{token}/stages/{token1}/recipients
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workflow/templates/{token}/stages/{token1}/recipients
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workflow/templates/{token}/stages/{token1}/recipients
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workflow/templates/{token}/stages/{token1}/recipients
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workflow/templates/{token}/stages/{token1}/recipients
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workflow/templates/{token}/stages/{token1}/recipients
Devbox server
https://rest.local.int.proofhq.com/api/v1/workflow/templates/{token}/stages/{token1}/recipients
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
[
* {
* "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
}
}
}
]
WORKFRONT USER
GETWORKFRONTUSER
Workfront Integrated User
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
referenceId
required
string
Workfront's user guid
HEADER PARAMETERS
WF-CustomerID
required
string <uuid>
Workfront's account guid
RESPONSES
200
TBD
get/workfront/users/{referenceId}
Production US server
https://rest.proofhq.com/api/v1/workfront/users/{referenceId}
Production EU server
https://rest.proofhq.eu/api/v1/workfront/users/{referenceId}
Preview US server
https://rest.preview.proofhq.com/api/v1/workfront/users/{referenceId}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workfront/users/{referenceId}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workfront/users/{referenceId}
Devbox server
https://rest.local.int.proofhq.com/api/v1/workfront/users/{referenceId}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "contactToken": "string",
* "email": "string",
* "profileToken": "string",
* "referenceId": "string",
* "apiToken": "string"
}
UPDATEWORKFRONTUSER
Editing workfront users
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
referenceId
required
string
Workfront's user guid
HEADER PARAMETERS
WF-CustomerID
required
string <uuid>
Workfront's account guid
REQUEST BODY SCHEMA: APPLICATION/JSON
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
RESPONSES
200
TBD
put/workfront/users/{referenceId}
Production US server
https://rest.proofhq.com/api/v1/workfront/users/{referenceId}
Production EU server
https://rest.proofhq.eu/api/v1/workfront/users/{referenceId}
Preview US server
https://rest.preview.proofhq.com/api/v1/workfront/users/{referenceId}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workfront/users/{referenceId}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workfront/users/{referenceId}
Devbox server
https://rest.local.int.proofhq.com/api/v1/workfront/users/{referenceId}
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "email": "user@example.com",
* "firstName": "string",
* "lastName": "string",
* "hasProofingLicense": true,
* "isExternal": true,
* "permissionId": 0,
* "defaultRecipientRole": 0,
* "isActive": true,
* "isFromSso": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "contactToken": "string",
* "email": "string",
* "profileToken": "string",
* "referenceId": "string",
* "apiToken": "string"
}
DELETEWORKFRONTUSER
Delete Workfront User
AUTHORIZATIONS:
SessionIdAuthJwtAuth
PATH PARAMETERS
referenceId
required
string
Workfront's user guid
HEADER PARAMETERS
WF-CustomerID
required
string <uuid>
Workfront's account guid
RESPONSES
200
TBD
delete/workfront/users/{referenceId}
Production US server
https://rest.proofhq.com/api/v1/workfront/users/{referenceId}
Production EU server
https://rest.proofhq.eu/api/v1/workfront/users/{referenceId}
Preview US server
https://rest.preview.proofhq.com/api/v1/workfront/users/{referenceId}
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workfront/users/{referenceId}
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workfront/users/{referenceId}
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workfront/users/{referenceId}
Devbox server
https://rest.local.int.proofhq.com/api/v1/workfront/users/{referenceId}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{ }
CREATEWORKFRONTUSER
Adding workfront users to proofing
AUTHORIZATIONS:
SessionIdAuthJwtAuth
HEADER PARAMETERS
WF-CustomerID
required
string <uuid>
Workfront's account guid
REQUEST BODY SCHEMA: APPLICATION/JSON
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
RESPONSES
200
TBD
post/workfront/users
Production US server
https://rest.proofhq.com/api/v1/workfront/users
Production EU server
https://rest.proofhq.eu/api/v1/workfront/users
Preview US server
https://rest.preview.proofhq.com/api/v1/workfront/users
Preview EU server
https://rest.preview.proofhq.eu/api/v1/workfront/users
DEV1 server
https://rest.dev1.int.proofhq.com/api/v1/workfront/users
DEV2 server
https://rest.dev2.int.proofhq.com/api/v1/workfront/users
DEV4 server
https://rest.dev4.int.proofhq.com/api/v1/workfront/users
DEV6 server
https://rest.dev6.int.proofhq.com/api/v1/workfront/users
Devbox server
https://rest.local.int.proofhq.com/api/v1/workfront/users
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
{
* "referenceId": "string",
* "email": "user@example.com",
* "firstName": "string",
* "lastName": "string",
* "hasProofingLicense": true,
* "isExternal": true,
* "permissionId": 0,
* "defaultRecipientRole": 0,
* "isActive": true,
* "isFromSso": true
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
{
* "contactToken": "string",
* "email": "string",
* "profileToken": "string",
* "referenceId": "string",
* "apiToken": "string"
}