Manuscript API reference 🔒 Restricted

The complete v1.0.0 surface: 12 operations and 34 schemas, generated from the service’s own OpenAPI document so this page cannot drift from the API. For what the manuscript is and how it joins the score, start at the Manuscript API overview.

Operations Webhook events Schemas

Reference

Operations

Grouped by tag, exactly as the OpenAPI document declares them. Every operation returns the shared error shape on failure; expand a schema in the schema tables for field-level detail.

Assessments

GET /api/v1/assessmentsExpand

Parameters

Name	In	Required	Type
Page	query	Optional	string
PageSize	query	Optional	string

Responses

Status	Meaning	Schema
200	OK	AssessmentPagedList
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse

GET /api/v1/assessments/responses/{Id}Expand

Parameters

Name	In	Required	Type
Id	path	Required	string

Responses

Status	Meaning	Schema
200	OK	AssessmentResponseModel
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

GET /api/v1/assessments/{Id}Expand

Parameters

Name	In	Required	Type
Id	path	Required	string
From	query	Optional	string
To	query	Optional	string
Page	query	Optional	string
PageSize	query	Optional	string

Responses

Status	Meaning	Schema
200	OK	AssessmentResponseModelPagedList
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

Documents

GET /api/v1/documents/templatesExpand

Parameters

Name	In	Required	Type
UserEmail	query	Optional	string
Page	query	Optional	string
PageSize	query	Optional	string

Responses

Status	Meaning	Schema
200	OK	TemplatePagedList
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse

GET /api/v1/documents/templates/{Id}Expand

Parameters

Name	In	Required	Type
Id	path	Required	string

Responses

Status	Meaning	Schema
200	OK	TemplateDetails
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

POST /api/v1/documentsExpand

Request body (required, application/json)

CreateDocumentBody

Responses

Status	Meaning	Schema
201	Created	CreatedDocument
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

GET /api/v1/documents/{Id}Expand

Parameters

Name	In	Required	Type
Id	path	Required	string

Responses

Status	Meaning	Schema
200	OK	Document
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

Surveys

GET /api/v1/surveysExpand

Parameters

Name	In	Required	Type
Page	query	Optional	string
PageSize	query	Optional	string

Responses

Status	Meaning	Schema
200	OK	SurveyPagedList
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse

GET /api/v1/surveys/{Id}Expand

Parameters

Name	In	Required	Type
Id	path	Required	string
From	query	Optional	string
To	query	Optional	string
Page	query	Optional	string
PageSize	query	Optional	string

Responses

Status	Meaning	Schema
200	OK	SurveyResponsePagedList
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

GET /api/v1/surveys/responses/{Id}Expand

Parameters

Name	In	Required	Type
Id	path	Required	string

Responses

Status	Meaning	Schema
200	OK	SurveyResponseData
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

Workflows

GET /api/v1/workflows/{Id}/signed-pdfExpand

Parameters

Name	In	Required	Type
Id	path	Required	string

Responses

Status	Meaning	Schema
200	OK	no body (binary or empty)
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

GET /api/v1/workflows/{Id}Expand

Parameters

Name	In	Required	Type
Id	path	Required	string

Responses

Status	Meaning	Schema
200	OK	Workflow
400	Bad Request	ErrorResponse
401	Unauthorized	ErrorResponse
404	Not Found	ErrorResponse

Developer access

The Manuscript endpoints are for registered developers

Every operation with its parameters, request body and responses, free with a developer account.

Get free access → Registered developers are recognised automatically.

Events

Webhook events

A document created with an eventNotification notifies your URL on the events you choose. Deliveries are signed; the verification rules live on the overview page and are implemented, with tests, in adapter/webhook_verify.py.

Event type
DocumentInReview
DocumentCompleted
DocumentArchived
DocumentUnarchived
DocumentDeleted
WorkflowDocuSignStarted
WorkflowDocuSignCompleted
WorkflowDocuSignVoided
WorkflowDocuSignDeclined
WorkflowDocuSignRecipientUpdate

Shapes

Schemas

Every component schema in the document, alphabetically. Types link between tables.

AddressFormModelExpand

Property	Type	Constraints	Description
name	string	max 200 · nullable
line1	string	max 200
line2	string	max 200 · nullable
city	string	max 200 · nullable
stateProvinceRegion	string	max 200 · nullable
zipPostalCode	string	max 20 · nullable
country	string	nullable	Must be a valid ISO country code
isEmpty	boolean	read-only

AssessmentExpand

Property	Type	Constraints
id	string (uuid)
depReference	string	nullable
name	string	nullable
groupName	string	nullable
status	string	nullable
responses	integer (int32)
tags	array of string	nullable

AssessmentPagedListExpand

Property	Type	Constraints
items	array of Assessment	nullable
page	integer (int32)
pageSize	integer (int32)
totalCount	integer (int32)
hasNextPage	boolean	read-only
hasPreviousPage	boolean	read-only

AssessmentResponseModelExpand

Property	Type	Constraints
responseId	string (uuid)
depReference	string	nullable
externalId	string	nullable
user	string	nullable
startDate	string	nullable
endDate	string	nullable
score	string	nullable
scoreDescription	string	nullable
sectionScores	array of AssessmentResponseSectionScore	nullable
questions	array of AssessmentResponseQuestion	nullable
notes	array of AssessmentResponseNote	nullable
rankedScores	array of AssessmentResponseRankedScore	nullable

AssessmentResponseModelPagedListExpand

Property	Type	Constraints
items	array of AssessmentResponseModel	nullable
page	integer (int32)
pageSize	integer (int32)
totalCount	integer (int32)
hasNextPage	boolean	read-only
hasPreviousPage	boolean	read-only

AssessmentResponseNoteExpand

Property	Type	Constraints
createdBy	string	nullable
createdAt	string (date-time)
text	string	nullable

AssessmentResponseQuestionExpand

Property	Type	Constraints
sectionName	string	nullable
questionOrder	integer (int32)
id	string (uuid)
text	string	nullable
answerValue	string	nullable
viewedAt	array of string (date-time)	nullable
answeredAt	string (date-time)	nullable
choiceOrder	integer (int32)	nullable

AssessmentResponseRankedScoreExpand

Property	Type	Constraints
name	string	nullable
rank	integer (int32)
pointsScored	integer (int32)	nullable

AssessmentResponseSectionScoreExpand

Property	Type	Constraints	Description
name	string	nullable
score	string	nullable

CreateDocumentBodyExpand

Property	Type	Constraints	Description
ownerEmail	string	nullable
coAuthorEmail	string	nullable
documentName	string	max 200 · nullable
externalId	string	max 64 · nullable
templateId	string	nullable
templateFields	object	nullable	Entity data must be passed in as keys on this object, matching the entity names and types for the template. The entity names and types can be fetched from 'Get template' endpoint. The structures for each entity type are listed as properties below.
eventNotification	WebhookConfiguration

CreatedDocumentExpand

Property	Type	Constraints	Description
id	string	nullable
url	string	nullable

CustomLookupDetailsExpand

Property	Type	Constraints	Description
name	string	nullable
description	string	nullable

DocumentExpand

Property	Type	Constraints
id	string	nullable
name	string	nullable
externalId	string	nullable
createdBy	DocumentUser
createdDate	string (date-time)
completedDate	string (date-time)	nullable
publishedDate	string (date-time)	nullable
inReviewDate	string (date-time)	nullable
internalReviewStartedDate	string (date-time)	nullable
externalReviewStartedDate	string (date-time)	nullable
internalReviewCompletedDate	string (date-time)	nullable
externalReviewCompletedDate	string (date-time)	nullable
reviewCompletedDate	string (date-time)	nullable
archivedDate	string (date-time)	nullable
status	string	nullable
templateName	string	nullable
templateVersion	string	nullable
type	string	nullable
currency	string	nullable
internalCoAuthors	array of DocumentUser	nullable
owner	DocumentUser
externalCoAuthors	array of DocumentUser	nullable
internalCollaborators	array of DocumentUser	nullable
externalCollaborators	array of ExternalCollaborator	nullable
entities	object	nullable
workflows	array of WorkflowSummary	nullable

DocumentUserExpand

Property	Type	Constraints	Description
name	string	nullable
email	string	nullable

DocumentWebhookEventExpand

Values (string)
DocumentInReview
DocumentCompleted
DocumentArchived
DocumentUnarchived
DocumentDeleted
WorkflowDocuSignStarted
WorkflowDocuSignCompleted
WorkflowDocuSignVoided
WorkflowDocuSignDeclined
WorkflowDocuSignRecipientUpdate

ErrorDetailExpand

Property	Type	Constraints
code	string	nullable
description	string	nullable
type	integer (int32)

ErrorResponseExpand

Property	Type	Constraints
type	string	nullable
title	string	nullable
status	integer (int32)
errors	array of ErrorDetail	nullable
traceId	string	nullable

ExternalCollaboratorExpand

Property	Type	Constraints
name	string	nullable
email	string	nullable
company	string	nullable

IntegrationEntityTypeExpand

Values (string)
TextShort
TextLong
Number
CustomLookup
Address

JsonNodeExpand

Property	Type	Constraints	Description
options	JsonNodeOptions
parent	JsonNode
root	JsonNode

JsonNodeOptionsExpand

Property	Type	Constraints	Description
propertyNameCaseInsensitive	boolean

SurveyExpand

Property	Type	Constraints
id	string	nullable
name	string	nullable
responses	integer (int32)
averageRating	number (double)

SurveyPagedListExpand

Property	Type	Constraints
items	array of Survey	nullable
page	integer (int32)
pageSize	integer (int32)
totalCount	integer (int32)
hasNextPage	boolean	read-only
hasPreviousPage	boolean	read-only

SurveyResponseExpand

Property	Type	Constraints
id	string	nullable
user	string	nullable
submitted	string (date-time)
questions	array of SurveyResponseQuestion	nullable

SurveyResponseDataExpand

Property	Type	Constraints
user	string	nullable
submitted	string (date-time)
questions	array of SurveyResponseQuestion	nullable

SurveyResponsePagedListExpand

Property	Type	Constraints
items	array of SurveyResponse	nullable
page	integer (int32)
pageSize	integer (int32)
totalCount	integer (int32)
hasNextPage	boolean	read-only
hasPreviousPage	boolean	read-only

SurveyResponseQuestionExpand

Property	Type	Constraints
question	string	nullable
rating	integer (int32)
answer	string	nullable

TemplateExpand

Property	Type	Constraints	Description
id	string	nullable
name	string	nullable

TemplateDetailsExpand

Property	Type	Constraints
name	string	nullable
lastUpdated	string (date-time)
businessOwner	string	nullable
templateFields	array of TemplateField	nullable

TemplateFieldExpand

Property	Type	Constraints
identifier	string	nullable
type	IntegrationEntityType
customLookup	CustomLookupDetails

TemplatePagedListExpand

Property	Type	Constraints
items	array of Template	nullable
page	integer (int32)
pageSize	integer (int32)
totalCount	integer (int32)
hasNextPage	boolean	read-only
hasPreviousPage	boolean	read-only

WebhookConfigurationExpand

Property	Type	Constraints	Description
webhookUrl	string	nullable
events	array of DocumentWebhookEvent	nullable

WorkflowExpand

Property	Type	Constraints
id	string	nullable
parentId	string	nullable
parentType	string	nullable
type	string	nullable
status	string	nullable
createdDate	string (date-time)
lastUpdatedDate	string (date-time)
data	any	nullable

WorkflowSummaryExpand

Property	Type	Constraints
id	string	nullable
type	string	nullable
status	string	nullable

Developer access

The Manuscript schemas are for registered developers

Field-level request and response shapes, free with a developer account.

Get free access → Registered developers are recognised automatically.

Keep going

Manuscript API overview composerID API reference Changelog