Conga Reports API

openapi: 3.2.0
info:
  title: Conga Sign Reports API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/sign
security:
- JWT: []
tags:
- name: Reports
paths:
  /v1/cs-reports/completion:
    get:
      tags:
      - Reports
      summary: Report completions by sender
      description: Retrieves a completion report for the specified sender.
      operationId: Reports_GetCompletionReport
      parameters:
      - name: to
        in: query
        description: 'The last record that will be returned. Useful for pagination. '
        schema:
          type: string
          format: date-time
        x-position: 1
      - name: from
        in: query
        description: 'The first record that will be returned. Useful for pagination. '
        schema:
          type: string
          format: date-time
        x-position: 2
      - name: senderId
        in: query
        description: 'The sender for which to produce the report. '
        schema:
          type: string
        x-position: 3
      - name: status
        in: query
        description: 'Status of the package on which you want to search. '
        schema:
          type: string
        x-position: 4
      - name: summary
        in: query
        description: 'Get summarized report: omit signers and document information. '
        schema:
          type: boolean
        x-position: 5
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompletionReport'
        '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-reports/delegation:
    get:
      tags:
      - Reports
      summary: Report current sender's usage
      description: Retrieves a usage report for the sender currently logged into the account.
      operationId: Reports_GetDelegationReport
      parameters:
      - name: to
        in: query
        description: 'The last record that will be returned. Useful for pagination. '
        schema:
          type: string
          format: date-time
        x-position: 1
      - name: from
        in: query
        description: 'The first record that will be returned. Useful for pagination. '
        schema:
          type: string
          format: date-time
        x-position: 2
      - name: senderId
        in: query
        description: The sender for which to produce the report.
        schema:
          type: string
        x-position: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DelegationReport'
        '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-reports/sender-transaction-summary:
    get:
      tags:
      - Reports
      summary: Report senders' usage for this account
      description: Retrieves a paginated usage report for the sender currently logged into the account.
      operationId: Reports_GetSenderTransactionSummaryReport
      parameters:
      - name: startDate
        in: query
        description: 'The date from which to produce the report. '
        schema:
          type: string
          format: date-time
        x-position: 1
      - name: endDate
        in: query
        description: 'The date up to produce the report. '
        schema:
          type: string
          format: date-time
        x-position: 2
      - name: from
        in: query
        description: 'The first record that will be returned. Useful for pagination. '
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: to
        in: query
        description: 'The last record that will be returned. Useful for pagination. '
        schema:
          type: integer
          format: int32
        x-position: 4
      - name: senderId
        in: query
        description: 'The sender for which to produce the report. '
        schema:
          type: string
        x-position: 5
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageReport'
        '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-reports/transaction-detail/{transactionId}:
    get:
      tags:
      - Reports
      summary: Report transaction details for transactionId
      description: Retrieves a transaction details report for a specified transaction ID.
      operationId: Reports_GetTransactionDetailReportById
      parameters:
      - name: transactionId
        in: path
        required: true
        description: 'The unique transaction id. '
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PackageCompletionReport'
        '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-reports/transaction-summary:
    get:
      tags:
      - Reports
      summary: Retrieve a usage report of transactions
      description: Retrieves a paginated usage report for the current account.
      operationId: Reports_GetTransactionSummaryReport
      parameters:
      - name: startDate
        in: query
        description: 'The date from which to produce the report. '
        schema:
          type: string
          format: date-time
        x-position: 1
      - name: endDate
        in: query
        description: 'The date up to produce the report. '
        schema:
          type: string
          format: date-time
        x-position: 2
      - name: from
        in: query
        description: 'The first record that will be returned. Useful for pagination. '
        schema:
          type: integer
          format: int32
        x-position: 3
      - name: to
        in: query
        description: 'The last record that will be returned. Useful for pagination. '
        schema:
          type: integer
          format: int32
        x-position: 4
      - name: senderId
        in: query
        description: 'The sender for which to produce the report. '
        schema:
          type: string
        x-position: 5
      - name: status
        in: query
        description: "The transaction status.\n           Available values: DRAFT, SENT, COMPLETED, EXPIRED, ARCHIVED, DECLINED, OPTED_OUT, TRASHED"
        schema:
          type: string
        x-position: 6
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransactionSummaryReport'
        '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-reports/usage:
    get:
      tags:
      - Reports
      summary: Report this sender's usage
      description: Retrieves a usage report for the sender currently logged into the account.
      operationId: Reports_GetUsageReport
      parameters:
      - name: to
        in: query
        description: 'The last record that will be returned. Useful for pagination. '
        schema:
          type: string
          format: date-time
        x-position: 1
      - name: from
        in: query
        description: 'The first record that will be returned. Useful for pagination. '
        schema:
          type: string
          format: date-time
        x-position: 2
      - name: Accept
        in: header
        description: "Acceptable file types.\n           Available values: text/csv, application/json. "
        schema:
          type: string
        x-position: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageReport'
        '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: []
components:
  schemas:
    PackageSettings:
      type: object
      description: Object to manage package settings
      additionalProperties: false
      properties:
        ceremony:
          description: CeremonySettings
          oneOf:
          - $ref: '#/components/schemas/CeremonySettings'
    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.
    UsageReport:
      type: object
      description: 'The Usage Report displays, for each sender, the number of packages that are in each possible state

        (for example, DRAFT, SENT, COMPLETED).'
      additionalProperties: false
      properties:
        from:
          type:
          - string
          - 'null'
          description: The first usage record to be returned.
          format: date-time
        senders:
          type: array
          description: List of senders and their usage packages.
          items:
            $ref: '#/components/schemas/SenderUsageReport'
        to:
          type:
          - string
          - 'null'
          description: The last usage record to be returned.
          format: date-time
    GroupMembership:
      type: object
      description: Object to manage group membership
      additionalProperties: false
      properties:
        groupId:
          type: string
          description: GroupId
        groupName:
          type: string
          description: GroupName
        memberType:
          description: MemberType
          oneOf:
          - $ref: '#/components/schemas/MemberType'
    IdvWorkflow:
      type: object
      additionalProperties: false
      properties:
        id:
          type: string
          description: The unique Id of the Id verification workflow configuration.
        type:
          type: string
          description: The Id verification workflow type.
        tenant:
          type: string
          description: The customer alias.
        desc:
          type: string
          description: Id verification workflow description.
    AuthChallenge:
      type: object
      additionalProperties: false
      properties:
        answer:
          type: string
          description: Secret question answer.
        maskInput:
          type: boolean
          description: To hide the user input.
        question:
          type: string
          description: Secret question.
    SignerInformationForLexisNexis:
      type: object
      description: Signer identity details needed for LexisNexis verification.
      additionalProperties: false
      properties:
        firstName:
          type: string
          description: First name of the signer. (Required)
        lastName:
          type: string
          description: Last name of the signer. (Required)
        city:
          type: string
          description: City of the signer. (Required)
        zip:
          type: string
          description: ZIP or postal code of the signer. (Required)
        state:
          type: string
          description: State or province of the signer. (Optional)
        houseName:
          type: string
          description: House name of the signer’s residence. (Optional)
        flatOrApartmentNumber:
          type: string
          description: Flat or apartment number. (Optional)
        houseNumber:
          type: string
          description: House number of the signer’s residence. (Optional)
        socialSecurityNumber:
          type: string
          description: Social Security Number of the signer. (Optional)
        dateOfBirth:
          type:
          - string
          - 'null'
          description: Date of birth of the signer. (Optional)
          format: date-time
    DocumentCompletionReport:
      type: object
      description: A report for a document
      additionalProperties: false
      properties:
        completed:
          type: boolean
          description: Indicates if the document has been completed
        firstSigned:
          type:
          - string
          - 'null'
          description: Date the first approval was signed
          format: date-time
        id:
          type: string
          description: Unique id of the document
        lastSigned:
          type:
          - string
          - 'null'
          description: Date the last approval was signed
          format: date-time
        name:
          type: string
          description: Name of the document
    GroupMember:
      type: object
      description: Object to manage a group member
      additionalProperties: false
      properties:
        email:
          type: string
          description: Email string
        firstName:
          type: string
          description: First name
        lastName:
          type: string
          description: Last name
        memberType:
          description: MemberType
          oneOf:
          - $ref: '#/components/schemas/MemberType'
        pending:
          type:
          - boolean
          - 'null'
          description: Pending
        userId:
          type: string
          description: UserId
    SenderCompletionReport:
      type: object
      description: 'A Sender Completion Report contains information about your senders, their associated packages,

        and their package status.'
      additionalProperties: false
      properties:
        packages:
          type: array
          description: The list of packages.
          items:
            $ref: '#/components/schemas/PackageCompletionReport'
        sender:
          description: The sender information.
          oneOf:
          - $ref: '#/components/schemas/Sender'
    TextualSignatureStyle:
      type: object
      description: Object to manage a text signature
      additionalProperties: false
      properties:
        color:
          type: string
          description: Signature color.
        font:
          type: string
          description: Signature font.
    License:
      type: object
      description: License information.
      additionalProperties: false
      properties:
        created:
          type:
          - string
          - 'null'
          description: License creation date.
          format: date-time
        paidUntil:
          type:
          - string
          - 'null'
          description: Paid license expiration.
          format: date-time
        plan:
          description: License plan.
          oneOf:
          - $ref: '#/components/schemas/Plan'
        status:
          description: License status.
          oneOf:
          - $ref: '#/components/schemas/LicenseStatus'
        transactions:
          type: array
          description: Transactions associated with this license
          items:
            $ref: '#/components/schemas/Transaction'
    Signer:
      type: object
      description: Object to manage a signer
      additionalProperties: false
      properties:
        address:
          description: Signer address.
          oneOf:
          - $ref: '#/components/schemas/Address'
        auth:
          description: Auth settings.
          oneOf:
          - $ref: '#/components/schemas/Auth'
        company:
          type: string
          description: Signer's company name.
        created:
          type:
          - string
          - 'null'
          description: Signer creation date.
          format: date-time
        data:
          type: object
          description: Signer metadata.
          additionalProperties: {}
        delivery:
          description: Signer delivery settings.
          oneOf:
          - $ref: '#/components/schemas/Delivery'
        email:
          type: string
          description: Signer email.
        external:
          description: External provider information.
          oneOf:
          - $ref: '#/components/schemas/External'
        firstName:
          type: string
          description: Signer's first name.
        group:
          description: Signer's group.
          oneOf:
          - $ref: '#/components/schemas/Group'
        id:
          type: string
          description: Signer Id.
        knowledgeBasedAuthentication:
          description: Knowledge base authentication through Equifax.
          oneOf:
          - $ref: '#/components/schemas/KnowledgeBasedAuthentication'
        language:
          type: string
          description: 'Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko'
        lastName:
          type: string
          description: Signer's lastname.
        name:
          type: string
          description: Signer's name.
        phone:
          type: string
          description: Signer's phone.
        professionalIdentityFields:
          type: array
          description: ' '
          items:
            $ref: '#/components/schemas/ProfessionalIdentityField'
        signature:
          description: Signer's signature style.
          oneOf:
          - $ref: '#/components/schemas/SignatureStyle'
        signerType:
          description: Type of signer
          oneOf:
          - $ref: '#/components/schemas/SignerType'
        specialTypes:
          type: array
          description: Special User Types. Currently only NOTARY is supported.
          items:
            type: string
        title:
          type: string
          description: Signer's title.
        updated:
          type:
          - string
          - 'null'
          description: Last time signer was updated.
          format: date-time
        userCustomFields:
          type: array
          description: Signer's custom fields.
          items:
            $ref: '#/components/schemas/UserCustomField'
        digipassAuthentication:
          type: boolean
          description: Indicates whether Digipass authentication is enabled for the signer.
        timezoneId:
          type: string
          description: Timezone ID of the signer, e.g., "America/New_York".
        notificationMethods:
          description: Default notification methods for the signer.
          oneOf:
          - $ref: '#/components/schemas/NotificationMethods'
    RoleType:
      type: string
      description: ''
      x-enumNames:
      - SIGNER
      - SENDER
      enum:
      - SIGNER
      - SENDER
    CreditCard:
      type: object
      additionalProperties: false
      properties:
        cvv:
          type: string
        expiration:
          $ref: '#/components/schemas/CcExpiration'
        name:
          type: string
        number:
          type: string
        type:
          type: string
    Package:
      type: object
      description: Object to manage a package
      additionalProperties: false
      properties:
        autocomplete:
          type: boolean
          description: Determines if "Review Before Completion" is enabled
        completed:
          type:
          - string
          - 'null'
          description: The date the transaction was completed
          format: date-time
        consent:
          type: string
          description: Consent
        data:
          type: object
          description: Custom meta data
          additionalProperties: {}
        description:
          type: string
          description: Package description
        documents:
          type: array
          description: List of package documents
          items:
            $ref: '#/components/schemas/Document'
        due:
          type:
          - string
          - 'null'
          description: The date the package will expire
          format: date-time
        emailMessage:
          type: string
          description: Message to be included emails to signers
        id:
          type: string
          description: Unique package Id
        language:
          type: string
          description: 'Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko'
        limits:
          description: Limits
          oneOf:
          - $ref: '#/components/schemas/PackageArtifactsLimits'
        messages:
          type: array
          description: Messages
          items:
            $ref: '#/components/schemas/Message'
        name:
          type: string
          description: Package name
        notarized:
          type: boolean
          description: Notarized
        notaryRoleId:
          type: string
          description: NotaryRoleId
        roles:
          type: array
          description: List of roles in the package
          items:
            $ref: '#/components/schemas/Role'
        conditions:
          type: array
          description: List of field conditions for the package
          items:
            $ref: '#/components/schemas/FieldCondition'
        sender:
          description: The package sender
          oneOf:
          - $ref: '#/components/schemas/Sender'
        settings:
          description: Package settings
          oneOf:
          - $ref: '#/components/schemas/PackageSettings'
        signedDocumentDelivery:
          description: SignedDocumentDelivery
          oneOf:
          - $ref: '#/components/schemas/SignedDocumentDelivery'
        status:
          description: Package status
          oneOf:
          - $ref: '#/components/schemas/PackageStatus'
        trashed:
          type: boolean
          description: Determines if package has been deleted
        type:
          description: Type
          oneOf:
          - $ref: '#/components/schemas/BasePackageType'
        updated:
          type:
          - string
          - 'null'
          description: The date the package was last updated
          format: date-time
        visibility:
          description: Determines package visibility
          oneOf:
          - $ref: '#/components/schemas/Visibility'
        timezoneId:
          type: string
          description: The timezone id specified for the package
        created:
          type:
          - string
          - 'null'
          description: The date the package was created
          format: date-time
        virtualRoom:
          type:
          - boolean
          - 'null'
          description: Determines if a virtual room has been created for the package signing
    BrandingBarOptions:
      type: object
      description: Branding bar options
      additionalProperties: false
      properties:
        logo:
          description: Logo to display on branding bar
          oneOf:
          - $ref: '#/components/schemas/Image'
    FieldValidation:
      type: object
      description: Field validation object
      additionalProperties: false
      properties:
        enum:
          type: array
          items:
            type: string
        errorCode:
          type:
          - integer
          - 'null'
          description: Field validation error code.
          format: int32
        errorMessage:
          type: string
          description: "Field validation error message.\n            "
        maxLength:
          type:
          - integer
          - 'null'
          description: Field validation maximum length.
          format: int32
        minLength:
          type:
          - integer
          - 'null'
          description: Field validation minimum length.
          format: int32
        pattern:
          type: string
          description: Pattern
        required:
          type: boolean
          description: Determines if field is required
        group:
          type: string
          description: Field validation group.
        minimumRequired:
          type:
          - integer
          - 'null'
          description: Minimum Required (Grouped Checkboxes)
          format: int32
    Entity:
      type: object
      description: Object used to manage entities from Microsoft Dynamics
      additionalProperties: false
      properties:
        data:
          type: object
          description: Custom data for the entity
          additionalProperties: {}
        id:
          type: string
          description: Unique id of the entity
        name:
          type: string
          description: Name of the entity
    User:
      type: object
      description: User information.
      additionalProperties: false
      properties:
        address:
          description: User address.
          oneOf:
          - $ref: '#/components/schemas/Address'
        company:
          type: string
          description: User company.
        created:
          type:
          - string
          - 'null'
          description: User creation date.
          format: date-time
        data:
          type: object
          description: User metadata.
          additionalProperties: {}
        email:
          type: string
          description: User email.
        external:
          description: External provider information.
          oneOf:
          - $ref: '#/components/schemas/External'
        firstName:
          type: string
          description: User first name.
        id:
          type: string
          description: Unique user Id.
        language:
          type: string
          description: 'Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko'
        lastName:
          type: string
          description: User last name.
        name:
          type: string
          description: User name.
        phone:
          type: string
          description: User phone number.
        professionalIdentityFields:
          type: array
          description: ProfessionalIdentityFields
          items:
            $ref: '#/components/schemas/ProfessionalIdentityField'
        signature:
          description: User signature information.
          oneOf:
          - $ref: '#/components/schemas/SignatureStyle'
        specialTypes:
          type: array
          description: Special User Types. Currently only NOTARY is supported.
          items:
            type: string
        title:
          type: string
          description: User title.
        updated:
          type:
          - string
          - 'null'
          description: User information updated date.
          format: date-time
        timezoneId:
          type: string
          description: User timezone Id.
        userCustomFields:
          type: array
          description: User custom fields.
          items:
            $ref: '#/components/schemas/UserCustomField'
    Link:
      allOf:
      - $ref: '#/components/schemas/Handover'
      - type: object
        description: Object used to manage link in Handover objects
        additionalProperties: false
        properties:
          autoRedirect:
            type:
            - boolean
            - 'null'
            description: AutoRedirect
          parameters:
            type: array
            description: List of parameters for link url
            items:
              type: string
    SignatureStyle:
      type: object
      additionalProperties: false
      properties:
        handdrawn:
          type: string
          description: Hand drawn signature image (base 64 encoding).
        textual:
          description: Textual signature style
          oneOf:
          - $ref: '#/components/schemas/TextualSignatureStyle'
    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'
    Handover:
      type: object
      description: Object used to manage a redirect url when signing is completed
      additionalProperties: false
      properties:
        href:
          type: string
          description: The href of the handover url
        text:
          type: string
          description: The text displayed on the button
        title:
          type: string
          description: The hover text displayed on the button
    HeaderOptions:
      type: object
      description: Object to manage header options
      additionalProperties: false
      properties:
        breadcrumbs:
          type:
          - boolean
          - 'null'
          description: Breadcrumbs
        feedback:
          type:
          - boolean
          - 'null'
          description: Feedback
        globalActions:
          description: GlobalActions options
          oneOf:
          - $ref: '#/components/schemas/GlobalActionsOptions'
        globalNavigation:
          type:
          - boolean
          - 'null'
          description: GlobalNavigation
        sessionBar:
          type:
          - boolean
          - 'null'
          description: SessionBar
        titleBar:
          description: TitleBar options
          oneOf:
          - $ref: '#/components/schemas/TitleBarOptions'
    Currency:
      type: object
      description: The currency used for the Price object
      additionalProperties: false
      properties:
        data:
          type: object
          description: Data
          additionalProperties: {}
        id:
          type: string
          description: Id
        name:
          type: string
          description: Name
    AttachmentRequirement:
      type: object
      description: Attachment requirements and settings.
      additionalProperties: false
      properties:
        comment:
          type: string
          description: Attachment comment.
        data:
          type: object
          description: Attachment metadata.
          additionalProperties: {}
        description:
          type: string
          description: Attachment description.
        files:
          type: array
          description: Attachment files.
          items:
            $ref: '#/components/schemas/AttachmentFile'
        id:
          type: string
          description: The attachment Id.
        name:
          type: string
          description: The attachment name.
        required:
          type: boolean
          description: Is attachment required.
        status:
          description: Attachment status.
          oneOf:
          - $ref: '#/components/schemas/RequirementStatus'
    CompletionReport:
      type: object
      description: A Compl

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