Conga Package API

openapi: 3.2.0
info:
  title: Conga Sign Package API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/sign
security:
- JWT: []
tags:
- name: Package
paths:
  /v1/cs-packages:
    post:
      tags:
      - Package
      summary: Create a package
      description: Creates a new package or a template with no attachments. To create a template, set Type to Template. To create a package with attachments, see "Create a package with attachments".
      operationId: Package_CreatePackage
      requestBody:
        x-name: package
        description: Package initial information. Though this does not need to be fully filled, it must contain at least the "name" property.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Package'
        required: true
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    get:
      tags:
      - Package
      summary: List packages
      description: Retrieves a list of document packages in an account. By default, this call returns the API caller's packages. When either the ownerUserId or ownerEmail query parameter is specified, this call returns the specified user's transactions. To retrieve other users' transactions, roles and permissions must be enabled on your account and the API caller must have "Manage users’ transactions, templates, layouts" permission. To enable roles and permissions, contact your Conga Sign sales representative.
      operationId: Package_ListPackages
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultOfPackage'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}:
    delete:
      tags:
      - Package
      summary: Delete a package
      description: Deletes a specified package or template.
      operationId: Package_DeletePackageById
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '204':
          description: No Content
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    get:
      tags:
      - Package
      summary: Get package information
      description: Retrieves information about a document package.
      operationId: Package_GetPackageById
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      - name: rawSignatureCapture
        in: query
        description: If set to true, signatures are provided as a vector.
        schema:
          type: boolean
          default: false
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    put:
      tags:
      - Package
      summary: Update a package
      description: Updates the information pertaining to a specified package.
      operationId: Package_UpdatePackage
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: package
        description: Package initial information. Though this does not need to be fully filled, it must contain at least the "name" property.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Package'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/audit:
    get:
      tags:
      - Package
      summary: Get package audit details
      description: Retrieves a package's audit details. The audit trail is embedded directly in the package and can be viewed any time.
      operationId: Package_GetPackageAudit
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExportedAuditTrail'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/bulk_send:
    post:
      tags:
      - Package
      summary: Create packages
      description: 'Create and send packages using bulk send. The package ID must be of type template.


        **Prerequisites**

        * Enable the bulk send feature in your account.

        * Create an eligible template. A template is considered eligible if it contains at least one document that is not the consent agreement, placeholder role, and signature field.

        * Create a CSV file with recipient details. The file must include placeholder, first name, last name, and email columns.


        This API returns a bulk send batch ID.'
      operationId: Package_CreatePackagesUsingBulkSend
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                File:
                  type:
                  - string
                  - 'null'
                  format: binary
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Package'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/clone:
    post:
      tags:
      - Package
      summary: Re-create a package or template
      description: Creates a package or template from an existing package or template. To create a template, set type in the request body to "TEMPLATE".
      operationId: Package_CreatePackageClone
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      requestBody:
        x-name: package
        description: "In case of template, a new name field must be provided.\n            You can overwrite any of the cloned package or template fields, by adding it to the JSON body, following the Package structure. The owner of the new package is by default the request user. You can specify the owner of the new package by adding a sender object to the JSON body."
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Package'
        required: true
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/evidence/summary:
    get:
      tags:
      - Package
      summary: Summarize package evidence
      description: Retrieves summary evidence information for a specified package.
      operationId: Package_GetPackageEvidenceSummary
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/fieldSummary:
    get:
      tags:
      - Package
      summary: List package fields
      description: Retrieves a list of form fields in a package. Fields are grouped by document and by signer.
      operationId: Package_GetPackageFieldSummary
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FieldSummary'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/readiness:
    get:
      tags:
      - Package
      summary: Get package readiness
      description: Retrieves a package's readiness to be sent for signature. This API returns a True status when the package is ready to send.
      operationId: Package_GetPackageReadiness
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageReadiness'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/referencedConditions:
    get:
      tags:
      - Package
      operationId: Package_GetPackageReferencedConditions
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      - name: documentId
        in: query
        schema:
          type: string
        x-position: 2
      - name: fieldId
        in: query
        schema:
          type: string
        x-position: 3
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReferencedConditions'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
      summary: Package get package referenced conditions
      x-summary-source: derived
  /v1/cs-packages/{packageId}/roles/{roleId}/signingUrl:
    get:
      tags:
      - Package
      summary: Get package signature URL
      description: Retrieves the URL that a signer can use to sign a package. This can only be done to a package that is not modifiable (e.g., a sent package). It cannot be done to a package in a draft state.
      operationId: Package_GetSigningUrlByRoleId
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      - name: roleId
        in: path
        required: true
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningUrl'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/signers/{signerId}/approvals:
    get:
      tags:
      - Package
      summary: Retrieve all approvals by signer
      description: Retrieves all approvals for a specified signer in a specific package.
      operationId: Package_GetPackageSignerApprovals
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      - name: signerId
        in: path
        required: true
        description: The unique signer ID.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultOfRole'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/signingStatus:
    get:
      tags:
      - Package
      summary: Get package signing status
      description: Retrieves the signing status of a package. Retrieved information can be filtered by signer or by document.
      operationId: Package_GetPackageSigningStatus
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package identifier.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningStatus'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
components:
  schemas:
    FieldCondition:
      type: object
      description: Object to manage field conditions
      additionalProperties: false
      properties:
        id:
          type: string
          description: The id of the field condition
        condition:
          type: string
          description: The condition that determines if action is needed
        action:
          type: string
          description: The action to take when the condition is true
    PackageSettings:
      type: object
      description: Object to manage package settings
      additionalProperties: false
      properties:
        ceremony:
          description: CeremonySettings
          oneOf:
          - $ref: '#/components/schemas/CeremonySettings'
    Quota:
      type: object
      additionalProperties: false
      properties:
        cycle:
          type: string
        limit:
          type: integer
          format: int32
        scope:
          type: string
        target:
          $ref: '#/components/schemas/Target'
    SignerInformationForEquifaxCanada:
      type: object
      description: Object to manage Equifax Canada information
      additionalProperties: false
      properties:
        city:
          type: string
          description: City
        dateOfBirth:
          type:
          - string
          - 'null'
          description: Date of birth
          format: date-time
        driversLicenseNumber:
          type: string
          description: Drivers license number
        firstName:
          type: string
          description: First name
        homePhoneNumber:
          type: string
          description: Home phone number
        lastName:
          type: string
          description: Last name
        socialInsuranceNumber:
          type: string
          description: Social insurance number
        province:
          type: string
          description: Province
        streetAddress:
          type: string
          description: Street address
        timeAtAddress:
          type:
          - integer
          - 'null'
          description: Time at address
          format: int32
        postalCode:
          type: string
          description: Postal code
    LayoutOptions:
      type: object
      description: Object to manage layout options
      additionalProperties: false
      properties:
        brandingBar:
          description: Branding bar options
          oneOf:
          - $ref: '#/components/schemas/BrandingBarOptions'
        footer:
          description: Footer options
          oneOf:
          - $ref: '#/components/schemas/FooterOptions'
        header:
          description: Header options
          oneOf:
          - $ref: '#/components/schemas/HeaderOptions'
        iframe:
          type:
          - boolean
          - 'null'
          description: Determines if the page is iframed
        navigator:
          type:
          - boolean
          - 'null'
          description: Navigator
    Address:
      type: object
      additionalProperties: false
      properties:
        address1:
          type: string
          description: Address1
        address2:
          type: string
          description: Address2
        city:
          type: string
          description: City
        country:
          type: string
          description: Country
        state:
          type: string
          description: State
        zipcode:
          type: string
          description: Zipcode
    AttachmentFile:
      type: object
      description: Attachment file information.
      additionalProperties: false
      properties:
        id:
          type: integer
          description: Attachment file Id.
          format: int32
        insertDate:
          type: integer
          description: Attachment creation date in epoch format.
          format: int64
        name:
          type: string
          description: Attachment file name.
        preview:
          type: boolean
          description: Can see attachment previews.
    FieldType:
      type: string
      description: ''
      x-enumNames:
      - SIGNATURE
      - INPUT
      - IMAGE
      enum:
      - SIGNATURE
      - INPUT
      - IMAGE
    Group:
      type: object
      description: Object to manage a group
      additionalProperties: false
      properties:
        account:
          description: The account the group belongs to
          oneOf:
          - $ref: '#/components/schemas/Account'
        created:
          type:
          - string
          - 'null'
          description: Created date
          format: date-time
        data:
          type: object
          description: Custom data
          additionalProperties: {}
        email:
          type: string
          description: Email address
        emailMembers:
          type: boolean
          description: EmailMembers
        id:
          type: string
          description: Unique id of the group
        members:
          type: array
          description: List of group members
          items:
            $ref: '#/components/schemas/GroupMember'
        name:
          type: string
          description: Name of the group
        updated:
          type:
          - string
          - 'null'
          description: Updated date
          format: date-time
        reciprocalDelegation:
          type: boolean
          description: Reciprocal Delegation
    Field:
      type: object
      description: Approval fields object.
      additionalProperties: false
      properties:
        binding:
          type: string
          description: Binding
        data:
          type: object
          description: Custom data for the field
          additionalProperties: {}
        extract:
          type: boolean
          description: Determines if field is to be extracted
        extractAnchor:
          description: Field extraction anchor.
          oneOf:
          - $ref: '#/components/schemas/ExtractAnchor'
        height:
          type: number
          description: Field height.
          format: double
        id:
          type: string
          description: Field Id.
        left:
          type: number
          description: X coordinate of the field
          format: double
        name:
          type: string
          description: Field name.
        page:
          type: integer
          description: The document page where the field is located
          format: int32
        subtype:
          type: string
          description: Field subtype
        top:
          type: number
          description: Y coordinate of the field
          format: double
        type:
          description: Field type.
          oneOf:
          - $ref: '#/components/schemas/FieldType'
        validation:
          description: Field validation information
          oneOf:
          - $ref: '#/components/schemas/FieldValidation'
        value:
          type: string
          description: The field value
        fontSize:
          type:
          - integer
          - 'null'
          description: Field font size.
          format: int32
        width:
          type: number
          description: Field width.
          format: double
    AccountProviders:
      type: object
      additionalProperties: false
      properties:
        documents:
          type: array
          description: List of external sources for documents
          items:
            $ref: '#/components/schemas/Provider'
        users:
          type: array
          description: List of external sources for users
          items:
            $ref: '#/components/schemas/Provider'
    SignedDocumentDelivery:
      type: object
      description: Object to manage signed document delivery
      additionalProperties: false
      properties:
        destinations:
          type: array
          description: List of provider destinations for document delivery
          items:
            $ref: '#/components/schemas/External'
        excludedDocuments:
          type: array
          description: List of documents to exclude
          items:
            $ref: '#/components/schemas/Document'
        filePrefix:
          type: string
          description: File prefix
        fileSuffix:
          type: string
          description: File suffix
    SenderType:
      type: string
      description: ''
      x-enumNames:
      - REGULAR
      - MANAGER
      enum:
      - REGULAR
      - MANAGER
    SenderStatus:
      type: string
      description: ''
      x-enumNames:
      - INVITED
      - ACTIVE
      - LOCKED
      enum:
      - INVITED
      - ACTIVE
      - LOCKED
    AuditType:
      type: string
      description: ''
      x-enumNames:
      - Accept
      - ClickToSign
      - ClickToInitial
      - CaptureSignature
      - Confirm
      - Download
      - DownloadZip
      - FormField
      - Login
      - View
      - OptOut
      - SigningSessionForRecipient
      - Decline
      enum:
      - Accept
      - ClickToSign
      - ClickToInitial
      - CaptureSignature
      - Confirm
      - Download
      - DownloadZip
      - FormField
      - Login
      - View
      - OptOut
      - SigningSessionForRecipient
      - Decline
    ReferencedField:
      type: object
      description: Object to manage a referenced field
      additionalProperties: false
      properties:
        fieldId:
          type: string
          description: FieldId
        conditions:
          description: List of referenced field conditions
          oneOf:
          - $ref: '#/components/schemas/ReferencedFieldConditions'
    Role:
      type: object
      additionalProperties: false
      properties:
        attachmentRequirements:
          type: array
          description: Signer attachment requirements.
          items:
            $ref: '#/components/schemas/AttachmentRequirement'
        data:
          type: object
          description: Role metadata.
          additionalProperties: {}
        emailMessage:
          description: Role email message.
          oneOf:
          - $ref: '#/components/schemas/BaseMessage'
        id:
          type: string
          description: Role Id.
        index:
          type: integer
          description: Role signing order index.
          format: int32
        locked:
          type: boolean
          description: Is role locked. Role will be locked after failing to sign in multiple times.
        name:
          type: string
          description: Role name.
        reassign:
          type: boolean
          description: Is the role able to reassign.
        signers:
          type: array
          description: Signers associated with the role.
          items:
            $ref: '#/components/schemas/Signer'
        specialTypes:
          type: array
          description: Special signer features. Currently only NOTARY is supported.
          items:
            type: string
        type:
          description: Role type. Currently there are two types, SIGNER and SENDER.
          oneOf:
          - $ref: '#/components/schemas/RoleType'
        downloadEvidenceSummaryBySigner:
          type: boolean
          description: Indicates whether the signer assigned to this role can download the evidence summary once signing is complete.
    AnchorPointType:
      type: string
      description: ''
      x-enumNames:
      - TOPLEFT
      - BOTTOMLEFT
      - TOPRIGHT
      - BOTTOMRIGHT
      enum:
      - TOPLEFT
      - BOTTOMLEFT
      - TOPRIGHT
      - BOTTOMRIGHT
    GroupMember:
      type: object
      description: Object to manage a group member
   

# --- truncated at 32 KB (92 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-package-api-openapi.yml