API docs by Redocly

Workfront ProofHQ REST API (1.0.54)

Download OpenAPI specification:Download

License: proprietary

The API that provides proofing capability to the Adobe Workfront platform.

Accounts

Accounts

The account endpoint in the ProofHQ API retrieves information about accounts.

Authorizations:
SessionIdAuthJwtAuth
query Parameters
trusted
boolean

?trusted={true|false}

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAccount

The accounts endpoint in the ProofHQ API retrieves detailed information about a specific account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "parentAccountToken": "string",
  • "name": "string",
  • "modified": 0
}

getAccountLimits

The endpoint in ProofHQ API returns information about proof storage and usage limits for the account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
{
  • "proofs": 0,
  • "storage": 0
}

getAccountSettings

The endpoint in ProofHQ API retrieves the account settings for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
{
  • "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

The endpoint in ProofHQ API retrieves the account actions for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAccountSettingsDecisions

The endpoint in ProofHQ API retrieves the account decisions for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAccountSettingsDecisionsReasons

The endpoint in ProofHQ API retrieves the account decision reasons for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getAccountMembership

The endpoint in ProofHQ API retrieves the account membership details for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
{
  • "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

The endpoint in ProofHQ API retrieves the account devices for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "width": 0,
  • "height": 0,
  • "type": 1,
  • "ratio": 0,
  • "userAgent": "string",
  • "isDisabled": true
}

Response samples

Content type
application/json
[
  • {
    }
]

getAccountDevice

The endpoint in ProofHQ API retrieves the description for a given account device.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

token1
required
string

Device Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "name": "string",
  • "userAgent": "string",
  • "accountToken": "string",
  • "width": 0,
  • "height": 0,
  • "ratio": 0,
  • "type": 0,
  • "position": 0,
  • "isDisabled": true,
  • "isDefault": true
}

deleteAccountDevice

The endpoint in ProofHQ API deletes the account device for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

token1
required
string

Device Token

Responses

Response samples

Content type
application/json
{ }

editAccountDevice

The endpoint in ProofHQ API updates the account device for a given account.

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

Request samples

Content type
application/json
{
  • "name": "string",
  • "width": 0,
  • "height": 0,
  • "type": 1,
  • "ratio": 0,
  • "userAgent": "string",
  • "isDisabled": true
}

Response samples

Content type
application/json
[
  • {
    }
]

getAccountDomains

The endpoint in ProofHQ API retrieves the account domains for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createAccountDomain

The endpoint in ProofHQ API creates the account domain for a given account.

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

Request samples

Content type
application/json
{
  • "type": 1,
  • "domain": "string",
  • "subdomain": "string",
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "type": 1,
  • "domain": "string",
  • "subdomain": "string",
  • "path": "string",
  • "modified": 0
}

getAccountDomain

The endpoint in ProofHQ API retrieves the account domain for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

token1
required
string

Domain Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "type": 1,
  • "domain": "string",
  • "subdomain": "string",
  • "path": "string",
  • "modified": 0
}

deleteAccountDomain

The endpoint in ProofHQ API deletes the account domain for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Account Token

token1
required
string

Domain Token

Responses

Response samples

Content type
application/json
{ }

editAccountDomain

The endpoint in ProofHQ API updates the account domain for a given account.

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

Request samples

Content type
application/json
{
  • "type": 1,
  • "domain": "string",
  • "subdomain": "string",
  • "path": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "type": 1,
  • "domain": "string",
  • "subdomain": "string",
  • "path": "string",
  • "modified": 0
}

Authorize

postAuthorize

The endpoint in ProofHQ API authorizes the user.

Request Body schema: application/json
One of
email
required
string
authtoken
required
string

Responses

Request samples

Content type
application/json
Example
{
  • "email": "string",
  • "authtoken": "string"
}

Response samples

Content type
application/json
{
  • "sessionId": "string"
}

getAuthorizeUser

The endpoint in ProofHQ API retrieves the authorized user information.

Authorizations:
SessionIdAuthJwtAuth

Responses

Response samples

Content type
application/json
{
  • "context": "user",
  • "permissions": {
    },
  • "userToken": "string",
  • "accountToken": "string",
  • "contactToken": "string",
  • "name": "string",
  • "email": "string",
  • "avatar": "string",
  • "proofToken": "string"
}

getLogout

The endpoint in ProofHQ API logs out the user.

Authorizations:
SessionIdAuthJwtAuth

Responses

Response samples

Content type
application/json
{ }

getDecodeUrl

The endpoint in ProofHQ API decodes the URL.

Authorizations:
SessionIdAuthJwtAuth
query Parameters
url
required
string

?url={url}

compare
string

?compare={compare}

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "code": "string",
  • "compareToken": "string",
  • "codeToCompare": "string"
}

Basecamp

getBasecampProjects

The endpoint in ProofHQ API retrieves the Basecamp projects.

Authorizations:
SessionIdAuthJwtAuth
query Parameters
refresh
boolean

?refresh={true}

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getBasecampProjectContacts

The endpoint in ProofHQ API retrieves the Basecamp project contacts.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
id
required
integer

Basecamp Project ID

query Parameters
refresh
boolean

?refresh={true}

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getBasecampProjectCategories

The endpoint in ProofHQ API retrieves the Basecamp project categories.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
id
required
integer

Basecamp Project ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getBasecampData

The endpoint in ProofHQ API retrieves the Basecamp information.

Authorizations:
SessionIdAuthJwtAuth

Responses

Response samples

Content type
application/json
{
  • "basecampActivated": true,
  • "basecampVersion": 0,
  • "integrationType": 0,
  • "projectId": 0,
  • "messageCategoryId": 0,
  • "isPrivate": true,
  • "defaultStagePosition": 0,
  • "defaultDueDate": 0,
  • "recipients": [
    ]
}

createBaseCampData

The endpoint in ProofHQ API creates the Basecamp information.

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
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "proofToken": "string",
  • "projectId": 0,
  • "messageCategoryId": 0,
  • "private": true,
  • "defaultDueDate": 0,
  • "defaultStagePosition": 0,
  • "recipients": [
    ]
}

Response samples

Content type
application/json
{
  • "basecampActivated": true,
  • "basecampVersion": 0,
  • "integrationType": 0,
  • "projectId": 0,
  • "messageCategoryId": 0,
  • "isPrivate": true,
  • "defaultStagePosition": 0,
  • "defaultDueDate": 0,
  • "recipients": [
    ]
}

Comments

getProofComments

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
[
  • {
    }
]

createProofComment

The endpoint in ProofHQ API creates the proof comment.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Request Body schema: application/json
Any of
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

Request samples

Content type
application/json
{
  • "text": "string",
  • "drawings": [
    ],
  • "metadata": { },
  • "textDirection": 0,
  • "pins": { },
  • "page": 0,
  • "pages": 0,
  • "timestampBegin": 0,
  • "timestampEnd": 0,
  • "layout": 0,
  • "isLocked": true,
  • "actionToken": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "text": "string",
  • "textDirection": 0,
  • "author": "string",
  • "authorToken": "string",
  • "stageToken": "string",
  • "created": 0,
  • "modified": 0,
  • "drawings": [
    ],
  • "pins": { },
  • "pages": [
    ],
  • "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": {
    },
  • "replies": [
    ],
  • "attachments": [
    ]
}

editProofComments

The endpoint in ProofHQ API updates the proof comment.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Request Body schema: application/json
Array
token
required
string
isRead
boolean

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "token": "string",
  • "text": "string",
  • "textDirection": 0,
  • "author": "string",
  • "authorToken": "string",
  • "stageToken": "string",
  • "created": 0,
  • "modified": 0,
  • "drawings": [
    ],
  • "pins": { },
  • "pages": [
    ],
  • "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": {
    },
  • "replies": [
    ],
  • "attachments": [
    ]
}

getProofComment

The endpoint in ProofHQ API retrieves the proof comment.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "text": "string",
  • "textDirection": 0,
  • "author": "string",
  • "authorToken": "string",
  • "stageToken": "string",
  • "created": 0,
  • "modified": 0,
  • "drawings": [
    ],
  • "pins": { },
  • "pages": [
    ],
  • "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": {
    },
  • "replies": [
    ],
  • "attachments": [
    ]
}

deleteProofComment

The endpoint in ProofHQ API deletes the proof comment.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

Responses

Response samples

Content type
application/json
{ }

editProofComment

The endpoint in ProofHQ API updates the 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

Request samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "token": "string",
  • "text": "string",
  • "textDirection": 0,
  • "author": "string",
  • "authorToken": "string",
  • "stageToken": "string",
  • "created": 0,
  • "modified": 0,
  • "drawings": [
    ],
  • "pins": { },
  • "pages": [
    ],
  • "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": {
    },
  • "replies": [
    ],
  • "attachments": [
    ]
}

createProofCommentAttachments

The endpoint in ProofHQ API creates the 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

Request samples

Content type
application/json
{
  • "assetId": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "mime": "string",
  • "name": "string",
  • "size": 0,
  • "downloadUrl": "string",
  • "permissions": {
    }
}

getProofCommentAttachments

The endpoint in ProofHQ API retrieves the proof comment attachments.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getProofCommentAttachment

The endpoint in ProofHQ API retrieves the proof comment attachment.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

token2
required
string

Attachment Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "mime": "string",
  • "name": "string",
  • "size": 0,
  • "downloadUrl": "string",
  • "permissions": {
    }
}

editProofCommentAttachment

The endpoint in ProofHQ API updates the 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

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "mime": "string",
  • "name": "string",
  • "size": 0,
  • "downloadUrl": "string",
  • "permissions": {
    }
}

deleteProofCommentAttachment

The endpoint in ProofHQ API deletes the proof comment attachment.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

token2
required
string

Attachment Token

Responses

Response samples

Content type
application/json
{ }

getProofCommentAttachmentFile

The endpoint in ProofHQ API retrieves the proof comment file attachments.

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

getProofCommentAttachmentThumbnail

The endpoint in ProofHQ API retrieves the proof comment attachment thumbnail.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

token2
required
string

Attachment Token

Responses

getProofCommentCapture

The endpoint in ProofHQ API retrieves the proof comment capture.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

Responses

createProofCommentCapture

The endpoint in ProofHQ API creates the proof comment capture.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

Responses

Response samples

Content type
application/json
{ }

Contacts

getContacts

The endpoint in ProofHQ API retrieves all the contacts in an user context.

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

Response samples

Content type
application/json
[
  • {
    }
]

getContact

The endpoint in ProofHQ API retrieves a contact.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Contact Token

Responses

Response samples

Content type
application/json
{
  • "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": [
    ],
  • "permissions": {
    }
}

getContactAutocomplete

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
{
  • "contacts": [
    ],
  • "groups": [
    ],
  • "accounts": [
    ]
}

Convert

createConvert

Convert

Authorizations:
SessionIdAuthJwtAuth
Request Body schema: application/json
Array
One of
object
required
string
Enum: "proof" "account"
token
required
string
id
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

Request samples

Content type
application/json
{
  • "url": "string",
  • "limit": 0,
  • "exceptions": [
    ]
}

Response samples

Content type
application/json
{
  • "pages": [
    ],
  • "metadata": {
    }
}

Custom Data

getCustomData

The endpoint in ProofHQ API retrieves the custom data for custom fields created.

Authorizations:
SessionIdAuthJwtAuth
query Parameters
proof
string

?proof={token}

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createCustomData

The endpoint in ProofHQ API creates the custom file for custom data provided.

Authorizations:
SessionIdAuthJwtAuth
Request Body schema: application/json
Array
token
required
string
name
required
string
order
required
number
required
Array of objects (Schema for an array of CUSTOMDATA FIELD)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Email

getEmail

The endpoint in ProofHQ API retrieves the email settings for a given account.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
email
required
string

Email Address

Responses

Response samples

Content type
application/json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "type": 0,
  • "mailingLevel": 0,
  • "defaultRole": 0,
  • "isFromPartnerOrganization": true
}

Error Messages

getErrorMessages

Error Messages

Responses

Response samples

Content type
application/json
[
  • "string"
]

Folders

getFolders

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
[
  • {
    }
]

createFolder

The endpoint in ProofHQ API creates the 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

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

getFolder

The endpoint in ProofHQ API retrieves the folder information.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Folder Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "name": "string",
  • "description": "string",
  • "itemsCount": 0,
  • "subfoldersCount": 0,
  • "level": 0,
  • "parentFolderToken": "string",
  • "canCreateFolders": true
}

getFolderItems

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
[
  • {
    }
]

getFolderBreadcrumbs

The endpoint in ProofHQ API retrieves the folder breadcrumbs.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Folder Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getFolderThumbnail

The endpoint in ProofHQ API retrieves the folder thumbnail.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Folder Token

Responses

getFolderRecipients

The endpoint in ProofHQ API retrieves the folder recipients.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Folder Token

query Parameters
offset
integer

?offset={offset}

limit
integer

?limit={limit} (max 1000)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Health

getHealth

Health

Responses

Response samples

Content type
application/json
{ }

Proofs

getProofs

The endpoint in ProofHQ API retrieves the all proofs for the given user session and the information can be paginated.

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
disable_source
string

?disable_source={lucene|database|legacy_lucene}

limit
integer

?limit=N (max 100)

offset
integer

?offset=N

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createProof

The endpoint in ProofHQ API creates the new proof.

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}$
(integer or null) or (string or null)
Array of objects or null (Schema for an array of POST on STAGE)
Array of objects
Array of objects or null
Array of objects or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

updateProofDeadline

The endpoint in ProofHQ API updates the proof deadline for a basic proof.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Request Body schema: application/json
deadline
required
number

Responses

Request samples

Content type
application/json
{
  • "deadline": 0
}

Response samples

Content type
application/json
{
  • "fileId": 0,
  • "deadline": 0
}

getProof

The endpoint in ProofHQ API retrieves the proof information for a given proof token.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

query Parameters
fields
string

?fields=templates

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "hasMessage": true,
  • "hasCustomMessage": true,
  • "subject": "string",
  • "message": "string",
  • "parentFileToken": "string",
  • "ownerUserName": "string",
  • "ownerUserToken": "string",
  • "ownerImsUserId": "string",
  • "creatorUserName": "string",
  • "creatorUserToken": "string",
  • "creatorImsUserId": "string",
  • "creatorEmail": "string",
  • "isAutomatedWorkflow": true,
  • "hasSelfClose": true,
  • "isLoginRequired": true,
  • "isOneApproval": true,
  • "hasElectronicSignatures": true,
  • "canDownload": true,
  • "hasPublicSharing": true,
  • "hasSubscription": true,
  • "defaultNotifications": 0,
  • "defaultRole": 0,
  • "subscriptionNotification": 0,
  • "progress": {
    },
  • "embedCode": "string",
  • "teamUrl": "string",
  • "folderToken": "string",
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "accountToken": "string",
  • "referenceId": "string",
  • "stageBasedVisibility": 0,
  • "permissions": {
    },
  • "recipients": [
    ],
  • "stages": [
    ],
  • "comments": [
    ],
  • "templates": [
    ]
}

deleteProof

The endpoint in ProofHQ API deletes the proof.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
{ }

editProof

The endpoint in ProofHQ API updates the 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

Request samples

Content type
application/json
{
  • "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

Content type
application/json
{
  • "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": {
    },
  • "hasMessage": true,
  • "hasCustomMessage": true,
  • "subject": "string",
  • "message": "string",
  • "parentFileToken": "string",
  • "ownerUserName": "string",
  • "ownerUserToken": "string",
  • "ownerImsUserId": "string",
  • "creatorUserName": "string",
  • "creatorUserToken": "string",
  • "creatorImsUserId": "string",
  • "creatorEmail": "string",
  • "isAutomatedWorkflow": true,
  • "hasSelfClose": true,
  • "isLoginRequired": true,
  • "isOneApproval": true,
  • "hasElectronicSignatures": true,
  • "canDownload": true,
  • "hasPublicSharing": true,
  • "hasSubscription": true,
  • "defaultNotifications": 0,
  • "defaultRole": 0,
  • "subscriptionNotification": 0,
  • "progress": {
    },
  • "embedCode": "string",
  • "teamUrl": "string",
  • "folderToken": "string",
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "accountToken": "string",
  • "referenceId": "string",
  • "stageBasedVisibility": 0,
  • "permissions": {
    },
  • "recipients": [
    ],
  • "stages": [
    ],
  • "comments": [
    ],
  • "templates": [
    ]
}

patchProof

The endpoint in ProofHQ API patches the 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

Request samples

Content type
application/json
{
  • "name": "string",
  • "state": 0,
  • "isArchived": true,
  • "ownerUserToken": "string",
  • "subject": "string",
  • "message": "string",
  • "isAutomatedWorkflow": true
}

Response samples

Content type
application/json
{ }

createProofCopy

The endpoint in ProofHQ API creates the proof copy for the given proof token.

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
(integer or null) or (string or null)
newVersion
boolean or null

Creates copy as new version

Responses

Request samples

Content type
application/json
{
  • "uploadHash": "string",
  • "sourceName": "string",
  • "name": "string",
  • "referenceId": 0,
  • "newVersion": true
}

Response samples

Content type
application/json
{
  • "file_id": 0,
  • "token": "string"
}

getProofActivity

The endpoint in ProofHQ API retrieves the proof activity.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

query Parameters
limit
integer

?limit=N (max 200)

offset
integer

?offset=N

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getProofTags

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
[
  • {
    }
]

createProofTag

The endpoint in ProofHQ API creates the 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

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

getProofControls

The endpoint in ProofHQ API retrieves the proof controls.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
{
  • "buttons": {
    },
  • "display": {
    },
  • "functions": {
    }
}

getProofCustomFields

The endpoint in ProofHQ API retrieves the proof custom fields.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getProofDecisions

The endpoint in ProofHQ API retrieves the proof decisions.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "decision": 0,
  • "name": "string",
  • "displayName": "string",
  • "isSignedDecision": true,
  • "decisionAt": 0,
  • "hasReasons": true,
  • "reasons": [
    ]
}

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 [ items <email > ]

List of recipients emails

message_subject
string or null
message_body
string or null

Responses

Request samples

Content type
application/json
{
  • "send_download_url": true,
  • "send_team_url": true,
  • "emails": [
    ],
  • "message_subject": "string",
  • "message_body": "string"
}

Response samples

Content type
application/json
{ }

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 [^[a-zA-Z0-9\-]{30,120}$]

List of recipients tokens

messageSubject
required
string
messageBody
required
string

Responses

Request samples

Content type
application/json
{
  • "recipients": [
    ],
  • "messageSubject": "string",
  • "messageBody": "string"
}

Response samples

Content type
application/json
{ }

getProofSettings

The endpoint in ProofHQ API retrieves the proof settings.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
{
  • "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

The endpoint in ProofHQ API retrieves the proof settings based on profile settings.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
{
  • "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

The endpoint in ProofHQ API retrieves the proof source files.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getProofThumbnail

The endpoint in ProofHQ API retrieves the proof thumbnail.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

getProofUpdates

The endpoint in ProofHQ API retrieves the proof updates.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createProofTokenUpload

The endpoint in ProofHQ API uploads the proof token.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "url": "string",
  • "thumbnailUrl": "string"
}

getProofUrls

The endpoint in ProofHQ API retrieves the proof URLs.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "custom": {
    },
  • "helpFaq": {
    },
  • "helpDemo": {
    },
  • "helpBlog": {
    },
  • "helpForum": {
    },
  • "cloudUrl": "string",
  • "cloudFileUrl": "string",
  • "cloudStreamingUrl": "string",
  • "richMediaUrl": "string",
  • "sso": "string",
  • "ssoDecision": "string",
  • "attask": {
    },
  • "netsuite": {
    },
  • "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

The endpoint in ProofHQ API retrieves the proof versions.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

query Parameters
strict
string

?strict=true

processed_only
boolean

?processed_only=false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Proof Exports

getProofExportedExcel

The endpoint in ProofHQ API retrieves the proof exported to excel format.

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

createProofExportRequestPdf

The endpoint in ProofHQ API creates the proof export request for PDF format.

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

Request samples

Content type
application/json
{
  • "allVersions": "string",
  • "hideResolved": "string",
  • "actions": "string",
  • "authors": "string"
}

Response samples

Content type
application/json
{ }

Proof Token Stages

getProofStages

The endpoint in ProofHQ API retrieves all the 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

Response samples

Content type
application/json
[
  • {
    }
]

createProofStage

The endpoint in ProofHQ API creates the proof stages.

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
(number or null) or (string or null)
activateOn
any or null
Enum: 1 2 3 6 7 8
activateOnDecision
any or null
Enum: 1 2
activateOnDate
number or null
lockOn
any or null
Enum: 1 2 3 4
isPrivate
boolean or null
isOneApproval
boolean or null
isMandatory
boolean or null
Array of objects (Schema for POST on RECIPIENT)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

getProofStage

The endpoint in ProofHQ API retrieves the proof stage.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Stage Token

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "hasMessage": true,
  • "hasCustomMessage": true,
  • "subject": "string",
  • "message": "string",
  • "isPrivate": true,
  • "isActive": true,
  • "isLocked": true,
  • "isOneApproval": true,
  • "isMandatory": true,
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "progress": {
    },
  • "permissions": {
    },
  • "recipients": [
    ]
}

editProofStageSettings

The endpoint in ProofHQ API updates the 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

Request samples

Content type
application/json
{
  • "name": "string",
  • "parentPosition": 0,
  • "deadlineCalculateOn": 1,
  • "deadlineDate": 0,
  • "activateOn": 1,
  • "activateOnDecision": 1,
  • "activateOnDate": 0,
  • "lockOn": 1,
  • "isPrivate": true,
  • "isOneApproval": true
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "hasMessage": true,
  • "hasCustomMessage": true,
  • "subject": "string",
  • "message": "string",
  • "isPrivate": true,
  • "isActive": true,
  • "isLocked": true,
  • "isOneApproval": true,
  • "isMandatory": true,
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "progress": {
    },
  • "permissions": {
    },
  • "recipients": [
    ]
}

patchProofStageProperties

The endpoint in ProofHQ API patches the proof stage settings.

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

Request samples

Content type
application/json
{
  • "subject": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{ }

getProofStageDecisions

The endpoint in ProofHQ API retrieves the proof stage decisions.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Stage Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "decision": 0,
  • "name": "string",
  • "displayName": "string",
  • "isSignedDecision": true,
  • "decisionAt": 0,
  • "hasReasons": true,
  • "reasons": [
    ]
}

getProofStageRecipients

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
[
  • {
    }
]

createProofStageRecipients

The endpoint in ProofHQ API creates the proof stage recipients.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Stage Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getProofStageRecipient

The endpoint in ProofHQ API retrieves a proof stage recipient.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Stage Token

token2
required
string

Recipient Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "userToken": "string",
  • "imsUserId": "string",
  • "stageToken": "string",
  • "name": "string",
  • "email": "string",
  • "created": 0,
  • "role": 0,
  • "roleName": "string",
  • "decision": {
    },
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "notifications": 1,
  • "progress": {
    },
  • "isPrimaryDecisionMaker": true,
  • "isVerified": true,
  • "isUser": true,
  • "isCreator": true,
  • "isOwner": true,
  • "state": 0,
  • "referenceId": "string",
  • "permissions": {
    },
  • "contacts": [
    ]
}

editProofStageRecipient

The endpoint in ProofHQ API updates the 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
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

Request samples

Content type
application/json
{
  • "name": "string",
  • "notifications": 1,
  • "decision": {
    },
  • "role": 1,
  • "isPrimaryDecisionMaker": true,
  • "state": 0,
  • "isOwner": true
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "userToken": "string",
  • "imsUserId": "string",
  • "stageToken": "string",
  • "name": "string",
  • "email": "string",
  • "created": 0,
  • "role": 0,
  • "roleName": "string",
  • "decision": {
    },
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "notifications": 1,
  • "progress": {
    },
  • "isPrimaryDecisionMaker": true,
  • "isVerified": true,
  • "isUser": true,
  • "isCreator": true,
  • "isOwner": true,
  • "state": 0,
  • "referenceId": "string",
  • "permissions": {
    },
  • "contacts": [
    ]
}

Recipients

getProofRecipients

The endpoint in ProofHQ API retrieves the proof recipients.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

query Parameters
email
string
hideInvisible
boolean

?hideInvisible=true

hideBlocked
string

?hideBlocked=true

hideFromInactiveStages
boolean

?hideFromInactiveStages=true

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createProofRecipients

The endpoint in ProofHQ API creates the 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

(integer or null) or (string or null)
object (Schema for POST on RECIPIENT PERMISSIONS)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "notifications": 1,
  • "isPrimaryDecisionMaker": true,
  • "state": 0,
  • "role": -1,
  • "position": "string",
  • "deadline": 0,
  • "referenceId": 0,
  • "permissions": {
    }
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "userToken": "string",
  • "imsUserId": "string",
  • "stageToken": "string",
  • "name": "string",
  • "email": "string",
  • "created": 0,
  • "role": 0,
  • "roleName": "string",
  • "decision": {
    },
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "notifications": 1,
  • "progress": {
    },
  • "isPrimaryDecisionMaker": true,
  • "isVerified": true,
  • "isUser": true,
  • "isCreator": true,
  • "isOwner": true,
  • "state": 0,
  • "referenceId": "string",
  • "permissions": {
    },
  • "contacts": [
    ]
}

createProofRecipientSearch

The endpoint in ProofHQ API searches the proof recipients.

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

Request samples

Content type
application/json
{
  • "email": "string",
  • "token": "string",
  • "referenceId": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

getProofRecipient

The endpoint in ProofHQ API retrieves the proof recipient.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Recipient Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "userToken": "string",
  • "imsUserId": "string",
  • "stageToken": "string",
  • "name": "string",
  • "email": "string",
  • "created": 0,
  • "role": 0,
  • "roleName": "string",
  • "decision": {
    },
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "notifications": 1,
  • "progress": {
    },
  • "isPrimaryDecisionMaker": true,
  • "isVerified": true,
  • "isUser": true,
  • "isCreator": true,
  • "isOwner": true,
  • "state": 0,
  • "referenceId": "string",
  • "permissions": {
    },
  • "contacts": [
    ]
}

editProofRecipient

The endpoint in ProofHQ API updates the 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
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

Request samples

Content type
application/json
{
  • "name": "string",
  • "notifications": 1,
  • "decision": {
    },
  • "role": 1,
  • "isPrimaryDecisionMaker": true,
  • "state": 0,
  • "isOwner": true
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "userToken": "string",
  • "imsUserId": "string",
  • "stageToken": "string",
  • "name": "string",
  • "email": "string",
  • "created": 0,
  • "role": 0,
  • "roleName": "string",
  • "decision": {
    },
  • "commentsCount": 0,
  • "repliesCount": 0,
  • "notifications": 1,
  • "progress": {
    },
  • "isPrimaryDecisionMaker": true,
  • "isVerified": true,
  • "isUser": true,
  • "isCreator": true,
  • "isOwner": true,
  • "state": 0,
  • "referenceId": "string",
  • "permissions": {
    },
  • "contacts": [
    ]
}

deleteProofRecipient

The endpoint in ProofHQ API deletes the proof recipient.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Recipient Token

Responses

Response samples

Content type
application/json
{ }

getProofRecipientDecision

The endpoint in ProofHQ API retrieves the proof recipient decision.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Recipient Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "decision": 0,
  • "name": "string",
  • "displayName": "string",
  • "isSignedDecision": true,
  • "decisionAt": 0,
  • "hasReasons": true,
  • "reasons": [
    ]
}

editProofRecipientDecision

The endpoint in ProofHQ API updates the 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
(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

Request samples

Content type
application/json
{
  • "decision": "string",
  • "reasons": [
    ],
  • "send_confirmation": true,
  • "login": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "decision": 0,
  • "name": "string",
  • "displayName": "string",
  • "isSignedDecision": true,
  • "decisionAt": 0,
  • "hasReasons": true,
  • "reasons": [
    ]
}

getProofRecipientUrls

The endpoint in ProofHQ API retrieves the proof recipient URLs.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Recipient Token

Responses

Response samples

Content type
application/json
{
  • "remind": "string",
  • "edit": "string",
  • "attask": "string",
  • "basecamp": "string",
  • "netsuite": "string"
}

Replies

getProofCommentReplies

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
[
  • {
    }
]

createProofCommentReplies

The endpoint in ProofHQ API creates the 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

Request samples

Content type
application/json
{
  • "text": "string",
  • "textDirection": 0
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "attachments": [
    ]
}

editProofCommentReplies

The endpoint in ProofHQ API updates the 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

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

getProofCommentReply

The endpoint in ProofHQ API retrieves the proof comment reply.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

token2
required
string

Reply Token

Responses

Response samples

Content type
application/json
{
  • "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": {
    },
  • "attachments": [
    ]
}

deleteProofCommentReply

The endpoint in ProofHQ API deletes the proof comment reply.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

token2
required
string

Reply Token

Responses

Response samples

Content type
application/json
{ }

editProofCommentReply

The endpoint in ProofHQ API updates the 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

Request samples

Content type
application/json
{
  • "text": "string",
  • "editedAt": 0
}

Response samples

Content type
application/json
{
  • "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": {
    },
  • "attachments": [
    ]
}

createProofCommentReplyAttachment

The endpoint in ProofHQ API creates the proof comment reply attachments.

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

Request samples

Content type
application/json
{
  • "assetId": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "mime": "string",
  • "name": "string",
  • "size": 0,
  • "downloadUrl": "string",
  • "permissions": {
    }
}

getProofCommentReplyAttachments

The endpoint in ProofHQ API retrieves the proof comment reply attachments.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Proof Token

token1
required
string

Comment Token

token2
required
string

Reply Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getProofCommentReplyAttachment

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
{
  • "token": "string",
  • "mime": "string",
  • "name": "string",
  • "size": 0,
  • "downloadUrl": "string",
  • "permissions": {
    }
}

editProofCommentReplyAttachment

The endpoint in ProofHQ API updates the 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

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "mime": "string",
  • "name": "string",
  • "size": 0,
  • "downloadUrl": "string",
  • "permissions": {
    }
}

deleteProofCommentReplyAttachment

The endpoint in ProofHQ API deletes the 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

Response samples

Content type
application/json
{ }

getProofCommentReplyAttachmentFile

The endpoint in ProofHQ API retrieves the 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

getProofCommentReplyAttachmentThumbnail

The endpoint in ProofHQ API retrieves the 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

Settings

getProofLimits

The endpoint in ProofHQ API retrieves the account limits.

Authorizations:
SessionIdAuthJwtAuth

Responses

Response samples

Content type
application/json
{
  • "proofs": 0,
  • "storage": 0
}

getProofingSettings

The endpoint in ProofHQ API retrieves the profile settings for proofing.

Authorizations:
SessionIdAuthJwtAuth

Responses

Response samples

Content type
application/json
{
  • "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

Response samples

Content type
application/json
"string"

Tags

getTags

The endpoint in ProofHQ API retrieves the tags list and can be filtered by limit and offset.

Authorizations:
SessionIdAuthJwtAuth
query Parameters
limit
integer

?limit=N (max 100)

offset
integer

?offset=N

Responses

Response samples

Content type
application/json
[
  • {
    }
]

createTag

The endpoint in ProofHQ API creates the tags.

Authorizations:
SessionIdAuthJwtAuth
Request Body schema: application/json
Array (non-empty)
name
required
string <= 30 characters

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

getTag

The endpoint in ProofHQ API retrieves the tag.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Tage Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "name": "string",
  • "usage": 0,
  • "created": 0,
  • "modified": 0,
  • "permissions": {
    }
}

Upload

uploadDocument

The endpoint in ProofHQ API uploads a document.

Authorizations:
SessionIdAuthJwtAuth
Request Body schema:
Array
url
string
object

Responses

Request samples

Content type
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Users

getUsers

The endpoint in ProofHQ API retrieves the users list.

Authorizations:
SessionIdAuthJwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getUser

The endpoint in ProofHQ API retrieves the user.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

User Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "name": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "dateFormat": "string",
  • "dateTimezone": "string",
  • "language": "string"
}

getUserAvatar

The endpoint in ProofHQ API retrieves the user avatar.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

User Token

Responses

Workflow

getWorkflowTemplates

The endpoint in ProofHQ API retrieves the workflow templates list.

Authorizations:
SessionIdAuthJwtAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getWorkflowTemplate

The endpoint in ProofHQ API retrieves the workflow template.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Template Token

Responses

Response samples

Content type
application/json
{
  • "token": "string",
  • "name": "string",
  • "timezone": "string",
  • "ownerToken": "string",
  • "groupToken": 0,
  • "groupName": "string",
  • "isPrimaryGroup": true,
  • "permissions": {
    }
}

getWorkflowTemaplateStages

The endpoint in ProofHQ API retrieves the workflow template stages.

Authorizations:
SessionIdAuthJwtAuth
path Parameters
token
required
string

Template Token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

getWorkflowTemplateStageRecipients

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
[
  • {
    }
]

Workfront User

getWorkfrontUser

The endpoint in ProofHQ API retrieves the 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

Response samples

Content type
application/json
{
  • "contactToken": "string",
  • "email": "string",
  • "profileToken": "string",
  • "referenceId": "string",
  • "apiToken": "string"
}

updateWorkfrontUser

The endpoint in ProofHQ API updates the workfront user.

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
imsUserId
string
imsOrgId
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "hasProofingLicense": true,
  • "isExternal": true,
  • "permissionId": 0,
  • "defaultRecipientRole": 0,
  • "isActive": true,
  • "isFromSso": true,
  • "imsUserId": "string",
  • "imsOrgId": "string"
}

Response samples

Content type
application/json
{
  • "contactToken": "string",
  • "email": "string",
  • "profileToken": "string",
  • "referenceId": "string",
  • "apiToken": "string"
}

deleteWorkfrontUser

The endpoint in ProofHQ API deletes the 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

Response samples

Content type
application/json
{ }

createWorkfrontUser

The endpoint in ProofHQ API creates the workfront user in 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
imsUserId
string
imsOrgId
string

Responses

Request samples

Content type
application/json
{
  • "referenceId": "string",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "hasProofingLicense": true,
  • "isExternal": true,
  • "permissionId": 0,
  • "defaultRecipientRole": 0,
  • "isActive": true,
  • "isFromSso": true,
  • "imsUserId": "string",
  • "imsOrgId": "string"
}

Response samples

Content type
application/json
{
  • "contactToken": "string",
  • "email": "string",
  • "profileToken": "string",
  • "referenceId": "string",
  • "apiToken": "string"
}