Loadsmart

Loadsmart Custom Forms - Fields API

Fields are global definitions that specify fundamental attributes like data type (text, number, dropdown, etc.), validation rules, and base properties. Fields are organization-wide resources that can be instantiated as Form Fields across multiple Forms.

GitHub OpenAPI

Operations 5

POST /custom-forms/field Create a single Field #
GET /custom-forms/field Retrieve multiple Fields #
PATCH /custom-forms/field/{id} Update a single Field #
GET /custom-forms/field/{id} Retrieve a single Field #
DELETE /custom-forms/field/{id} Delete a single Field #

Documentation

📖
Documentation
https://developer.loadsmart.com/docs/shipperguide/overview/getting-started
📖
APIReference
https://developer.loadsmart.com/docs/shipperguide/api-reference
📖
Authentication
https://developer.loadsmart.com/docs/shipperguide/overview/getting-started
📖
Documentation
https://developer.loadsmart.com/docs/opendock/overview/getting-started
📖
APIReference
https://developer.loadsmart.com/docs/opendock/category/overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/loadsmart/refs/heads/main/openapi/loadsmart-custom-forms-fields-api-openapi.yml

Other Resources

🔗
OpenAPISource
https://developer.loadsmart.com/api/openapi.yaml
🔗
Webhooks
https://developer.loadsmart.com/docs/shipperguide/api-reference
🔗
Sandbox
https://api.sandbox.loadsmart.com
🔗
Postman
https://community.loadsmart.com/hc/en-us/articles/14945962355091-Importing-the-Postman-Collection
🔗
OpenAPISource
https://neutron.opendock.com/docs-json
🔗
SwaggerUI
https://neutron.opendock.com/docs
🔗
WebSockets
https://developer.loadsmart.com/docs/opendock/overview/websockets
🔗
Sandbox
https://neutron.staging.opendock.com
🔗
Postman
https://www.postman.com/opendock/workspace/public-nova-workspace/
🔗
Community
https://community.loadsmart.com/hc/en-us/sections/24987828169619-Opendock-Nova-Warehouse-API

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/loadsmart-custom-forms-fields-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.

GitHub Google LinkedIn

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

OpenAPI Specification

loadsmart-custom-forms-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Opendock Nova API Documentation Custom Forms - Fields API
  description: '## Welcome to Opendock Nova!'
  version: v4.144.0 - 39b4253
  contact: {}
servers:
- url: https://neutron.opendock.com
  description: Production Server
- url: https://neutron.staging.opendock.com
  description: Staging Server
tags:
- name: Custom Forms - Fields
  description: Fields are global definitions that specify fundamental attributes like data type (text, number, dropdown, etc.), validation rules, and base properties. Fields are organization-wide resources that can be instantiated as Form Fields across multiple Forms.
paths:
  /custom-forms/field:
    post:
      operationId: createOneBaseFieldControllerField
      summary: Create a single Field
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFieldDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Field'
      tags:
      - Custom Forms - Fields
      security:
      - bearer: []
    get:
      operationId: getManyBaseFieldControllerField
      summary: Retrieve multiple Fields
      parameters:
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: s
        description: Adds search condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#search" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: string
      - name: filter
        description: Adds filter condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#filter" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: or
        description: Adds OR condition. <a href="https://github.com/nestjsx/crud/wiki/Requests#or" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: sort
        description: Adds sort by field. <a href="https://github.com/nestjsx/crud/wiki/Requests#sort" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: limit
        description: Limit amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#limit" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: offset
        description: Offset amount of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#offset" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: page
        description: Page portion of resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#page" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: Get paginated response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetManyFieldResponseDto'
      tags:
      - Custom Forms - Fields
      security:
      - bearer: []
  /custom-forms/field/{id}:
    patch:
      operationId: updateOneBaseFieldControllerField
      summary: Update a single Field
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFieldDto'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Field'
      tags:
      - Custom Forms - Fields
      security:
      - bearer: []
    get:
      operationId: getOneBaseFieldControllerField
      summary: Retrieve a single Field
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      - name: fields
        description: Selects resource fields. <a href="https://github.com/nestjsx/crud/wiki/Requests#select" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false
      - name: join
        description: Adds relational resources. <a href="https://github.com/nestjsx/crud/wiki/Requests#join" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: cache
        description: Reset cache (if was enabled). <a href="https://github.com/nestjsx/crud/wiki/Requests#cache" target="_blank">Docs</a>
        required: false
        in: query
        schema:
          type: integer
          minimum: 0
          maximum: 1
      responses:
        '200':
          description: Get one base response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Field'
      tags:
      - Custom Forms - Fields
      security:
      - bearer: []
    delete:
      operationId: deleteOneBaseFieldControllerField
      summary: Delete a single Field
      parameters:
      - name: id
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: Delete one base response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Field'
      tags:
      - Custom Forms - Fields
      security:
      - bearer: []
components:
  schemas:
    Field:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the record
          example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
          readOnly: true
        createDateTime:
          format: date-time
          type: string
          description: The date and time when the record was created
          example: '2023-10-01T12:00:00Z'
          readOnly: true
        createdBy:
          type: object
          description: The ID of the user who created the record
          example: a0e1f2c3-d4e5-6f7g-8h9i-j0k1l2m3n4o5
          readOnly: true
        lastChangedDateTime:
          format: date-time
          type: string
          description: The date and time when the record was last changed
          example: '2023-10-01T12:00:00Z'
          readOnly: true
        label:
          type: string
          description: The label of the field, it can be overriden when instantiated by a FormField entity
          example: First Name
        description:
          type: string
          description: The helper text for the particular field
          example: Enter your first name
        placeholder:
          type: string
          description: The placeholder for the particular field
          example: John Doe
        type:
          $ref: '#/components/schemas/CustomFieldType'
        extraFields:
          description: Extra fields for the field, used to render the field in the UI, such as Dropdown options and number validation rules
          example:
            dropDownValues:
            - Option 1
            - Option 2
            - Option 3
            minLengthOrValue: 1
            maxLengthOrValue: 10
          allOf:
          - $ref: '#/components/schemas/FieldExtraFields'
        semanticLabel:
          type: object
          description: Optional semantic label grouping for this field
      required:
      - id
      - createDateTime
      - createdBy
      - lastChangedDateTime
      - label
      - type
    FieldExtraFields:
      type: object
      properties: {}
    GetManyFieldResponseDto:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Field'
        count:
          type: number
        total:
          type: number
        page:
          type: number
        pageCount:
          type: number
      required:
      - data
      - count
      - total
      - page
      - pageCount
    UpdateFieldDto:
      type: object
      properties:
        tags:
          type: object
        label:
          type: string
        type:
          $ref: '#/components/schemas/CustomFieldType'
        description:
          type: string
        placeholder:
          type: string
        extraFields:
          example:
            dropdownOptions:
            - Option 1
            - Option 2
            maxLengthOrValue: 100
            minLengthOrValue: 1
          allOf:
          - $ref: '#/components/schemas/FieldExtraFields'
        formId:
          type: string
    CustomFieldType:
      type: string
      description: The type of the field used at the moment of the data submission, used to render the field in the UI and validate the data on the API level
      enum:
      - str
      - bigstr
      - date
      - bool
      - doc
      - multidoc
      - int
      - email
      - phone
      - dropdown
      - dropdownmultiselect
      - combobox
      - timestamp
      - action
    CreateFieldDto:
      type: object
      properties:
        tags:
          type: object
        label:
          type: string
        type:
          $ref: '#/components/schemas/CustomFieldType'
        description:
          type: string
        placeholder:
          type: string
        extraFields:
          example:
            dropDownValues:
            - Option 1
            - Option 2
            - Option 3
            minLengthOrValue: 1
            maxLengthOrValue: 10
          allOf:
          - $ref: '#/components/schemas/FieldExtraFields'
      required:
      - label
      - type
      - description
      - placeholder
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http