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:
    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
    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'
    SenderUsageReport:
      type: object
      description: The report of sender usages.
      additionalProperties: false
      properties:
        packages:
          type: object
          description: The list of packages.
          additionalProperties: {}
        sender:
          description: Sender information.
          oneOf:
          - $ref: '#/components/schemas/Sender'
    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
    DelegationEventReport:
      type: object
      description: 'The report of delegation events for signers. Delegates can sign documents on behalf of the delegator,

        and they can access the delegator''s inbox, drafts, layouts, and templates.'
      additionalProperties: false
      properties:
        eventDate:
          type:
          - string
          - 'null'
          description: Date of delegation creation.
          format: date-time
        eventDescription:
          type: string
          description: Description of delegation.
        eventType:
          type: string
          description: Type of delegation event.
        eventUser:
          type: string
          description: The delegation event user information.
    SenderType:
      type: string
      description: ''
      x-enumNames:
      - REGULAR
      - MANAGER
      enum:
      - REGULAR
      - MANAGER
    PackageCompletionReport:
      type: object
      description: A Completion Report contains information about your senders, signers, their associated packages, and their package status.
      additionalProperties: false
      properties:
        created:
          type:
          - string
          - 'null'
          description: The time package report is created.
          format: date-time
        data:
          type: object
          description: The package completion metadata.
          additionalProperties: {}
        documents:
          type: array
          description: The list of completed documents.
          items:
            $ref: '#/components/schemas/DocumentCompletionReport'
        id:
          type: string
          description: The unique package completion Id.
        name:
          type: string
          description: The package name.
        signers:
          type: array
          description: The list of package signers.
          items:
            $ref: '#/components/schemas/SignersCompletionReport'
        status:
          description: The package status.
          oneOf:
          - $ref: '#/components/schemas/PackageStatus'
        trashed:
          type: boolean
          description: Check if package is trashed.
        updated:
          type:
          - string
          - 'null'
          description: The date of package update.
          format: date-time
    SenderStatus:
      type: string
      description: ''
      x-enumNames:
      - INVITED
      - ACTIVE
      - LOCKED
      enum:
      - INVITED
      - ACTIVE
      - LOCKED
    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
      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
    AuthScheme:
      type: string
      description: ''
      x-enumNames:
      - NONE
      - PROVIDER
      - CHALLENGE
      - SMS
      - SSO
      - KBA
      - SAA
      enum:
      - NONE
      - PROVIDER
      - CHALLENGE
      - SMS
      - SSO
      - KBA
      - SAA
    Approval:
      type: object
      description: Signing Approval object.
      additionalProperties: false
      properties:
        accepted:
          type:
          - string
          - 'null'
          description: Date of approval acceptance.
          format: date-time
        data:
          type: object
          description: Additional approval ata properties.
          additionalProperties: {}
        fields:
          type: array
          description: Approval Signature/Input fields.
          items:
            $ref: '#/components/schemas/Field'
        id:
          type: string
          description: The unique approval Id.
        name:
          type: string
          description: The unique approval name.
        role:
          type: string
          description: The approval role name.
        signed:
          type:
          - string
          - 'null'
          description: The approval signed date.
          format: date-time
        optional:
          type: boolean
          description: Check if for optional information.
        enforceCaptureSignature:
          type: boolean
          description: Check if required on Capture Signature
        disabled:
          type: boolean
          description: Check if disabled for approval.
        fromFile:
          type: boolean
          description: Check if signature is uploaded From File.
        fromFileData:
          type: object
          description: Additional approval From File data properties.
          additionalProperties: {}
    MemberType:
      type: string
      description: Type of member in a group
      x-enumNames:
      - REGULAR
      - MANAGER
      - SIGNER
      - AD_HOC_GROUP_MEMBER
      enum:
      - REGULAR
      - MANAGER
      - SIGNER
      - AD_HOC_GROUP_MEMBER
    DocumentToolbarOptions:
      type: object
      description: Object to manage the document toolbar
      additionalProperties: false
      properties:
        downloadButton:
          type:
          - boolean
          - 'null'
          description: Determines if download button is available on document toolbar
    SignerInformationForEquifaxUSA:
      type: object
      description: Object to manage Equifax USA 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
        socialSecurityNumber:
          type: string
          description: Social security number
        state:
          type: string
          description: State
        streetAddress:
          type: string
          description: Street address
        timeAtAddress:
          type:
          - integer
          - 'null'
          description: Time at address
          format: int32
        zip:
          type: string
          description: Zip code
    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
    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
    Page:
      type: object
      description: Object representing a page in a document
      additionalProperties: false
      properties:
        height:
          type:
          - number
          - 'null'
          description: Page height
          format: double
        id:
          type: string
          description: Unique page id
        index:
          type:
          - integer
          - 'null'
          description: Index of the page within the document
          format: int32
        left:
          type:
          - number
          - 'null'
          description: Page left
          format: double
        top:
          type:
          - number
          - 'null'
          description: Page top
          format: double
        version:
          type:
          - integer
          - 'null'
          description: Version
          format: int32
        width:
          type:
          - number
          - 'null'
          description: Page width
          format: double
    CycleCount:
      type: object
      additionalProperties: false
      properties:
        count:
          type: integer
          format: int32
        cycle:
          $ref: '#/components/schemas/CycleCount'
    FooterOptions:
      type: object
      additionalProperties: false
    LayoutStyle:
      type: object
      description: Object to manage layout styles
      additionalProperties: false
      properties:
        brandingBar:
          description: Image that represents the branding bar
          oneOf:
          - $ref: '#/components/schemas/Image'
        dialog:
          description: Style for the dialog
          oneOf:
          - $ref: '#/components/schemas/Style'
        titleBar:
          description: Style for the title bar
          oneOf:
          - $ref: '#/components/schemas/Style'
        toolbar:
          description: Style for the toolbar
          oneOf:
          - $ref: '#/components/schemas/Style'
    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
    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.
    Handover:
      type: object
      description: Object used to manage a redirect url when signing is completed
      additionalProperties: false
  

# --- 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