Conga File Attachment API

The FileAttachment API from Conga — 7 operation(s) for fileattachment.

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/cs-packages/{packageId}/attachment/zip Download all of a package's attachments as a zip · Download all attachments #
Ask an LLM
“Can I download every file signers attached to a package in one zip?”
“How do I get all attachments from a signing transaction at once?”
Tell an agent
Download all attachments for package {packageId} as a zip.
Zip up every attachment in package {packageId}.
GET /v1/cs-packages/{packageId}/attachment/zip/{roleId} Download one role's attachments as a zip · Download all attachments for a specific role #
Ask an LLM
“Can I zip only the attachments uploaded by one signer role?”
“Is there a way to download attachments for a specific recipient only?”
Tell an agent
Download a zip of role {roleId}'s attachments in package {packageId}.
Get only the files for role {roleId} from package {packageId} as one zip.
GET /v1/cs-packages/{packageId}/attachment/zip/{roleId}/exists Check if a role has attachments with uploads · Check for attachments and uploads by role #
Ask an LLM
“Has a given signer role uploaded any attachments yet?”
“Before zipping, can I check whether a role has anything to download?”
Tell an agent
Check whether role {roleId} in package {packageId} has any attachment uploads.
Tell me if there's anything to zip for role {roleId} on package {packageId}.
POST /v1/cs-packages/{packageId}/attachment/{attachmentId} Upload a file to a package attachment · Add an attachment #
Ask an LLM
“Can I upload a supporting document to an attachment requirement on a package?”
“What do I need to upload a file into a signing package's attachment?”
Tell an agent
Upload {fileName} to attachment {attachmentId} in package {packageId}.
Add a file to attachment {attachmentId} on package {packageId}.
GET /v1/cs-packages/{packageId}/attachment/{attachmentId} Download one attachment from a package · Download an attachment #
Ask an LLM
“How do I download a single attachment requirement's files from a package?”
“Can I fetch one attachment by its attachment ID?”
Tell an agent
Download attachment {attachmentId} from package {packageId}.
Get the files for attachment requirement {attachmentId} on package {packageId}.
GET /v1/cs-packages/{packageId}/attachment/{attachmentId}/exists Check if an attachment has signer uploads · Check for signer uploads #
Ask an LLM
“Has the signer uploaded anything for a specific attachment requirement?”
“Can I verify an attachment has signer uploads before downloading it?”
Tell an agent
Check whether attachment {attachmentId} in package {packageId} has signer uploads.
Tell me if the signer has filled attachment {attachmentId} on package {packageId}.
DELETE /v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId} Delete an uploaded file from an attachment · Delete an attachment file #
Ask an LLM
“Can I remove a wrong file a signer uploaded to an attachment?”
“Is deleting one file from an attachment permanent?”
Tell an agent destructive · confirm first
Delete file {fileId} from attachment {attachmentId} in package {packageId}.
Remove uploaded file {fileId} off attachment {attachmentId} on package {packageId}.
GET /v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId} Download a specific file within an attachment · Download an attachment #
Ask an LLM
“An attachment has several uploaded files; can I download just one of them?”
“How do I fetch a single uploaded file by its file ID?”
Tell an agent
Download file {fileId} from attachment {attachmentId} in package {packageId}.
Get uploaded file {fileId} of attachment {attachmentId} on package {packageId}.
GET /v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}/exists Check if a specific attachment file exists · Check for a specific attachment #
Ask an LLM
“Does a particular uploaded file still exist in the package's attachment?”
“Can I confirm a file ID is present before trying to download it?”
Tell an agent
Check whether file {fileId} exists in attachment {attachmentId} of package {packageId}.
Confirm uploaded file {fileId} is still on attachment {attachmentId}, package {packageId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/conga:conga-fileattachment-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-fileattachment-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Conga Sign File Attachment API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/sign
security:
- JWT: []
tags:
- name: FileAttachment
paths:
  /v1/cs-packages/{packageId}/attachment/zip:
    get:
      tags:
      - FileAttachment
      summary: Download all attachments
      description: Compresses all attachments into a zip file, which is then downloaded.
      operationId: FileAttachment_GetZipAttachment
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '406':
          description: Not Acceptable Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/attachment/zip/{roleId}:
    get:
      tags:
      - FileAttachment
      summary: Download all attachments for a specific role
      description: Compresses all attachments into a zip file and then downloads it. Only attachments for the specified role are included.
      operationId: FileAttachment_GetZipAttachmentByRole
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: roleId
        in: path
        required: true
        description: The unique role id within the package.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '406':
          description: Not Acceptable Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/attachment/zip/{roleId}/exists:
    get:
      tags:
      - FileAttachment
      summary: Check for attachments and uploads by role
      description: Verifies whether or not there are any attachments for the specified role, and whether or not those attachments contain uploads from a Signer.
      operationId: FileAttachment_CheckZipAttachmentByRoleExists
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: roleId
        in: path
        required: true
        description: The unique role id within the package.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentAvailability'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/attachment/{attachmentId}:
    post:
      tags:
      - FileAttachment
      summary: Add an attachment
      description: Uploads an attachment to the specified package.
      operationId: FileAttachment_AddAttachment
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: attachmentId
        in: path
        required: true
        description: The unique attachment id.
        schema:
          type: string
        x-position: 2
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                File:
                  type:
                  - string
                  - 'null'
                  format: binary
                FileName:
                  type:
                  - string
                  - 'null'
                AttachmentUid:
                  type:
                  - string
                  - 'null'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '406':
          description: Not Acceptable Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    get:
      tags:
      - FileAttachment
      summary: Download an attachment
      description: Downloads the specified attachment.
      operationId: FileAttachment_GetAttachmentById
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: attachmentId
        in: path
        required: true
        description: The unique attachment id.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '406':
          description: Not Acceptable Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/attachment/{attachmentId}/exists:
    get:
      tags:
      - FileAttachment
      summary: Check for signer uploads
      description: Verifies whether or not the specified attachment contains any uploads from the Signer.
      operationId: FileAttachment_CheckAttachmentExists
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: attachmentId
        in: path
        required: true
        description: The unique attachment id.
        schema:
          type: string
        x-position: 2
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentAvailability'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}:
    delete:
      tags:
      - FileAttachment
      summary: Delete an attachment file
      description: Deletes specific attachment file.
      operationId: FileAttachment_DeleteAttachmentFile
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: attachmentId
        in: path
        required: true
        description: The unique attachment id.
        schema:
          type: string
        x-position: 2
      - name: fileId
        in: path
        required: true
        description: The unique file id.
        schema:
          type: string
        x-position: 3
      responses:
        '204':
          description: No Content
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: Access Denied Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    get:
      tags:
      - FileAttachment
      summary: Download an attachment
      description: Downloads a specified attachment from a package.
      operationId: FileAttachment_GetAttachmentFile
      parameters:
      - name: packageId
        in: path
        required: true
        description: The unique package id.
        schema:
          type: string
        x-position: 1
      - name: attachmentId
        in: path
        required: true
        description: The unique attachment id.
        schema:
          type: string
        x-position: 2
      - name: fileId
        in: path
        required: true
        description: The unique file id.
        schema:
          type: string
        x-position: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: Unexpected Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-packages/{packageId}/attachment/{attachmentId}/file/{fileId}/exists:
    get:
      tags:
      - FileAttachment
      summary: Check for a specific attachment
      description: Checks whether or not the specified attachment exists in the package.
      operationId: FileAttachment_CheckAttachmentFileExists
      parameters:
      - name: packageId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      - name: attachmentId
        in: path
        required: true
        schema:
          type: string
        x-position: 2
      - name: fileId
        in: path
        required: true
        schema:
          type: string
        x-position: 3
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AttachmentAvailability'
        '400':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '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:
    Error2:
      type: object
      description: Object representing an error condition
      additionalProperties: false
      properties:
        code:
          type:
          - integer
          - 'null'
          description: The error code
          format: int32
        entity:
          description: The Microsoft Dynamics entity
          oneOf:
          - $ref: '#/components/schemas/Entity'
        message:
          type: string
          description: The error message
        messageKey:
          type: string
          description: The error message key
        name:
          type: string
          description: The error name
        technical:
          type: string
          description: Technical information about the error
    AttachmentAvailability:
      type: object
      additionalProperties: false
      properties:
        exists:
          type: boolean
    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
  securitySchemes:
    JWT:
      type: apiKey
      description: Provide oauth authentication
      name: Authorization
      in: header