Metadata Overview

Metadata routes provide information about fields that can be supplied to and returned from API resources. Find the metadata route for an object on the Routes page.

---

Example Metadata Response

Below is an example response for the Activity.Name field from /api/metadata/activities:

{
  "fieldName": "Activity.Name",
  "fieldType": 0,
  "titleResourceId": "mo-replacement-strings-39",
  "fieldDataType": 1,
  "fieldFormatting": {
    "showNewLines": false,
    "fieldLength": 150
  },
  "validationRules": [
    {
      "validationMessageResourceId": 520,
      "name": "RequiredRule",
      "resourceId": "mo-replacement-strings-520"
    },
    {
      "validationMessageResourceId": 19711,
      "maxLength": 150,
      "name": "MaxLengthRule",
      "resourceId": "mo-replacement-strings-19711"
    }
  ],
  "timeValueType": 0,
  "amsAttributeId": -405,
  "isSecure": false,
  "isReadOnly": false,
  "allowInitialValue": true,
  "inactive": false,
  "parentName": "Activity",
  "tabSequence": 0
}

---

Field Descriptions

Field	Description
fieldName	Name of the field in object.property format.
fieldType	0 = Base field, 1 = Extended attribute.
titleResourceId	Key for the field's UI name (refer to the string resources article).
fieldDataType	Data type of the field (see Data Types below).
fieldFormatting	Formatting metadata for display or editing.
validationRules	Array of validation rules for the field.
timeValueType	Determines timezone handling for datetime fields (see Time Value Types below).
amsAttributeId	Unique attribute ID (< 0 = Base field, > 0 = Tenant-specific attribute).
isSecure	Indicates if the field is secure.
isReadOnly	Indicates if the field is read-only.
allowInitialValue	Allows an initial value when creating an object.
inactive	For extended attributes only. Indicates if the attribute is inactive.
parentName	Parent object name.
tabSequence	Tab order for UI display.

---

Data Types

ID	Data Type
1	Text
2	Email Address
3	URL
4	Long Text
11	Numeric
12	Numeric ID
13	Currency
14	Percentage
15	Integer
21	Date
22	Time
23	DateTime
31	Yes/No
32	Picklist
33	MultiSelect
34	Encoded Title ID
35	Static Value List
36	UserGroup
37	Picklist (Legacy)
40	System Type
41	Selection List
42	Selection List Item
99	Deprecated Attribute

---

Time Value Types

ID	Description
0	No conversion. Stored as-is; same value for all users.
1	User-generated value. Stored as UTC and converted to the user’s timezone.
2	System-generated value. Displayed in the user’s timezone.
3	Special rules. Does not respect user timezone, often relying on a record-specific timezone setting.