How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Conga Documents API

The Documents API from Conga — 38 operation(s) for documents.

Conga Documents API is one of 347 APIs that Conga publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Documents. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 51 operations across 38 paths, and defines 121 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://rls.congacloud.com/api/sign, https://rls.congacloud.com, https://rls.congacloud.com/api/ingress.

51 operations 38 paths 121 schemas 7 DELETE17 GET20 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://rls.congacloud.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Conga Documents API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (JWT). An API key is passed in the header as Authorization (Bearer).

  • JWT — Provide oauth authentication
  • Bearer — Please insert JWT with Bearer into field

Paths & Operations 51

Across 38 paths, the API surfaces 51 operations — 7 DELETE, 17 GET, 20 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Documents 51
POST
/v1/cs-packages/{packageId}/documents
Add a new document to an existing package
Documents_CreateDocument 1 param body → 200400401404500
DELETE
/v1/cs-packages/{packageId}/documents
Delete multiple documents from a package
Documents_DeleteDocuments 1 param body → 204400401403404500
PUT
/v1/cs-packages/{packageId}/documents
Update documents
Documents_UpdateDocuments 1 param body → 200400401403404500
GET
/v1/cs-packages/{packageId}/documents/all-documents/zip
Retrieve zipped file containing all documents including supporting documents
Documents_GetAllDocumentsZip 2 params → 200400401403404500
POST
/v1/cs-packages/{packageId}/documents/signConfirm
Create a signature confirmation
Documents_CreateSignatureConfirmation 1 param body → 200400401403404500
POST
/v1/cs-packages/{packageId}/documents/signed_documents
Sign all documents in a package
Documents_SignAllDocuments 1 param body → 200400401403404500
GET
/v1/cs-packages/{packageId}/documents/visibility
Retrieve document visibility information
Documents_GetDocumentVisibility 1 param → 200400401500
POST
/v1/cs-packages/{packageId}/documents/visibility
Update document visibility
Documents_UpdateDocumentsVisibility 1 param body → 204400401500
GET
/v1/cs-packages/{packageId}/documents/zip
Retrieve zipped documents
Documents_GetZip 2 params → 200400401403404500
DELETE
/v1/cs-packages/{packageId}/documents/{documentId}
Delete a document from a package
Documents_DeleteDocument 2 params → 204400401403404500
GET
/v1/cs-packages/{packageId}/documents/{documentId}
Retrieve the specified document
Documents_GetDocument 2 params → 200400401403404500
POST
/v1/cs-packages/{packageId}/documents/{documentId}
Update a document
Documents_UpdateDocument 2 params body → 200400401403404500
PUT
/v1/cs-packages/{packageId}/documents/{documentId}
Update the specified document
Documents_UpdateDocumentPut 2 params body → 200400401403404500
PUT
/v1/cs-packages/{packageId}/documents/{documentId}/fields
Replace approvals and imprint fields for a document
Documents_ReplaceDocumentFields 2 params body → 200400401404500
POST
/v1/cs-packages/{packageId}/documents/{documentId}/layout
Apply a layout to a document
Documents_ApplyLayoutToDocument 5 params → 204400401403404500
PUT
/v1/cs-packages/{packageId}/documents/{documentId}/metadata
Update document custom metadata
Documents_UpdateDocumentMetadata 2 params body → 200400401403404406500
GET
/v1/cs-packages/{packageId}/documents/{documentId}/original
Retrieve an original PDF document
Documents_GetOriginalDocument 2 params → 200400401403404500
GET
/v1/cs-packages/{packageId}/documents/{documentId}/pages/{index}
Retrieve a page
Documents_GetDocumentPageByIndex 3 params → 200400401403404500
GET
/v1/cs-packages/{packageId}/documents/{documentId}/pdf
Retrieve a specific document in PDF form
Documents_GetPdfDocument 2 params → 200400401403404500
DELETE
/api/document-management/v1/documents
Delete documents by their IDs
body → 200400404500
POST
/api/document-management/v1/documents
Upload documents
7 params body → 200400404500
GET
/api/document-management/v1/documents/bulk
Get documents by their IDs
2 params → 200400404500
POST
/api/document-management/v1/documents/multipart-uploads
Initiate a multipart upload
body → 200400404500
GET
/api/document-management/v1/documents/objects/{objectId}
Get documents by object ID and file type
2 params → 200400500
DELETE
/api/document-management/v1/documents/objects/{objectType}/{objectId}
Delete documents by object type and ID
2 params → 200400500
GET
/api/document-management/v1/documents/objects/{objectType}/{objectId}
Get documents by object type and ID
2 params → 200400500
GET
/api/document-management/v1/documents/objects/{objectType}/{objectId}/versions
Get version details by object type and ID
2 params → 200400500
POST
/api/document-management/v1/documents/search
Search documents using advanced query parameters
1 param body → 200400500
POST
/api/document-management/v1/documents/upload
Upload a single document
9 params body → 200400404500
DELETE
/api/document-management/v1/documents/{documentId}
Delete a document by its ID
2 params → 200400404500
PUT
/api/document-management/v1/documents/{documentId}
Update a document
6 params body → 200400404500
POST
/api/document-management/v1/documents/{documentId}/clone
Clone a document
1 param → 200400404500
GET
/api/document-management/v1/documents/{documentId}/exists
Check a document
1 param → 200400500
GET
/api/document-management/v1/documents/{documentId}/metadata
Get a document's metadata by its ID
1 param → 200400404500
PUT
/api/document-management/v1/documents/{documentId}/metadata
Update the document metadata information for all versions
1 param body → 200400404500
DELETE
/api/document-management/v1/documents/{documentId}/multipart-uploads
Abort a multipart upload
1 param body → 200400404500
POST
/api/document-management/v1/documents/{documentId}/multipart-uploads
Complete multipart upload
1 param body → 200400404500
PUT
/api/document-management/v1/documents/{documentId}/multipart-uploads
Upload a single part of a large file
4 params → 200400404500
GET
/api/document-management/v1/documents/{documentId}/versions
Retrieve document versions
1 param → 200400404500
DELETE
/api/document-management/v1/documents/{documentId}/versions/{versionId}
Delete a versioned document
2 params → 200400404500
GET
/api/document-management/v1/documents/{documentId}/versions/{versionId}
Get a document by its ID and version
2 params → 200400404500
GET
/api/document-management/v1/documents/{id}
Get document information by its ID
1 param → 200400404500
GET
/api/document-management/v1/documents/{id}/download
Get a document by its ID
1 param → 200400404500
POST
/v2/documents/convert
Convert documents' format
Documents_Convert 1 param → 200400401500
POST
/v2/documents/generate
Generate a document from merge templates and data sources
Documents_Generate 1 param → 200400401500
POST
/v2/documents/join
Join documents from multiple sources
Documents_Join 1 param → 200400401500
POST
/v2/documents/process
Documents_Process 1 param → 200400401500
POST
/v2/documents/protect
Change document protection
Documents_Protect 1 param → 200400401500
POST
/v2/documents/{documentId}/convert
Convert a document's format
Documents_Convert2 2 params → 200400401500
POST
/v2/documents/{documentId}/process
Documents_Process2 2 params → 200400401500
POST
/v2/documents/{documentId}/protect
Change document protection
Documents_Protect2 2 params → 200400401500

Schemas 121

The contract defines 121 schemas that model the data the API accepts and returns. The most detailed are DocumentMetadata (22 properties), ImprintField (18 properties), DocumentOutputConfiguration (16 properties), Document (16 properties). Each schema is shown below with its type and property counts.

Document
object
16 properties
SignedDocument
ImprintField
object
Imprint Field class
18 properties
Error2
object
Object representing an error condition
6 properties
SignedDocuments
object
Object to manage signing documents via api
2 properties
External
object
External integration provider settings.
4 properties
AnchorPointType
string
Field
object
Approval fields object.
16 properties
Approval
object
Signing Approval object.
12 properties
FieldValidation
object
Field validation object
9 properties
Entity
object
Object used to manage entities from Microsoft Dynamics
3 properties
Metadata
object
Metadata object for storing custom key-value pairs on documents. Internal metadata defined by OneSpan cannot be updated and will be ignored.
DocumentVisibility
object
Object to manage document visibility
4 properties
ImprintFieldType
string
DocumentVisibilityConfiguration
object
Object to manage document visibility
2 properties
Page
object
Object representing a page in a document
7 properties
DocumentFields
object
Document Fields object containing approvals and imprint fields. Used for replacing all fields on a document.
2 properties
ExtractAnchor
object
Text extraction anchor object.
8 properties
FieldType
string
ImprintFieldSubType
string
DocumentRequest
object
Schema for document
11 properties
UploadPartResponseAPIResponse
object
10 properties
DocumentMetadataUpdateRequest
object
Request to update metadata/schema information of the document
6 properties
UploadPartResponse
object
Upload part response
2 properties
Sort
object
2 properties
DocumentMetadataListAPIResponse
object
10 properties
InitMultipartUploadResponse
object
Init multipart upload response
3 properties
DocumentResponseListAPIResponse
object
10 properties
DocumentQuery
object
4 properties
DocumentResponse
object
2 properties
MultipartUploadRequest
object
Multipart uplaod request
3 properties
ErrorDetail
object
1 property
InitMultipartUploadResponseAPIResponse
object
10 properties
OrderBy
string
StringAPIResponse
object
10 properties
DocumentMetadataAPIResponse
object
10 properties
LookupObject
object
2 properties
DocumentMetadata
object
Document metadata
22 properties
CompleteMultipartUploadRequest
object
Complete multipart upload request
4 properties
HttpStatusCode
string
DocumentResponseAPIResponse
object
10 properties
PdfImageCompressionType
string
ConvertRequest
JobEntity
SortParams
object
2 properties
ProtectRequest
PaginationParams
object
2 properties
AttachmentQuery
DocumentProtectRequest
AttachmentSpec
PdfStandard
string
AttachmentInfo
object
4 properties
DocGenWorkflowAsyncResponse
BaseDocGenResponse
object
5 properties
HeaderOptions
QueryResult
object
4 properties
PicklistEntry
object
4 properties
WatermarkDirection
string
BaseDocGenWorkflowRequest
BaseTemplateSpec
object
2 properties
QueryCondition
object
3 properties
WatermarkOptions
object
10 properties
DocumentOutputConfiguration
object
16 properties
HeaderFooterStyle
object
7 properties
ProtectionOptions
object
4 properties
ObjectQuery
object
12 properties
PdfCompressionType
string
FooterOptions
ConditionJoinType
string
DataSource
object
6 properties
HeaderFooterActionType
string
Metadata_2
object
3 properties
SaveDocumentsParameters
object
10 properties
DocumentProcessRequest
BaseEntity
object
4 properties
DocumentType
string
TemplateSource
object
10 properties
BaseHeaderFooterOptions
object
2 properties
BaseSourceConfig
object
2 properties
HeaderFooterLayout
object
6 properties
DataSpec
FieldMetadata
WorkflowRequesterInfo
object
3 properties
PdfOutputConfig
object
6 properties
HttpResponse
object
1 property
TemplateSpec
BaseAttachmentSpec
object
1 property
PipeWriter
object
2 properties
EditRestrictionType
string
DocumentSpec
AttachmentSource
object
7 properties
PicklistMetadata
object
2 properties
WordOutputConfig
object
4 properties
CommonDataType
string
AttachmentSet
object
2 properties
JoinRequest
JoinWatermarkActionType
string
DocumentQuery_2
SortDirection
string
ProtectionOptions2
object
11 properties
BaseDocGenRequest
object
JoinHeaderFooterActionType
string
ProcessRequest
ProcessOptions
object
1 property
SubQueryType
string
EntityData
object
2 properties
BaseDataSpec
object
2 properties
EntityMetadata
ConditionalOperator
string
JoinOptions
object
5 properties
ComplexFieldMetadata
object
2 properties
HeaderFooterOptions
object
11 properties
DocumentDestination
object
6 properties
JobStatus
string
DocumentConvertRequest
MergeRequest
TextAlignment
string
DocumentSource
object
10 properties
JoinActionType
string
TemplateQuery
BaseDocumentSpec
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

conga-documents-api-openapi.yml Raw ↑

Other APIs Conga publishes across the network.

Conga Advantage Platform MCP Server
Conga GraphQL API
Conga 2. Order Actions API
Conga 3. Order Line Items API
Conga Account API
Conga Account Attachments Blacklist API
Conga Account Attachments Whitelist API
Conga Account Designer Settings API
Conga Account Email Reminder Settings API
Conga Account Feature Settings API
Conga Account Package Settings API
Conga Account Roles API
Where this information came from

This is an independent, third-party profile of Conga Documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.