Conga

Conga Custom Fields API

The CustomFields API from Conga — 2 operation(s) for customfields.

GitHub OpenAPI

Operations 5

POST /v1/cs-account/customfields Create a custom field #
GET /v1/cs-account/customfields List all custom fields. Query parameters "to" and "from" are expected to navigate pages. #
PUT /v1/cs-account/customfields Update a custom field #
DELETE /v1/cs-account/customfields/{customFieldId} Delete a custom account field by ID #
GET /v1/cs-account/customfields/{customFieldId} Retrieve an account specified custom field #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-customfields-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

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-customfields-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

conga-customfields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Conga Sign Custom Fields API
  version: 1.0.0
servers:
- url: https://rls.congacloud.com/api/sign
security:
- JWT: []
tags:
- name: CustomFields
paths:
  /v1/cs-account/customfields:
    post:
      tags:
      - CustomFields
      summary: Create a custom field
      operationId: CustomFields_CreateCustomField
      requestBody:
        x-name: customField
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomField'
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    get:
      tags:
      - CustomFields
      summary: List all custom fields. Query parameters "to" and "from" are expected to navigate pages.
      operationId: CustomFields_ListCustomFields
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomField'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    put:
      tags:
      - CustomFields
      summary: Update a custom field
      operationId: CustomFields_UpdateCustomField
      requestBody:
        x-name: customField
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomField'
        required: true
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
  /v1/cs-account/customfields/{customFieldId}:
    delete:
      tags:
      - CustomFields
      summary: Delete a custom account field by ID
      operationId: CustomFields_DeleteCustomField
      parameters:
      - name: customFieldId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
    get:
      tags:
      - CustomFields
      summary: Retrieve an account specified custom field
      operationId: CustomFields_GetCustomField
      parameters:
      - name: customFieldId
        in: path
        required: true
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomField'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error2'
      security:
      - JWT: []
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
    Translation:
      type: object
      description: Field localization.
      additionalProperties: false
      properties:
        data:
          type: object
          description: Localization metadata.
          additionalProperties: {}
        description:
          type: string
          description: Optionally provide a description of the selected language.
        id:
          type: string
          description: Localization Id.
        language:
          type: string
          description: 'Available options: en, fr, it, ru, es, pt, de, nl, da, el, zh-CN, zh-TW, ja, ko'
        name:
          type: string
          description: 'Specify a Field Name for the selected language. This is a required field. This is the name of the field

            as your users see it in their account profiles and on transactions in which they participate.'
    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
    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.
  securitySchemes:
    JWT:
      type: apiKey
      description: Provide oauth authentication
      name: Authorization
      in: header