V3 REFERENCE System

/metadata

Mailjet API meta data.

List metadata resources available for this apikey, use a GET request. Alternatively, you may want to add one or more filters.

# list metadata resources

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/metadata
Unique Key

In addition to the resource $ID, you can also use the unique key $Name to identify this resource. Please refer to the field(s) description below for more information.

Properties
Name Description
Actions A list of the supported actions
  • Read Only
  • [ Type TResourceActionList ]
APIVersion Current API version
  • Read Only
  • [ Type AnsiString ]
Description Description of resource.
  • Read Only
  • [ Type AnsiString ]
Filters Applicable filters for this resource.
  • Read Only
  • [ Type TFilterList ]
IsReadOnly Is the resource inherently read-only.
  • Read Only
  • [ Type Boolean ]
Name Unique name of the resource.
  • Unique
  • Read Only
  • [ Type AnsiString ]
PrivateOperations List of allowed operations in private API.
  • Read Only
  • [ Type TResourceOps ]
Properties List of properties for this resource.
  • Read Only
  • [ Type TPropertyList ]
PublicOperations List of allowed operations in public API.
  • Read Only
  • [ Type TResourceOps ]
SortInfo Information about the fields on which a list of this resource can be sorted.
  • Read Only
  • [ Type TSortInfoList ]
UniqueKey Name of the property which can be used as an alternative unique key in the URL (other than the ID).
  • Read Only
  • [ Type AnsiString ]
Filters
Name Description
PublicResources Show only public resource.
  • [ Type Boolean ]
ReadOnlyResources Show only read-only resources.
  • [ Type Boolean ]
ResourceName Show only resource with given name.
  • [ Type AnsiString ]

Access a given metadata resource, use a GET request, providing the metadata's ID value.

# access the metadata resource identified by $ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/metadata/$ID

    
# access the resource through the Name's value
# note: all keys marked as 'unique' may be used as an alternate ID

curl -s -X GET \
--user "$MJ_APIKEY_PUBLIC:$MJ_APIKEY_PRIVATE" \
https://api.mailjet.com/v3/REST/metadata/$Name
    
    
Unique Key

In addition to the resource $ID, you can also use the unique key $Name to identify this resource. Please refer to the field(s) description below for more information.

Properties
Name Description
Actions A list of the supported actions
  • Read Only
  • [ Type TResourceActionList ]
APIVersion Current API version
  • Read Only
  • [ Type AnsiString ]
Description Description of resource.
  • Read Only
  • [ Type AnsiString ]
Filters Applicable filters for this resource.
  • Read Only
  • [ Type TFilterList ]
IsReadOnly Is the resource inherently read-only.
  • Read Only
  • [ Type Boolean ]
Name Unique name of the resource.
  • Unique
  • Read Only
  • [ Type AnsiString ]
PrivateOperations List of allowed operations in private API.
  • Read Only
  • [ Type TResourceOps ]
Properties List of properties for this resource.
  • Read Only
  • [ Type TPropertyList ]
PublicOperations List of allowed operations in public API.
  • Read Only
  • [ Type TResourceOps ]
SortInfo Information about the fields on which a list of this resource can be sorted.
  • Read Only
  • [ Type TSortInfoList ]
UniqueKey Name of the property which can be used as an alternative unique key in the URL (other than the ID).
  • Read Only
  • [ Type AnsiString ]