Conga Layout API

openapi: 3.2.0
info:
  title: Conga Layout API
  version: '1.0'
  description: 'Operations tagged Layout across 2 of this provider''s published API definitions: conga-conga-sign.json, conga-x-author.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rls.congacloud.com/api/sign
- url: https://xauthor-prod-rls10.congacloud.com
- url: https://xauthor-preview-rls09.congacloud.com
tags:
- name: Layout
paths:
  /v1/cs-layouts:
    post:
      tags:
      - Layout
      summary: Create a new layout
      description: Creates a new layout.
      operationId: Layout_CreateLayout
      requestBody:
        x-name: packageLayout
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PackageLayout'
        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:
      - Layout
      summary: List available layouts
      description: Retrieves a list of available layouts, which you can filter and sort. By default, this call returns the API caller's layouts. When specifying either the ownerUserId or ownerEmail query parameter, this call returns the specified user's layouts. To retrieve other users' layouts, you must have enabled the roles and permissions feature on your account and the API caller must have the "Manage users’ transactions, templates, and layouts" permission. To enable roles and permissions, contact your Conga Sign sales representative.
      operationId: Layout_GetLayouts
      parameters:
      - name: query
        in: query
        description: The folder to search for. If not set, it will search in all folders.
        schema:
          type: string
        x-position: 1
      - name: type
        in: query
        description: If a template is needed, set to TEMPLATE.
        schema:
          type: string
        x-position: 2
      - name: search
        in: query
        description: Any text which is going to be used in conjunction with the searchtype, if provided.
        schema:
          type: string
        x-position: 3
      - name: searchType
        in: query
        description: 'When empty, a wildcard search will be done in the layout name and description for the search value, otherwise the allowable values will make more restrictive searches. Available values : exact, exactname'
        schema:
          type: string
        x-position: 4
      - name: visibility
        in: query
        description: 'The visibility used to search for the layout. Available values : ACCOUNT, SENDER'
        schema:
          type: string
        x-position: 5
      - name: from
        in: query
        description: The first record that will be returned. Useful for pagination.
        schema:
          type: integer
          format: int32
        x-position: 6
      - name: to
        in: query
        description: The last record that will be returned. Useful for pagination.
        schema:
          type: integer
          format: int32
        x-position: 7
      - name: dir
        in: query
        description: 'The direction according to which the data will be sorted. ''asc'' for ascending and ''desc'' for descending. Available values : asc, desc'
        schema:
          type: string
        x-position: 8
      - name: sort
        in: query
        description: 'The field according to which the data will be sorted. Available values : created, updated, name'
        schema:
          type: string
        x-position: 9
      - name: summary
        in: query
        description: If set to true, the response contains just a summary of the layouts. Otherwise, the response contains the full objects.
        schema:
          type: boolean
        x-position: 10
      - name: ownerUserId
        in: query
        description: The transaction owner user's ID. Indicate the target user to search on.
        schema:
          type: string
        x-position: 11
      - name: ownerEmail
        in: query
        description: The transaction owner's email address. Indicate the target user to search on.
        schema:
          type: string
        x-position: 12
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultOfPackage'
        '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: []
    servers:
    - url: https://rls.congacloud.com/api/sign
  /api/xauthor/v1/layouts/{layoutName}:
    get:
      tags:
      - Layout
      summary: Retrieves the page field definitions and configuration metadata for the…
      parameters:
      - name: layoutName
        in: path
        description: The name of the layout whose page field definitions are requested.
        required: true
        schema:
          type:
          - string
          - 'null'
          description: The name of the layout whose page field definitions are requested.
      - name: OrgType
        in: header
        required: true
        schema:
          type: string
          default: RLP
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Core.Model.PageFieldsResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Core.Model.PageFieldsResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/Conga.XAuthor.Core.Model.PageFieldsResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '500':
          description: Server Error
      security:
      - bearerAuth: []
      operationId: getApiXauthorV1LayoutsByLayoutName
      x-operation-id-source: derived
    servers:
    - url: https://xauthor-prod-rls10.congacloud.com
    - url: https://xauthor-preview-rls09.congacloud.com
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
    PackageLayoutType:
      type: string
      description: ''
      x-enumNames:
      - LAYOUT
      enum:
      - LAYOUT
    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
    PackageLayout:
      type: object
      description: 'A layout enables you to save a prepared document for future reuse. After at

        least one Signature Field has been placed in a document, and a layout of the

        document has been saved, that layout can be applied to any other document

        created thereafter.'
      additionalProperties: false
      required:
      - documents
      - id
      - name
      - type
      - visibility
      properties:
        description:
          type: string
          description: Description of the layout.
        documents:
          type: array
          description: Documents from the layout.
          items:
            $ref: '#/components/schemas/Document'
        id:
          type: string
          description: The id of the layout.
          minLength: 1
        name:
          type: string
          description: Name of the layout.
          minLength: 1
        type:
          description: The layout type.
          oneOf:
          - $ref: '#/components/schemas/PackageLayoutType'
        visibility:
          description: Access level for the layout
          oneOf:
          - $ref: '#/components/schemas/Visibility'
    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
      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
    CustomField:
      type: object
      description: "A custom field is one that, at the time of signing, is automatically populated with data that is specific\nto the signer. For instance, a signer might have an Agent Number, and that number may need to appear in the\nfinal document next to their signature. By using a custom field, the signer can specify their Agent Number,\nand that number will automatically appear in any other field that has been configured to receive it.\n            \nMore info: https://community.onespan.com/documentation/onespan-sign/guides/admin-guides/user/custom-fields"
      additionalProperties: false
      properties:
        data:
          type: object
          description: Custom field metadata.
          additionalProperties: {}
        id:
          type: string
          description: The unique of id of the field
        name:
          type: string
          description: Custom field name.
        required:
          type: boolean
          description: Flag that indicates if the custom field will be required for users when setting up their account profiles.
        translations:
          type: array
          description: Custom field localization.
          items:
            $ref: '#/components/schemas/Translation'
        value:
          type: string
          description: Custom field default value.
    BasePackageType:
      type: string
      description: The type of package
      x-enumNames:
      - PACKAGE
      - TEMPLATE
      - LAYOUT
      enum:
      - PACKAGE
      - TEMPLATE
      - LAYOUT
    Message:
      type: object
      description: ' '
      additionalProperties: false
      properties:
        content:
          type: string
          description: The content of the message
        created:
          type:
          - string
          - 'null'
          description: The date the message was created
          format: date-time
        documents:
          type: array
          description: The list of documents associated with the message
          items:
            $ref: '#/components/schemas/Document'
        from:
          description: The user that created the message
          oneOf:
          - $ref: '#/components/schemas/User'
        status:
          description: The message status
          oneOf:
          - $ref: '#/components/schemas/MessageStatus'
        to:
          type: array
          description: The users that should receive the message
          items:
            $ref: '#/components/schemas/User'
    ExtractAnchor:
      type: object
      description: Text extraction anchor object.
      additionalProperties: false
      properties:
        anchorPoint:
          description: Which corner of the specified character to use as the base for calculating position
          oneOf:
          - $ref: '#/components/schemas/AnchorPointType'
        characterIndex:
          type: integer
          description: The index of the character within the Anchor Text that will be used to calculate position
          format: int32
        height:
          type: integer
          description: The height of the field position to be calculated
          format: int32
        index:
          type: integer
          description: The "occurrence" of the string. For example, if index = 2, the software will skip the first two occurrences of Anchor Text, and use the third occurrence to calculate position.
          format: int32
        leftOffset:
          type: integer
          description: An absolute offset applied to the final x value
          format: int32
        text:
          type: string
          description: The exact string that will be searched for in the uploaded document
        topOffset:
          type: integer
          description: An absolute offset applied to the final y value
          format: int32
        width:
          type: integer
          description: The width of the field position to be calculated
          format: int32
    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:
   

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