Metadata

Each method has a call to get the metadata.

The APIs you use to get the metadata have the form {{url}}/metadata/<hub_name>/ or {{url}}/metadata/<config_type>/. For descriptions of each metadata field, see Metadata. For example, here is the call to retrieve the metadata that describes the available fields for a contact in the Contacts Hub:

curl --request GET \
  --url 'https://{{url}}/metadata/contact/' \
  --header 'authorization: Bearer {{oauth_token}}' \
  --header 'content-type: application/json'

The preceding request returns a JSON representation of the metadata like the following truncated for brevity:

{
    "Contacts": {
        "Keys": "ContactID",
        "CustomTable": false,
        "TableName": "Contacts",
        "GridID": null,
        "Fields": [
            {
                "FieldName": "ContactID",
                "FieldType": "String",
                "Caption": "ContactID",
                "DefaultValue": "[GUID]",
                "Hidden": false,
                "Required": false,
                "Updateable": true,
                "CustomField": false,
                "MaxLength": 32
            },            
            {
                "FieldName": "ContactStatus",
                "FieldType": "Dropdown",
                "Caption": "Status",
                "DefaultValue": "A",
                "Hidden": false,
                "Required": false,
                "Updateable": true,
                "CustomField": false,
                "MaxLength": 10,
                "CodeTable": "ContactStatus",
                "LimitToList": true
            },