Ampersand · Schema

ObjectMetadata

ObjectMetadata schema from Ampersand API

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name	Type	Description
name	string	The provider name of the object
displayName	string	Human-readable name of the object
mappedObjectName	string	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.
fields	object	Map of field metadata keyed by field name

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-object-metadata-schema.json",
  "title": "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"
  ]
}