Ampersand · JSON Structure

Ampersand Api Object Metadata Structure

ObjectMetadata schema from Ampersand API

Type: object Properties: 4 Required: 2
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

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

Properties

name displayName mappedObjectName fields

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-object-metadata-structure.json",
  "name": "ObjectMetadata",
  "description": "ObjectMetadata schema from Ampersand API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The provider name of the object",
      "example": "contact"
    },
    "displayName": {
      "type": "string",
      "description": "Human-readable name of the object",
      "example": "Contact"
    },
    "mappedObjectName": {
      "type": "string",
      "description": "The mapped name of the object as defined in your integration config, if a mapping was applied. Only present when using the installation-scoped metadata endpoint.",
      "example": "people"
    },
    "fields": {
      "type": "object",
      "description": "Map of field metadata keyed by field name",
      "additionalProperties": {
        "$ref": "../manifest/manifest.yaml#/components/schemas/FieldMetadata"
      }
    }
  },
  "required": [
    "name",
    "fields"
  ]
}