Ampersand · JSON Structure

Ampersand Api Field Definition Structure

Field definition for creating or updating custom fields

Type: object Properties: 10 Required: 3
Developer ToolsIntegrationPlatformSoftware-as-a-ServiceAuthenticationData SyncWebhook

FieldDefinition is a JSON Structure definition published by Ampersand, describing 10 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

fieldName displayName description valueType required unique indexed stringOptions numericOptions association

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-field-definition-structure.json",
  "name": "FieldDefinition",
  "description": "Field definition for creating or updating custom fields",
  "type": "object",
  "properties": {
    "fieldName": {
      "type": "string",
      "description": "The identifier of the field",
      "example": "My_Custom_Field"
    },
    "displayName": {
      "type": "string",
      "description": "The human-readable name of the field",
      "example": "My Custom Field"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the field"
    },
    "valueType": {
      "type": "string",
      "description": "The data type of the field. Valid values are string, boolean, date, datetime, singleSelect, multiSelect, int, float, reference",
      "example": "string"
    },
    "required": {
      "type": "boolean",
      "description": "Indicates if the field is required"
    },
    "unique": {
      "type": "boolean",
      "description": "Indicates if the field must be unique across all records"
    },
    "indexed": {
      "type": "boolean",
      "description": "Indicates if the field should be indexed for faster search"
    },
    "stringOptions": {
      "$ref": "#/components/schemas/StringFieldOptions"
    },
    "numericOptions": {
      "$ref": "#/components/schemas/NumericFieldOptions"
    },
    "association": {
      "$ref": "#/components/schemas/AssociationDefinition"
    }
  },
  "required": [
    "fieldName",
    "displayName",
    "valueType"
  ]
}

Work with this as data

Every JSON Structure 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 json structure

4 MCP tools reach this
  • find_json_structuresBrowse and filter every JSON Structure in the catalog.
  • 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 JSON Structure
curl "https://apis.io/api/v1/json-structures/ampersand-api-field-definition-structure"
All json structure
curl "https://apis.io/api/v1/json-structures?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.