Back to top

Movable Type Data API v4

The Movable Type Data API is a REST interface to the Movable Type Content Management System. The Data API is available for Movable Type Pro and Movable Type Advanced / Enterprise, Version 6.0 and higher.

Movable Type Data API v4 was released in Movable Type 7.0

Movable Type > 開発者向け ドキュメント > Movable Type Data API ドキュメント

Common API

Common API

Version

Get server API version
GET/version

Retrieves Data API version of the server.

This endpoint is available in Movable Type 6.2.4 or later.

This endpoint does not need /v3 or something API endpoint version identifier.
You can call like: https://host/path/your-mt-data-api.cgi/version

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/version
Request  JSON Message
HideShow
Headers
Accept: application/json
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "endpointVersion": "v3",
  "apiVersion": "3.01"
}

Authentication

Authentication

User authentication
POST/authentication

Create a new session and access token. This is like sign-in.

The post data is follows

  • username (required, string) - The username for authentication.

  • password (required, string) - The password for authentication. From version 3, it was changed to use web services password instead of the password.

  • clientId (required, string) - If you want to create a new session or access token, you should specify the clientId. If you specify session id via “X-MT-Authorization” in the request header, clientId is not required.

  • remember (optional, boolean) - If true (generally, “1” is specified.), a new session will be created as a persistent session. If you want to specify false, you can pass “” or “0” to this parameter.

  • mtDataApiLoginMagicToken (optional, string) - This is not required if you authenticate except via browser. If this parameter is passed and valid Movable Type will set cookie in order to start a session.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/authentication
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
username={Your Sign-in Name}&password={Your sign-in Password}&clientId={Your Client ID}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "accessToken": "EowKdyeBcEUNbiFEXlp0bdQz5RJgdkJYLbBDRJ4m",
  "sessionId": "8VtaTLTLp8V9OR5Dz40hO7by8wf0wbCsCkBue0Xv",
  "expiresIn": 3600,
  "remember": false
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 401,
    "message": "Invalid login"
  }
}

Invalidate current session
DELETE/authentication

Invalidate current session. This is like sign-out. All access tokens related to that session will invalidated too.

This method accepts DELETE or POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/authentication
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth sessionId={session_id}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}

User authentication via sing-in Screen

User authentication via sing-in Screen
GET/authorization

When this endpoint called from application, user will move to sign-in screen of Movable Type.
And then user will move to new location that specified in the redirectUrl parameter when user has been authenticated.

If your application is running on web browser, you should use this endpoint instead of /authenticatoin.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/authorization
Request
Response  200
HideShow
Headers
Content-Type: text/html

Token

Create a new access token
POST/token

Create a new access token that related to current session.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/token
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth sessionId={SessionId}
Body
{
  "clientId": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "clientId": {
      "type": "string",
      "description": "If you specify  session id via \"X-MT-Authorization\" in the request header, clientId is not required."
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "accessToken": "EowKdyeBcEUNbiFEXlp0bdQz5RJgdkJYLbBDRJ4m",
  "expiresIn": 3600
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "code": 401,
    "message": "Unauthorized"
  }
}

Invalidate current access token
DELETE/token

Invalidate current access token. This is not sign-out. If the browser has active session ID, new access token can be obtained easily.

This method accepts DELETE and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/token
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken={AccessToken}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}

Assets

This is the Assets resource.

Upload

Upload a single file
POST/assets/upload{?overwrite_once}

Upload a single file. This endpoint needs following permissions.

  • upload

Post form data is following:

  • site_id: 1 (number, required) - The site ID to upload.

  • path: /images (string) - The upload destination.

  • autoRenameIfExists: true (boolean) - If true specified, uploaded file will be renamed automatically when same file already exists.

  • normalizeOrientation: false (boolean) - If true spoecified, automatically modify file orientation by EXIF record.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/assets/upload?overwrite_once=
URI Parameters
HideShow
overwrite_once
number (optional) 

If specify “1”, the API always overwrites an existing file with the uploaded file. This parameter is available in Movable Type 6.1.2

Request
HideShow
Headers
Content-Type: multipart/form-data
X-MT-Authorization: MTAuth accessToken=<TOKEN>
Response  200
HideShow

No Errors.

Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "fileExt": "Hello, world!",
  "filename": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "meta": {
    "fileSize": 1,
    "height": 1,
    "width": 1
  },
  "mimeType": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": {
    "id": 1
  },
  "tags": [
    "Hello, world!"
  ],
  "updatable": true,
  "url": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this asset."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who created asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who created asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this asset. (format: iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this asset."
    },
    "fileExt": {
      "type": "string",
      "description": "The file extension of this asset. Returns the file extension without the leading period."
    },
    "filename": {
      "type": "string",
      "description": "The filename of this asset that includes file extension."
    },
    "id": {
      "type": "number",
      "description": "The ID of this asset."
    },
    "label": {
      "type": "string",
      "description": "The label of this asset."
    },
    "meta": {
      "type": "object",
      "properties": {
        "fileSize": {
          "type": "number",
          "description": "The file size of this asset. If this asset is not file-based asset, will return null."
        },
        "height": {
          "type": "number",
          "description": "The height of this asset. If this asset has no height meta information, will return null"
        },
        "width": {
          "type": "number",
          "description": "The width of this asset. If this asset has no width meta information, will return null."
        }
      }
    },
    "mimeType": {
      "type": "string",
      "description": "The MIME Type of this asset."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who modified asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who modified asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent asset."
        }
      }
    },
    "tags": {
      "type": "array",
      "description": "A list of tags associated with this asset."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
    },
    "url": {
      "type": "string",
      "description": "The permalink URL of this asset."
    }
  }
}
Response  403
HideShow

Do not have permission to upload file.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json
Response  409
HideShow

Uploaded file already exists.

Headers
Content-Type: application/json
Response  413
HideShow

Upload file size is larger than CGIMaxUpload.

Headers
Content-Type: application/json

Assets Collection

Assets Collection
GET/sites/{site_id}/assets{?search,searchFields,limit,offset,class,sortBy,sortOrder,fields,relatedAssets,dateField,dateFrom,dateTo}

Retrieve list of assets in the specified site.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/assets?search=&searchFields=label&limit=10&offset=0&class=&sortBy=created_on&sortOrder=descend&fields=&relatedAssets=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, will retrieve system-level assets.

search
string (optional) 

Search query.

searchFields
string (optional) Example: label

The comma separated list of field names to search.

limit
number (optional) Example: 10

Maximum number of assets to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

class
string (optional) 

The target asset class to retrieve. Supported values are 'image’, 'audio’, 'video’, 'file’, and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.

sortBy
string (optional) Example: created_on

  • file_name: Sort by the filename of each asset.

  • created_by: Sort by the ID of user who created each asset.

  • created_on (default): Sort by the created time of each asset.

sortOrder
string (optional) Example: descend

  • descend (default): Return assets in descending order. For sorting by date, it means from newest to oldest.

  • ascend: Return assets in ascending order. For sorting by date, it means from oldest to newest.

fields
string (optional) 

The field list to retrieve as part of the Assets resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

relatedAssets
boolean (optional) 

If you want to retrieve related assets (e.g. thumbnail, popup html) that generated by original asset, you should specify this parameter as true.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow

No Errors.

Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "fileExt": "Hello, world!",
      "filename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "meta": {
        "fileSize": 1,
        "height": 1,
        "width": 1
      },
      "mimeType": "Hello, world!",
      "modifiedBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": {
        "id": 1
      },
      "tags": [
        "Hello, world!"
      ],
      "updatable": true,
      "url": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this asset."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who created asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who created asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this asset. (format: iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this asset."
          },
          "fileExt": {
            "type": "string",
            "description": "The file extension of this asset. Returns the file extension without the leading period."
          },
          "filename": {
            "type": "string",
            "description": "The filename of this asset that includes file extension."
          },
          "id": {
            "type": "number",
            "description": "The ID of this asset."
          },
          "label": {
            "type": "string",
            "description": "The label of this asset."
          },
          "meta": {
            "type": "object",
            "properties": {
              "fileSize": {
                "type": "number",
                "description": "The file size of this asset. If this asset is not file-based asset, will return null."
              },
              "height": {
                "type": "number",
                "description": "The height of this asset. If this asset has no height meta information, will return null"
              },
              "width": {
                "type": "number",
                "description": "The width of this asset. If this asset has no width meta information, will return null."
              }
            }
          },
          "mimeType": {
            "type": "string",
            "description": "The MIME Type of this asset."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who modified asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who modified asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
          },
          "parent": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of parent asset."
              }
            }
          },
          "tags": {
            "type": "array",
            "description": "A list of tags associated with this asset."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
          },
          "url": {
            "type": "string",
            "description": "The permalink URL of this asset."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of assets.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Assets Collection by entry

Assets Collection by entry
GET/sites/{site_id}/entries/{entry_id}/assets{?limit,offset,class,sortBy,sortOrder,fields,dateField,dateFrom,dateTo}

Retrieve assets that related with specified entry.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/entry_id/assets?limit=10&offset=0&class=&sortBy=created_on&sortOrder=descend&fields=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

entry_id
number (required) 

The entry ID.

limit
number (optional) Example: 10

Maximum number of assets to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

class
string (optional) 

The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.

sortBy
string (optional) Example: created_on

  • file_name: Sort by the filename of each asset.

  • created_by: Sort by the ID of user who created each asset.

  • created_on (default): Sort by the created time of each asset.

sortOrder
string (optional) Example: descend

  • descend (default): Return assets in descending order. For sorting by date, it means from newest to oldest.

  • ascend: Return assets in ascending order. For sorting by date, it means from oldest to newest.

fields
string (optional) 

The field list to retrieve as part of the Assets resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "fileExt": "Hello, world!",
      "filename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "meta": {
        "fileSize": 1,
        "height": 1,
        "width": 1
      },
      "mimeType": "Hello, world!",
      "modifiedBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": {
        "id": 1
      },
      "tags": [
        "Hello, world!"
      ],
      "updatable": true,
      "url": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this asset."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who created asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who created asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this asset. (format: iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this asset."
          },
          "fileExt": {
            "type": "string",
            "description": "The file extension of this asset. Returns the file extension without the leading period."
          },
          "filename": {
            "type": "string",
            "description": "The filename of this asset that includes file extension."
          },
          "id": {
            "type": "number",
            "description": "The ID of this asset."
          },
          "label": {
            "type": "string",
            "description": "The label of this asset."
          },
          "meta": {
            "type": "object",
            "properties": {
              "fileSize": {
                "type": "number",
                "description": "The file size of this asset. If this asset is not file-based asset, will return null."
              },
              "height": {
                "type": "number",
                "description": "The height of this asset. If this asset has no height meta information, will return null"
              },
              "width": {
                "type": "number",
                "description": "The width of this asset. If this asset has no width meta information, will return null."
              }
            }
          },
          "mimeType": {
            "type": "string",
            "description": "The MIME Type of this asset."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who modified asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who modified asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
          },
          "parent": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of parent asset."
              }
            }
          },
          "tags": {
            "type": "array",
            "description": "A list of tags associated with this asset."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
          },
          "url": {
            "type": "string",
            "description": "The permalink URL of this asset."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of assets.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Assets Collection by page

Assets Collection by page
GET/sites/{site_id}/pages/{page_id}/assets{?limit,offset,class,sortBy,sortOrder,fields,dateField,dateFrom,dateTo}

Retrieve assets that related with specified page.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/pages/page_id/assets?limit=10&offset=0&class=&sortBy=created_on&sortOrder=descend&fields=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

page_id
number (required) 

The page ID.

limit
number (optional) Example: 10

Maximum number of assets to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

class
string (optional) 

The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.

sortBy
string (optional) Example: created_on

  • file_name: Sort by the filename of each asset.

  • created_by: Sort by the ID of user who created each asset.

  • created_on (default): Sort by the created time of each asset.

sortOrder
string (optional) Example: descend

  • descend (default): Return assets in descending order. For sorting by date, it means from newest to oldest.

  • ascend: Return assets in ascending order. For sorting by date, it means from oldest to newest.

fields
string (optional) 

The field list to retrieve as part of the Assets resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "fileExt": "Hello, world!",
      "filename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "meta": {
        "fileSize": 1,
        "height": 1,
        "width": 1
      },
      "mimeType": "Hello, world!",
      "modifiedBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": {
        "id": 1
      },
      "tags": [
        "Hello, world!"
      ],
      "updatable": true,
      "url": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this asset."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who created asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who created asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this asset. (format: iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this asset."
          },
          "fileExt": {
            "type": "string",
            "description": "The file extension of this asset. Returns the file extension without the leading period."
          },
          "filename": {
            "type": "string",
            "description": "The filename of this asset that includes file extension."
          },
          "id": {
            "type": "number",
            "description": "The ID of this asset."
          },
          "label": {
            "type": "string",
            "description": "The label of this asset."
          },
          "meta": {
            "type": "object",
            "properties": {
              "fileSize": {
                "type": "number",
                "description": "The file size of this asset. If this asset is not file-based asset, will return null."
              },
              "height": {
                "type": "number",
                "description": "The height of this asset. If this asset has no height meta information, will return null"
              },
              "width": {
                "type": "number",
                "description": "The width of this asset. If this asset has no width meta information, will return null."
              }
            }
          },
          "mimeType": {
            "type": "string",
            "description": "The MIME Type of this asset."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who modified asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who modified asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
          },
          "parent": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of parent asset."
              }
            }
          },
          "tags": {
            "type": "array",
            "description": "A list of tags associated with this asset."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
          },
          "url": {
            "type": "string",
            "description": "The permalink URL of this asset."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of assets.

Headers
Content-Type: application/json
Response  404
HideShow

Site or page not found.

Headers
Content-Type: application/json

Assets Collection by tag

Assets Collection by tag
GET/sites/{site_id}/tags/{tag_id}/assets{?limit,offset,class,sortBy,sortOrder,fields,dateField,dateFrom,dateTo}

Retrieve assets that related with specified tag.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/tags/tag_id/assets?limit=10&offset=0&class=&sortBy=created_on&sortOrder=descend&fields=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

tag_id
number (required) 

The page ID.

limit
number (optional) Example: 10

Maximum number of assets to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

class
string (optional) 

The target asset class to retrieve. Supported values are image, audio, video, file and any values added by plugins. If you want to retrieve multiple classes, specify the values separated by commas.

sortBy
string (optional) Example: created_on

  • file_name: Sort by the filename of each asset.

  • created_by: Sort by the ID of user who created each asset.

  • created_on (default): Sort by the created time of each asset.

sortOrder
string (optional) Example: descend

  • descend (default): Return assets in descending order. For sorting by date, it means from newest to oldest.

  • ascend: Return assets in ascending order. For sorting by date, it means from oldest to newest.

fields
string (optional) 

The field list to retrieve as part of the Assets resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "fileExt": "Hello, world!",
      "filename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "meta": {
        "fileSize": 1,
        "height": 1,
        "width": 1
      },
      "mimeType": "Hello, world!",
      "modifiedBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": {
        "id": 1
      },
      "tags": [
        "Hello, world!"
      ],
      "updatable": true,
      "url": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this asset."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who created asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who created asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this asset. (format: iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this asset."
          },
          "fileExt": {
            "type": "string",
            "description": "The file extension of this asset. Returns the file extension without the leading period."
          },
          "filename": {
            "type": "string",
            "description": "The filename of this asset that includes file extension."
          },
          "id": {
            "type": "number",
            "description": "The ID of this asset."
          },
          "label": {
            "type": "string",
            "description": "The label of this asset."
          },
          "meta": {
            "type": "object",
            "properties": {
              "fileSize": {
                "type": "number",
                "description": "The file size of this asset. If this asset is not file-based asset, will return null."
              },
              "height": {
                "type": "number",
                "description": "The height of this asset. If this asset has no height meta information, will return null"
              },
              "width": {
                "type": "number",
                "description": "The width of this asset. If this asset has no width meta information, will return null."
              }
            }
          },
          "mimeType": {
            "type": "string",
            "description": "The MIME Type of this asset."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of user who modified asset."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of user who modified asset."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
          },
          "parent": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of parent asset."
              }
            }
          },
          "tags": {
            "type": "array",
            "description": "A list of tags associated with this asset."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
          },
          "url": {
            "type": "string",
            "description": "The permalink URL of this asset."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of assets.

Headers
Content-Type: application/json
Response  404
HideShow

Site or tag not found.

Headers
Content-Type: application/json

Asset

Fetch single asset
GET/sites/{site_id}/assets/{asset_id}{?fields}

Retrieve a single asset by its ID.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/assets/1?fields=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

asset_id
number (required) Example: 1

The asset ID.

fields
string (optional) 

The field list to retrieve as part of the Assets resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "fileExt": "Hello, world!",
  "filename": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "meta": {
    "fileSize": 1,
    "height": 1,
    "width": 1
  },
  "mimeType": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": {
    "id": 1
  },
  "tags": [
    "Hello, world!"
  ],
  "updatable": true,
  "url": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this asset."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who created asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who created asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this asset. (format: iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this asset."
    },
    "fileExt": {
      "type": "string",
      "description": "The file extension of this asset. Returns the file extension without the leading period."
    },
    "filename": {
      "type": "string",
      "description": "The filename of this asset that includes file extension."
    },
    "id": {
      "type": "number",
      "description": "The ID of this asset."
    },
    "label": {
      "type": "string",
      "description": "The label of this asset."
    },
    "meta": {
      "type": "object",
      "properties": {
        "fileSize": {
          "type": "number",
          "description": "The file size of this asset. If this asset is not file-based asset, will return null."
        },
        "height": {
          "type": "number",
          "description": "The height of this asset. If this asset has no height meta information, will return null"
        },
        "width": {
          "type": "number",
          "description": "The width of this asset. If this asset has no width meta information, will return null."
        }
      }
    },
    "mimeType": {
      "type": "string",
      "description": "The MIME Type of this asset."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who modified asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who modified asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent asset."
        }
      }
    },
    "tags": {
      "type": "array",
      "description": "A list of tags associated with this asset."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
    },
    "url": {
      "type": "string",
      "description": "The permalink URL of this asset."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve an asset.

Headers
Content-Type: application/json
Response  404
HideShow

Site or asset not found.

Headers
Content-Type: application/json

Update asset.
PUT/sites/{site_id}/assets/{asset_id}

Authentication required.

Update an asset. This endpoint needs following permissions.

  • Manage Assets

This method accepts PUT and POST with __method=PUT.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/assets/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

asset_id
number (required) Example: 1

The asset ID.

Request  Assets resource
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
asset={
  "url" : "http://localhost/blog/20140917-2/images/0cf61aae.jpg",
  "id" : "1",
  "parent" : null,
  "blog" : {
    "id" : "1"
  },
  "description" : "Over the rainbow.",
  "tags" : [
    "boston",
    "bridge",
    "light",
    "night"
  ],
  "label" : "Night Bridge",
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "fileExt": "Hello, world!",
  "filename": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "meta": {
    "fileSize": 1,
    "height": 1,
    "width": 1
  },
  "mimeType": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": {
    "id": 1
  },
  "tags": [
    "Hello, world!"
  ],
  "updatable": true,
  "url": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this asset."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who created asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who created asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this asset. (format: iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this asset."
    },
    "fileExt": {
      "type": "string",
      "description": "The file extension of this asset. Returns the file extension without the leading period."
    },
    "filename": {
      "type": "string",
      "description": "The filename of this asset that includes file extension."
    },
    "id": {
      "type": "number",
      "description": "The ID of this asset."
    },
    "label": {
      "type": "string",
      "description": "The label of this asset."
    },
    "meta": {
      "type": "object",
      "properties": {
        "fileSize": {
          "type": "number",
          "description": "The file size of this asset. If this asset is not file-based asset, will return null."
        },
        "height": {
          "type": "number",
          "description": "The height of this asset. If this asset has no height meta information, will return null"
        },
        "width": {
          "type": "number",
          "description": "The width of this asset. If this asset has no width meta information, will return null."
        }
      }
    },
    "mimeType": {
      "type": "string",
      "description": "The MIME Type of this asset."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who modified asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who modified asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent asset."
        }
      }
    },
    "tags": {
      "type": "array",
      "description": "A list of tags associated with this asset."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
    },
    "url": {
      "type": "string",
      "description": "The permalink URL of this asset."
    }
  }
}
Response  401
HideShow

Authentication required

Headers
Content-Type: application/json
Response  403
HideShow

Do not have permission to update an asset.

Headers
Content-Type: application/json
Response  404
HideShow

Asset (or site) not found.

Headers
Content-Type: application/json
Response  405
HideShow

Request method is not ‘PUT’ or ‘POST’ with ‘__method=PUT’.

Headers
Content-Type: application/json

Delete asset.
DELETE/sites/{site_id}/assets/{asset_id}

Authentication required.

Delete an asset. This endpoint needs following permissions.

  • Manage Assets

This method accepts DELETE and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/assets/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

asset_id
number (required) Example: 1

The asset ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "fileExt": "Hello, world!",
  "filename": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "meta": {
    "fileSize": 1,
    "height": 1,
    "width": 1
  },
  "mimeType": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": {
    "id": 1
  },
  "tags": [
    "Hello, world!"
  ],
  "updatable": true,
  "url": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this asset."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The type of this asset. This value is similar to 'type' attribute but this value is never localized."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who created asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who created asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of creating user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this asset. (format: iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this asset."
    },
    "fileExt": {
      "type": "string",
      "description": "The file extension of this asset. Returns the file extension without the leading period."
    },
    "filename": {
      "type": "string",
      "description": "The filename of this asset that includes file extension."
    },
    "id": {
      "type": "number",
      "description": "The ID of this asset."
    },
    "label": {
      "type": "string",
      "description": "The label of this asset."
    },
    "meta": {
      "type": "object",
      "properties": {
        "fileSize": {
          "type": "number",
          "description": "The file size of this asset. If this asset is not file-based asset, will return null."
        },
        "height": {
          "type": "number",
          "description": "The height of this asset. If this asset has no height meta information, will return null"
        },
        "width": {
          "type": "number",
          "description": "The width of this asset. If this asset has no width meta information, will return null."
        }
      }
    },
    "mimeType": {
      "type": "string",
      "description": "The MIME Type of this asset."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of user who modified asset."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of user who modified asset."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modifying user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this asset.  (format: iso 8601 datetime)"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent asset."
        }
      }
    },
    "tags": {
      "type": "array",
      "description": "A list of tags associated with this asset."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this asset.\n\nfalse: The user who accessed cannot update this asset."
    },
    "url": {
      "type": "string",
      "description": "The permalink URL of this asset."
    }
  }
}
Response  401
HideShow

Authentication required

Headers
Content-Type: application/json
Response  403
HideShow

Do not have permission to delete an asset.

Headers
Content-Type: application/json
Response  404
HideShow

Asset (or site) not found.

Headers
Content-Type: application/json
Response  405
HideShow

Request method is not ‘DELETE’ or ‘POST’ with ‘__method=DELETE’.

Headers
Content-Type: application/json

Get thumbnail image
GET/sites/{site_id}/assets/{asset_id}/thumbnail{?width,height,scale,square}

This endpoint requires one of parameter ‘width’ or ‘height’ or ‘scale’ Also, cannot use these parameters at same time.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/assets/1/thumbnail?width=200&height=200&scale=50&square=true
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

asset_id
number (required) Example: 1

The asset ID.

width
number (optional) Example: 200

The width of the thumbnail to generate. If this is the only parameter specified then the thumbnail’s width will be scaled proportionally to the height. When a value longer than the original image is specified, it will be ignored.

height
number (optional) Example: 200

The height of the thumbnail to generate. If this is the only parameter specified then the thumbnail’s height will be scaled proportionally to the width. When both of height and width are specified, the longer side of the original image will be processed, and the lesser side will be scaled proportionally.

scale
number (optional) Example: 50

The percentage by which to reduce or increase the size of the current asset.

square
boolean (optional) Example: true

If set to true then the thumbnail generated will be square, where the length of each side of the square will be equal to the shortest side of the image.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "height": 200,
  "width": 200,
  "url": "http://example.com/assets_c/2014/10/the-bridge-200x200-1.jpg"
}
Response  400
HideShow

An asset does not support to generate thumbnail file.

Headers
Content-Type: application/json
Response  404
HideShow

Asset (or site) not found.

Headers
Content-Type: application/json

Categories

Categories Collection

Create a new category
POST/sites/{site_id}/categories

Authentication required.

Create a new category. This endpoint needs following permissions.

  • Manage Categories

Post form data is following:

  • category (Category) - Category resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories
URI Parameters
HideShow
site_id
number (required) 

The site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
category={"basename" : "news","parent" : "0","label","description" : null}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new category.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Retrieve a list of categories
GET/sites/{site_id}/categories{?search,searchFields,limit,offset,sortBy,sortOrder,fields,top,includeIds,excludeIds,dateField,dateFrom,dateTo}

Retrieve list of categories in the specified site.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories?search=&searchFields=label,basename&limit=10&offset=0&sortBy=user_custom&sortOrder=&fields=&top=0&includeIds=&excludeIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: label,basename

The comma separated list of field names to search.

limit
number (optional) Example: 10

Maximum number of categories to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: user_custom

  • user_custom: Sort order you specified on the Manage Categories screen.

  • created_by: Sort by the ID of user who created each category.

  • id: Sort by the ID of each category.

  • basename: Sort by the basename of each category.

  • label: Sort by the label of each category.

sortOrder
string (optional) Default: descend 

  • descend (default): Return categories in descending order.

  • *ascend: Return categories in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Categories resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

top
number (optional) Example: 0

If set to 1, retrieves only top level categories. New in v2

includeIds
string (optional) 

The comma separated list of category IDs to include in result.

excludeIds
string (optional) 

The comma separated list of category IDs to exclude from result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Categories Collection by entry

Categories Collection by entry
GET/sites/entries/categories{?search,searchFields,limit,offset,sortBy,sortOrder,fields,type,includeIds,excludeIds,top,dateField,dateFrom,dateTo}

Retrieve list of categories in the specified site. If you want to retrieve the non-published an entry’s categories, needs authentication and user must have following permission.

  • edit_entry

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/entries/categories?search=&searchFields=label,basename&limit=10&offset=0&sortBy=user_custom&sortOrder=&fields=&type=&includeIds=&excludeIds=&top=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
search
string (optional) 

Search query.

searchFields
string (optional) Example: label,basename

The comma separated list of field names to search.

limit
number (optional) Example: 10

Maximum number of categories to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: user_custom

  • user_custom: Sort order you specified on the Manage Categories screen.

  • created_by: Sort by the ID of user who created each category.

  • id: Sort by the ID of each category.

  • basename: Sort by the basename of each category.

  • label: Sort by the label of each category.

sortOrder
string (optional) Default: descend 

  • descend (default): Return categories in descending order.

  • *ascend: Return categories in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Categories resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

top
number (optional) Example: 0

If set to 1, retrieves only top level categories. New in v2

includeIds
string (optional) 

The comma separated list of category IDs to include in result.

excludeIds
string (optional) 

The comma separated list of category IDs to exclude from result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

type
string (optional) 

  • primary: Retrieve primary category only.

  • secondary: Retrieve secondary categories only.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Categories Collection for parent categories

Categories Collection for parent categories
GET/sites/{site_id}/categories/{category_id}/parents{?maxDepth,includeCurrent,dateField,dateFrom,dateTo}

Retrieve list of parent categories of the specified category.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/category_id/parents?maxDepth=0&includeCurrent=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_id
number (required) 

The category ID.

maxDepth
number (optional) Example: 0

The depth of retrieving parent categories.

includeCurrent
number (optional) Example: 0

  • 1: The list does not include current category.

  • The list includes current category.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Categories Collection for siblings categories

Categories Collection for siblings categories
GET/sites/{site_id}/categories/{category_id}/siblings{?search,searchFields,limit,offset,sortBy,sortOrder,fields,top,includeIds,excludeIds,dateField,dateFrom,dateTo}

Retrieve list of siblings categories of the specified category.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/category_id/siblings?search=&searchFields=label,basename&limit=10&offset=0&sortBy=user_custom&sortOrder=descend&fields=&top=0&includeIds=&excludeIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_id
number (required) 

The category ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: label,basename

The comma separated list of field names to search.

limit
number (optional) Example: 10

Maximum number of categories to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: user_custom
  • user_custom: Sort order you specified on the Manage Categories screen.

  • created_by: Sort by the ID of user who created each category.

  • id: Sort by the ID of each category.

  • basename: Sort by the basename of each category.

  • label: Sort by the label of each category.

sortOrder
string (optional) Example: descend

  • descend (default): Return categories in descending order.

  • ascend: Return categories in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Categories resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

top
number (optional) Example: 0

If set to 1, retrieves only top level categories. New in v2

includeIds
string (optional) 

The comma separated list of category IDs to include in result.

excludeIds
string (optional) 

The comma separated list of category IDs to exclude from result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Categoris Collection for child categories

Categoris Collection for child categories
GET/sites/{site_id}/categories/{category_id}/children{?maxDepth,includeCurrent,dateField,dateFrom,dateTo}

Retrieve list of child categories of the specified category.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/category_id/children?maxDepth=0&includeCurrent=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_id
number (required) 

The category ID.

maxDepth
number (optional) Example: 0

The depth of retrieving parent categories.

includeCurrent
number (optional) Example: 0

  • 1: The list does not include current category.

  • The list includes current category.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Category

Fetch single category
GET/sites/{site_id}/categories/{category_id}{?fields}

Retrieve a single category by its ID.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/category_id?fields=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_id
number (required) 

The category ID.

fields
string (optional) 

The field list to retrieve as part of the Categories resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a category.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Update single category
PUT/sites/{site_id}/categories/{category_id}

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Categories

This method accepts PUT and POST with __method=PUT.

Post form data is following:

  • category (Category) - Category resource

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/category_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_id
number (required) 

The category ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
category={"basename" : "news","parent" : "0","archiveLink" : "http://example.com/news/index.html","updatable" : false,"label" : "News","class" : "category","id" : "1","blog" : {"id" : "1"},"description" : null,"customFields" : [{"basename" : "bannerImage","value" : "http://example.com/images/banner.jpg"}]}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to update a category.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Delete single category
DELETE/sites/{site_id}/categories/{category_id}

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Categories

This method accepts DELETE and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/category_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_id
number (required) 

The category ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to update a category.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Save hierarchical categories order

Save hierarchical categories order
POST/sites/{site_id}/categories/permutate

Authentication required.

Save hierarchical categories order. This endpoint need folllowing permissions.

  • Manage Categories

This method returns rearranged Categories collection.

Post form data is following:

  • categories (array[Category]) - Array of Categories resource that were rearranged.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/permutate
URI Parameters
HideShow
site_id
number (required) 

The site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
categories=[{"basename" : "news","parent" : "0","archiveLink" : "http://example.com/news/index.html","updatable" : false,"label" : "News","class" : "category","id" : "1","blog" : {"id" : "1"},"description" : null,"customFields" : [{"basename" : "bannerImage","value" : "http://example.com/images/banner.jpg"},{"basename" : "pressreleases","parent" : "0","archiveLink" : "http://example.com/pressreleases/index.html","updatable" : false,"label" : "Press releases","class" : "category","id" : "2","blog" : {"id" : "1"},"description" : null,}]
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "archiveLink": "Hello, world!",
    "basename": "Hello, world!",
    "blog": {
      "id": 1
    },
    "class": "Hello, world!",
    "createdBy": {
      "displayName": "Hello, world!",
      "id": 1,
      "userpicUrl": "Hello, world!"
    },
    "createdDate": "Hello, world!",
    "customFields": [
      {
        "basename": "Hello, world!",
        "value": "Hello, world!"
      }
    ],
    "description": "Hello, world!",
    "id": 1,
    "label": "Hello, world!",
    "modifiedBy": {
      "displayName": "Hello, world!",
      "id": 1,
      "userpicUrl": "Hello, world!"
    },
    "modifiedDate": "Hello, world!",
    "parent": 1,
    "updatable": true
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "archiveLink": {
        "type": "string",
        "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
      },
      "basename": {
        "type": "string",
        "description": "The basename of this category."
      },
      "blog": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "The ID of the site that contains this category."
          }
        }
      },
      "class": {
        "type": "string",
        "description": "The object class for this category."
      },
      "createdBy": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of the user who created this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of the user who created this category."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
          }
        }
      },
      "createdDate": {
        "type": "string",
        "description": "he created time for this category. (format is iso 8601 datetime)"
      },
      "customFields": {
        "type": "array"
      },
      "description": {
        "type": "string",
        "description": "The description of this category."
      },
      "id": {
        "type": "number",
        "description": "The ID of this category."
      },
      "label": {
        "type": "string",
        "description": "The label of this category."
      },
      "modifiedBy": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of the user who modified this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of the user who modified this category."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
          }
        }
      },
      "modifiedDate": {
        "type": "string",
        "description": "The last modified time for this category. (format is iso 8601 datetime)"
      },
      "parent": {
        "type": "number",
        "description": "The ID of the parent category for this category. This field can be updated from v2."
      },
      "updatable": {
        "type": "boolean",
        "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
      }
    }
  }
}

Categoris Collection for category set

Categoris Collection for category set
GET/sites/{site_id}/categorySets/{category_set_id}/categories{?maxDepth,includeCurrent,dateField,dateFrom,dateTo}

Retrieve list of categories of the specified category set.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories?maxDepth=0&includeCurrent=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

maxDepth
number (optional) Example: 0

The depth of retrieving parent categories.

includeCurrent
number (optional) Example: 0

  • 1: The list does not include current category.

  • The list includes current category.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category set not found.

Headers
Content-Type: application/json

Create a new category for category set
POST/sites/{site_id}/categorySets/{category_set_id}/categories

Authentication required.

Create a new category in category set. This endpoint needs following permissions.

  • Manage Category Set

Post form data is following:

  • category (Category) - Category resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
category={"basename" : "news","parent" : "0","label" : "News",description" : null}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new category.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category set not found.

Headers
Content-Type: application/json

Categoris Collection of parent categories for category set

Categoris Collection of parent categories for category set
GET/sites/{site_id}/categorySets/{category_set_id}/categories/{category_id}/parents{?maxDepth,includeCurrent,dateField,dateFrom,dateTo}

Retrieve list of parent categories of the specified category set.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories/category_id/parents?maxDepth=0&includeCurrent=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

category_id
number (required) 

The category ID.

maxDepth
number (optional) Example: 0

The depth of retrieving parent categories.

includeCurrent
number (optional) Example: 0

  • 1: The list does not include current category.

  • The list includes current category.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site, category set or category not found.

Headers
Content-Type: application/json

Categoris Collection of child categories for category set

Categoris Collection of child categories for category set
GET/sites/{site_id}/categorySets/{category_set_id}/categories/{category_id}/siblings{?maxDepth,includeCurrent,dateField,dateFrom,dateTo}

Retrieve list of child categories of the specified category set.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories/category_id/siblings?maxDepth=0&includeCurrent=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

category_id
number (required) 

The category ID.

maxDepth
number (optional) Example: 0

The depth of retrieving parent categories.

includeCurrent
number (optional) Example: 0

  • 1: The list does not include current category.

  • The list includes current category.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveLink": "Hello, world!",
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveLink": {
            "type": "string",
            "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
          },
          "basename": {
            "type": "string",
            "description": "The basename of this category."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The object class for this category."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who created this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who created this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "he created time for this category. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "description": {
            "type": "string",
            "description": "The description of this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category."
          },
          "label": {
            "type": "string",
            "description": "The label of this category."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of the user who modified this category."
              },
              "id": {
                "type": "number",
                "description": "The ID of the user who modified this category."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this category. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent category for this category. This field can be updated from v2."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of categories.

Headers
Content-Type: application/json
Response  404
HideShow

Site, category set or category not found.

Headers
Content-Type: application/json

Category for Category Set

Fetch single category in category set
GET/sites/{site_id}/categorySets/{category_set_id}/categories/{category_id}{?fields}

Retrieve a single category by its ID.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories/category_id?fields=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

category_id
number (required) 

The category ID.

fields
string (optional) 

The field list to retrieve as part of the Categories resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a category.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Update single category in category set
PUT/sites/{site_id}/categorySets/{category_set_id}/categories/{category_id}

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Categoy Set

Post form data is following:

  • category (Category) - Category resource

This method accepts PUT and POST with __method=PUT.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories/category_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

category_id
number (required) 

The category ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
category={"basename" : "news","parent" : "0","archiveLink" : "http://example.com/news/index.html","updatable" : false,"label" : "News","class" : "category","id" : "1","blog" : {"id" : "1"},"description" : null,"customFields" : [{"basename" : "bannerImage","value" : "http://example.com/images/banner.jpg"}]}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to update a category.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Delete single category in category set
DELETE/sites/{site_id}/categorySets/{category_set_id}/categories/{category_id}

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Category Set

This method accepts DELETE and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories/category_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

category_id
number (required) 

The category ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveLink": "Hello, world!",
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveLink": {
      "type": "string",
      "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
    },
    "basename": {
      "type": "string",
      "description": "The basename of this category."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The object class for this category."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who created this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who created this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "he created time for this category. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "description": {
      "type": "string",
      "description": "The description of this category."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category."
    },
    "label": {
      "type": "string",
      "description": "The label of this category."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of the user who modified this category."
        },
        "id": {
          "type": "number",
          "description": "The ID of the user who modified this category."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this category. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent category for this category. This field can be updated from v2."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
    }
  }
}
Response  403
HideShow

Do not have permission to update a category.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Save hierarchical categories order in category set

Save hierarchical categories order in category set
POST/sites/{site_id}/categorySets/{category_set_id}/categories/permutate

Authentication required.

Save hierarchical categories order. This endpoint need folllowing permissions.

  • Manage Category Set

This method returns rearranged Categories collection.

Post form data is following:

  • categories (array[Category]) - Array of Categories resource that were rearranged.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categorySets/category_set_id/categories/permutate
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_set_id
number (required) 

The category set ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
categories=[{"basename" : "news","parent" : "0","archiveLink" : "http://example.com/news/index.html","updatable" : false,"label" : "News","class" : "category","id" : "1","blog" : {"id" : "1"},"description" : null,"customFields" : [{"basename" : "bannerImage","value" : "http://example.com/images/banner.jpg"},{"basename" : "pressreleases","parent" : "0","archiveLink" : "http://example.com/pressreleases/index.html","updatable" : false,"label" : "Press releases","class" : "category","id" : "2","blog" : {"id" : "1"},"description" : null,}]
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "archiveLink": "Hello, world!",
    "basename": "Hello, world!",
    "blog": {
      "id": 1
    },
    "class": "Hello, world!",
    "createdBy": {
      "displayName": "Hello, world!",
      "id": 1,
      "userpicUrl": "Hello, world!"
    },
    "createdDate": "Hello, world!",
    "customFields": [
      {
        "basename": "Hello, world!",
        "value": "Hello, world!"
      }
    ],
    "description": "Hello, world!",
    "id": 1,
    "label": "Hello, world!",
    "modifiedBy": {
      "displayName": "Hello, world!",
      "id": 1,
      "userpicUrl": "Hello, world!"
    },
    "modifiedDate": "Hello, world!",
    "parent": 1,
    "updatable": true
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "archiveLink": {
        "type": "string",
        "description": "The category archive URL of this category. If “Category” archive mapping is not configured, this value will be null."
      },
      "basename": {
        "type": "string",
        "description": "The basename of this category."
      },
      "blog": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "The ID of the site that contains this category."
          }
        }
      },
      "class": {
        "type": "string",
        "description": "The object class for this category."
      },
      "createdBy": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of the user who created this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of the user who created this category."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of created user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
          }
        }
      },
      "createdDate": {
        "type": "string",
        "description": "he created time for this category. (format is iso 8601 datetime)"
      },
      "customFields": {
        "type": "array"
      },
      "description": {
        "type": "string",
        "description": "The description of this category."
      },
      "id": {
        "type": "number",
        "description": "The ID of this category."
      },
      "label": {
        "type": "string",
        "description": "The label of this category."
      },
      "modifiedBy": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of the user who modified this category."
          },
          "id": {
            "type": "number",
            "description": "The ID of the user who modified this category."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of modified user’s userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, empty string will be returned."
          }
        }
      },
      "modifiedDate": {
        "type": "string",
        "description": "The last modified time for this category. (format is iso 8601 datetime)"
      },
      "parent": {
        "type": "number",
        "description": "The ID of the parent category for this category. This field can be updated from v2."
      },
      "updatable": {
        "type": "boolean",
        "description": "true: The user who accessed can update this category.\nfalse: The user who accessed cannot update this category."
      }
    }
  }
}

Category Set

Category Set Collection

Category Set Collection
GET/sites/{site_id}/categorySets{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,dateField,dateFrom,dateTo}

Retrieve list of category set in the specified site. Authentication required if you want retrieve private field in categorySet resource. Required permissions is follows.

  • Manage Category Set
  • If you use search parameter, you must specify search parameter with searchFields parameter. (This will be fixed in a future release.)

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/categorySets?search=&searchFields=name&limit=10&offset=0&sortBy=name&sortOrder=descend&fields=&includeIds=&excludeIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: name

The comma separated field name list to search. In this version, only name is available.

limit
number (optional) Example: 10

Maximum number of category set to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: name

The field name for sort. You can specify one of following values.

  • id

  • name

  • created_on

  • modified_on

  • content_type_count

sortOrder
string (optional) Example: descend

  • descend (default): Return category set in descending order.

  • ascend: Return category set in ascending order.

fields
string (optional) 

The field list to retrieve as part of the CategorySet resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of category set to include to result.

excludeIds
string (optional) 

The comma separated ID list of category set to exclude from result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering.

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format.

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "categories": [
        {
          "basename": "Hello, world!",
          "id": 1,
          "label": "Hello, world!",
          "parent": 1
        }
      ],
      "content_type_count": 1,
      "createdDate": "Hello, world!",
      "id": 1,
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "name": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this category set. Not writable"
              }
            }
          },
          "categories": {
            "type": "array",
            "description": "List of categories. Not writable."
          },
          "content_type_count": {
            "type": "number",
            "description": "The number of content types using this category set. Not writable.\n\ncreatedBy - Created user of this category set. Not writable.\n\n+ displayName (string) - The display name of this category set creator. Not writable.\n\n+ id (number) - The ID of this category set creator. Not writable.\n\n+ userpicUrl (string) - The URL of this category set creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this category set. (format is iso 8601 datetime) Not writable."
          },
          "id": {
            "type": "number",
            "description": "The ID of this category set. Not writable."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this category set modifier. Not writable."
              },
              "id": {
                "type": "number",
                "description": "The ID of this category set modifier. Not writable."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this category set modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
              }
            },
            "description": "Last modified user of this category set. Not writable."
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this category set. (format is iso 8601 datetime) Not writable."
          },
          "name": {
            "type": "string",
            "description": "The name of this category set."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this category set. false: The user who accessed cannot update this category set."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve category set.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Create a new category set
POST/sites/{site_id}/categorySets

Authentication Required

Create a new category set. This endpoint requires following permissions.

  • Manage Category Set

Post form data is following

  • category_set (CategorySet) - Single CategorySet resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/categorySets
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

Request
HideShow
Headers
Content-Type: Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
category_set={"name":"New Category Set"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "categories": [
    {
      "basename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "parent": 1
    }
  ],
  "content_type_count": 1,
  "createdDate": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category set. Not writable"
        }
      }
    },
    "categories": {
      "type": "array",
      "description": "List of categories. Not writable."
    },
    "content_type_count": {
      "type": "number",
      "description": "The number of content types using this category set. Not writable.\n\ncreatedBy - Created user of this category set. Not writable.\n\n+ displayName (string) - The display name of this category set creator. Not writable.\n\n+ id (number) - The ID of this category set creator. Not writable.\n\n+ userpicUrl (string) - The URL of this category set creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category set. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this category set modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this category set modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this category set modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this category set. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this category set."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category set. false: The user who accessed cannot update this category set."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new category set.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found

Headers
Content-Type: application/json

CategorySet

Fetch single category set
GET/sites/{site_id}/categorySets/{category_set_id}{?fields}

Fetch a single category set. Authentication required if you want retrieve private field in categorySet resource. Required permissions is follows.

  • Manage Category Set

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/categorySets/1?fields=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

category_set_id
number (required) Example: 1

The category set ID.

fields
string (optional) 

The field list to retrieve as part of the CategorySet resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "categories": [
    {
      "basename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "parent": 1
    }
  ],
  "content_type_count": 1,
  "createdDate": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category set. Not writable"
        }
      }
    },
    "categories": {
      "type": "array",
      "description": "List of categories. Not writable."
    },
    "content_type_count": {
      "type": "number",
      "description": "The number of content types using this category set. Not writable.\n\ncreatedBy - Created user of this category set. Not writable.\n\n+ displayName (string) - The display name of this category set creator. Not writable.\n\n+ id (number) - The ID of this category set creator. Not writable.\n\n+ userpicUrl (string) - The URL of this category set creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category set. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this category set modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this category set modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this category set modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this category set. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this category set."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category set. false: The user who accessed cannot update this category set."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a category set.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category set not found

Headers
Content-Type: application/json

Update category set
PUT/sites/{site_id}/categorySets/{category_set_id}

Authentication required Update single category set. This endpoint requires following permissions.

  • Manage Category Set

Cannot update/insert/delete categories by this endpoint. If you want to manage categories in category set, please use Categories API.

This method accepts PUT or POST with parameter ‘__method=PUT’.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/categorySets/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

category_set_id
number (required) Example: 1

The category set ID.

Request
HideShow
Headers
Content-Type: Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
category_set={"name":"Update Category Set"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "categories": [
    {
      "basename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "parent": 1
    }
  ],
  "content_type_count": 1,
  "createdDate": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category set. Not writable"
        }
      }
    },
    "categories": {
      "type": "array",
      "description": "List of categories. Not writable."
    },
    "content_type_count": {
      "type": "number",
      "description": "The number of content types using this category set. Not writable.\n\ncreatedBy - Created user of this category set. Not writable.\n\n+ displayName (string) - The display name of this category set creator. Not writable.\n\n+ id (number) - The ID of this category set creator. Not writable.\n\n+ userpicUrl (string) - The URL of this category set creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category set. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this category set modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this category set modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this category set modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this category set. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this category set."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category set. false: The user who accessed cannot update this category set."
    }
  }
}
Response  403
HideShow

Do not have permission to update a category set.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category set not found

Headers
Content-Type: application/json

Delete category set
DELETE/sites/{site_id}/categorySets/{category_set_id}

Authentication required Delete a single category set. This endpoint requires following permissions.

  • Manage Category Set

This method accepts DELETE or POST with parameter ‘__method=DELETE’.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/categorySets/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

category_set_id
number (required) Example: 1

The category set ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "categories": [
    {
      "basename": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "parent": 1
    }
  ],
  "content_type_count": 1,
  "createdDate": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this category set. Not writable"
        }
      }
    },
    "categories": {
      "type": "array",
      "description": "List of categories. Not writable."
    },
    "content_type_count": {
      "type": "number",
      "description": "The number of content types using this category set. Not writable.\n\ncreatedBy - Created user of this category set. Not writable.\n\n+ displayName (string) - The display name of this category set creator. Not writable.\n\n+ id (number) - The ID of this category set creator. Not writable.\n\n+ userpicUrl (string) - The URL of this category set creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "id": {
      "type": "number",
      "description": "The ID of this category set. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this category set modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this category set modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this category set modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this category set. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this category set. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this category set."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this category set. false: The user who accessed cannot update this category set."
    }
  }
}
Response  403
HideShow

Do not have permission to delete a category set.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category set not found

Headers
Content-Type: application/json

Comments

Comments Collection

Comments Collection
GET/sites/{site_id}/comments{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,entryStatus,dateField,dateFrom,dateTo}

Authorization is required if you want to retrieve unpublished comments.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/comments?search=&searchFields=body&limit=10&offset=0&sortBy=id&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&entryStatus=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: body

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of comments to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: id

The field name for sort.

sortOrder
string (optional) Example: descend

  • descend (default): Return comments in descending order.

  • ascend: Return comments in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Comments resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of comments to include to result.

excludeIds
string (optional) 

The comma separated ID list of comments to exclude from result.

status
string (optional) 

Filter by status.

  • Approved: comment_visible is 1 and comment_junk_status is 1.

  • Pending: comment_visible is 0 and comment_junk_status is 1.

  • Spam: comment_junk_status is -1.

entryStatus
string (optional) 

Filter by container entry’s status.

  • Draft: entry_status is 1.

  • Publish: entry_status is 2.

  • Review: entry_status is 3.

  • Future: entry_status is 4.

  • Spam: entry_status is 5.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "author": "Hello, world!",
      "blog": {
        "id": 1
      },
      "body": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "date": "Hello, world!",
      "entry": {
        "id": 1
      },
      "id": 1,
      "link": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "status": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "author": {
            "type": "string",
            "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this comment."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this comment."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of created user."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of created user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this comment. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
          },
          "entry": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the entry that contains this comment."
              }
            }
          },
          "id": {
            "type": "number",
            "description": "The ID of this comment."
          },
          "link": {
            "type": "string",
            "description": "The permalink for this comment."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of last modified user."
              },
              "id": {
                "type": "number",
                "description": "The ID of last modified user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this comment. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
          },
          "status": {
            "type": "string",
            "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of comments.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Comments Collection by entry

Create a new comment for entry
POST/sites/{site_id}/entries/{entry_id}/comments

Authentication required.

Create a new commet for an entry. This endpoint need following permissions. (Perhapse, MT user almost have comment permission.)

  • Comment

Post form data is following

  • comment (Comment) - Single Comments resource.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/entry_id/comments
URI Parameters
HideShow
site_id
number (required) 

The site ID.

entry_id
number (required) 

The entry ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
comment={"body" : "This is a test comment.\nHe he he"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": "Hello, world!",
  "blog": {
    "id": 1
  },
  "body": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "entry": {
    "id": 1
  },
  "id": 1,
  "link": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "status": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "string",
      "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this comment."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this comment."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this comment. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
    },
    "entry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the entry that contains this comment."
        }
      }
    },
    "id": {
      "type": "number",
      "description": "The ID of this comment."
    },
    "link": {
      "type": "string",
      "description": "The permalink for this comment."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this comment. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
    },
    "status": {
      "type": "string",
      "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new comment.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Comments Collection by entry
GET/sites/{site_id}/entries/{entry_id}/comments{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,dateField,dateFrom,dateTo}

Authorization is required if you want to retrieve unpublished comments.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/entry_id/comments?search=&searchFields=body&limit=10&offset=0&sortBy=id&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

entry_id
number (required) 

The entry ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: body

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of comments to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: id

The field name for sort.

sortOrder
string (optional) Example: descend

  • descend (default): Return comments in descending order.

  • ascend: Return comments in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Comments resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of comments to include to result.

excludeIds
string (optional) 

The comma separated ID list of comments to exclude from result.

status
string (optional) 

Filter by status.

  • Approved: comment_visible is 1 and comment_junk_status is 1.

  • Pending: comment_visible is 0 and comment_junk_status is 1.

  • Spam: comment_junk_status is -1.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "author": "Hello, world!",
      "blog": {
        "id": 1
      },
      "body": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "date": "Hello, world!",
      "entry": {
        "id": 1
      },
      "id": 1,
      "link": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "status": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "author": {
            "type": "string",
            "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this comment."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this comment."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of created user."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of created user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this comment. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
          },
          "entry": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the entry that contains this comment."
              }
            }
          },
          "id": {
            "type": "number",
            "description": "The ID of this comment."
          },
          "link": {
            "type": "string",
            "description": "The permalink for this comment."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of last modified user."
              },
              "id": {
                "type": "number",
                "description": "The ID of last modified user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this comment. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
          },
          "status": {
            "type": "string",
            "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of comments.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Comments Collection by page

Create a new comment for page
POST/sites/{site_id}/pages/{page_id}/comments

Authentication required.

Create a new commet for an page. This endpoint need following permissions. (Perhapse, MT user almost have comment permission.)

  • Comment

Post form data is following

  • comment (Comment) - Single Comments resource.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/pages/page_id/comments
URI Parameters
HideShow
site_id
number (required) 

The site ID.

page_id
number (required) 

The page ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
comment={"body" : "This is a test comment.\nHe he he"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": "Hello, world!",
  "blog": {
    "id": 1
  },
  "body": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "entry": {
    "id": 1
  },
  "id": 1,
  "link": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "status": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "string",
      "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this comment."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this comment."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this comment. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
    },
    "entry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the entry that contains this comment."
        }
      }
    },
    "id": {
      "type": "number",
      "description": "The ID of this comment."
    },
    "link": {
      "type": "string",
      "description": "The permalink for this comment."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this comment. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
    },
    "status": {
      "type": "string",
      "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new comment.

Headers
Content-Type: application/json
Response  404
HideShow

Site or page not found.

Headers
Content-Type: application/json

Comments Collection by page
GET/sites/{site_id}/pages/{page_id}/comments{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,dateField,dateFrom,dateTo}

Authentication is required if want to include unpublished comments.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/pages/page_id/comments?search=&searchFields=body&limit=10&offset=0&sortBy=id&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

page_id
number (required) 

The page ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: body

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of comments to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: id

The field name for sort.

sortOrder
string (optional) Example: descend

  • descend (default): Return comments in descending order.

  • ascend: Return comments in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Comments resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of comments to include to result.

excludeIds
string (optional) 

The comma separated ID list of comments to exclude from result.

status
string (optional) 

Filter by status.

  • Approved: comment_visible is 1 and comment_junk_status is 1.

  • Pending: comment_visible is 0 and comment_junk_status is 1.

  • Spam: comment_junk_status is -1.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "author": "Hello, world!",
      "blog": {
        "id": 1
      },
      "body": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "date": "Hello, world!",
      "entry": {
        "id": 1
      },
      "id": 1,
      "link": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "parent": 1,
      "status": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "author": {
            "type": "string",
            "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this comment."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this comment."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of created user."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of created user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this comment. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
          },
          "entry": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the entry that contains this comment."
              }
            }
          },
          "id": {
            "type": "number",
            "description": "The ID of this comment."
          },
          "link": {
            "type": "string",
            "description": "The permalink for this comment."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of last modified user."
              },
              "id": {
                "type": "number",
                "description": "The ID of last modified user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this comment. (format is iso 8601 datetime)"
          },
          "parent": {
            "type": "number",
            "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
          },
          "status": {
            "type": "string",
            "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of comments.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Comment

Fetch single comment
GET/sites/{site_id}/comments/{comment_id}{?fields}

Authorization is required if the comment status is “unpublished”.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/comments/comment_id?fields=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

comment_id
number (required) 

The comment ID.

fields
string (optional) 

The field list to retrieve as part of the Comments resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": "Hello, world!",
  "blog": {
    "id": 1
  },
  "body": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "entry": {
    "id": 1
  },
  "id": 1,
  "link": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "status": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "string",
      "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this comment."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this comment."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this comment. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
    },
    "entry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the entry that contains this comment."
        }
      }
    },
    "id": {
      "type": "number",
      "description": "The ID of this comment."
    },
    "link": {
      "type": "string",
      "description": "The permalink for this comment."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this comment. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
    },
    "status": {
      "type": "string",
      "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve comment.

Headers
Content-Type: application/json
Response  404
HideShow

Site or comment not found.

Headers
Content-Type: application/json

Update single comment
PUT/sites/{site_id}/comments/{comment_id}

Authentication required. Update comment. This endpoint need following permissions. (Perhapse, MT user almost have comment permission.)

  • Comment

This method accepts PUT and POST with __method=PUT.

Post form data is following

  • comment (Comment) - Single Comments resource.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/comments/comment_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

comment_id
number (required) 

The comment ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
comment={"body" : "This is a test comment.\nHe he he"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": "Hello, world!",
  "blog": {
    "id": 1
  },
  "body": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "entry": {
    "id": 1
  },
  "id": 1,
  "link": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "status": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "string",
      "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this comment."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this comment."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this comment. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
    },
    "entry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the entry that contains this comment."
        }
      }
    },
    "id": {
      "type": "number",
      "description": "The ID of this comment."
    },
    "link": {
      "type": "string",
      "description": "The permalink for this comment."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this comment. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
    },
    "status": {
      "type": "string",
      "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
    }
  }
}
Response  403
HideShow

Do not have permission to update comment.

Headers
Content-Type: application/json
Response  404
HideShow

Site or comment not found.

Headers
Content-Type: application/json

Delete single comment
DELETE/sites/{site_id}/comments/{comment_id}

Authentication required.

Delete comment. This endpoint need following permissions. (Perhapse, MT user almost have comment permission.)

  • Comment

This method accepts PUT and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/comments/comment_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

comment_id
number (required) 

The comment ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": "Hello, world!",
  "blog": {
    "id": 1
  },
  "body": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "entry": {
    "id": 1
  },
  "id": 1,
  "link": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "status": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "string",
      "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this comment."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this comment."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this comment. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
    },
    "entry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the entry that contains this comment."
        }
      }
    },
    "id": {
      "type": "number",
      "description": "The ID of this comment."
    },
    "link": {
      "type": "string",
      "description": "The permalink for this comment."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this comment. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
    },
    "status": {
      "type": "string",
      "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
    }
  }
}
Response  403
HideShow

Do not have permission to update comment.

Headers
Content-Type: application/json
Response  404
HideShow

Site or comment not found.

Headers
Content-Type: application/json

Make a reply
POST/sites/comments/replies

Authentication required/

Make a reply comment. This endpoint need following permissions. (Perhapse, MT user almost have comment permission.)

  • Comment

Post form data is following

  • comment (Comment) - Single Comments resource.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/comments/replies
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
comment={"body" : "This is a test comment.\nHe he he"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": "Hello, world!",
  "blog": {
    "id": 1
  },
  "body": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "entry": {
    "id": 1
  },
  "id": 1,
  "link": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "parent": 1,
  "status": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "string",
      "description": "+id (number) - The ID of this commenter. If commenter is not a registerd user, this field is empty.\n\n+ displayName (string) - The display name of this commenter.\n\n+ userpicUrl (string) - The URL of this commenter's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If a commenter is not a registered user or a commenter does not set own userpic, will be returned empty string."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this comment."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this comment."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this comment. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The creation time for this comment. This property is marked as deprecated in v2.0. (format is iso 8601 datetime)"
    },
    "entry": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the entry that contains this comment."
        }
      }
    },
    "id": {
      "type": "number",
      "description": "The ID of this comment."
    },
    "link": {
      "type": "string",
      "description": "The permalink for this comment."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this comment. (format is iso 8601 datetime)"
    },
    "parent": {
      "type": "number",
      "description": "The ID of the parent of this comment. If this comment is not a reply, will be returned as null."
    },
    "status": {
      "type": "string",
      "description": "The publishing status of this comment. Approved: This comment has been approved. In the database, comment_visible = 1 and comment_junk_status = 1. Pending: This comment has not been approved. In the database, comment_visible = 0 and comment_junk_status = 1. Spam: This comment has been marked as Spam. In the database, comment_visible = 0 and comment_junk_status = -1."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this comment. false: The user who accessed cannot update this comment."
    }
  }
}
Response  403
HideShow

Do not have permission to reply comment.

Headers
Content-Type: application/json
Response  404
HideShow

Site or comment not found.

Headers
Content-Type: application/json

Content Types

Content Type Collection

Content Type Collection
GET/sites/{site_id}/contentTypes{?limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds}

Authentication required

Retrieve a list of Content Types. This endpoint requires following permission.

  • Manage Content Types

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes?limit=10&offset=0&sortBy=id&sortOrder=descend&fields=&includeIds=&excludeIds=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

limit
number (optional) Example: 10

Maximum number of entries to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: id

The field name for sort. You can specify one of following values.

  • name

  • dataLabel

  • uniqueID

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return entries in descending order.

  • ascend: Return entries in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of entries to include to result.

excludeIds
string (optional) 

The comma separated ID list of entries to exclude from result.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "contentFields": [
        {
          "id": 1,
          "label": "Hello, world!",
          "type": "Hello, world!",
          "uniqueID": "Hello, world!"
        }
      ],
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "dataLabel": "Hello, world!",
      "description": "Hello, world!",
      "id": 1,
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "name": "Hello, world!",
      "uniqueID": "Hello, world!",
      "updatable": true,
      "userDisplayOption": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The site ID. Not writable."
              }
            },
            "description": "The site of this content type. Not writable."
          },
          "contentFields": {
            "type": "array",
            "description": "The list of content fields."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this content type creator. Not writable."
              },
              "id": {
                "type": "number",
                "description": "The ID of this content type creator. Not writable."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this content type creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
              }
            },
            "description": "Created user of this content type. Not writable."
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this content type. (format is iso 8601 datetime) Not writable."
          },
          "dataLabel": {
            "type": "string",
            "description": "The Unique ID of the content field that is data label. If not set will be NULL."
          },
          "description": {
            "type": "string",
            "description": "The description of this content type."
          },
          "id": {
            "type": "number",
            "description": "The ID of this content type. Not writable."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this content type modifier. Not writable."
              },
              "id": {
                "type": "number",
                "description": "The ID of this content type modifier. Not writable."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this content type modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
              }
            },
            "description": "Last modified user of this content type. Not writable."
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this content type. (format is iso 8601 datetime) Not writable."
          },
          "name": {
            "type": "string",
            "description": "The name of this content type."
          },
          "uniqueID": {
            "type": "string",
            "description": "The unique ID of this content type. Not writable."
          },
          "updatable": {
            "type": "boolean",
            "description": "`true`: Current user can update this content type. / `false`: Current user cannot update this content type.  Not writable."
          },
          "userDisplayOption": {
            "type": "boolean",
            "description": "`true`: Signed-in user can change display options for edit content data screen of this content type in the CMS admin screen. / `false`: Signed-in user cannot change display options for edit content data screen of this content type in the CMS admin screen."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve content types.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Create Content Type
POST/sites/{site_id}/contentTypes

Authentication required

Create a new Content Type. This endpoint requires following permission.

  • Manage Content Types

Post form data is follows.

  • content_type (required, ContentType) - Single Content Type resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_type={"description": "This is new content type.","name": "New Content Type","userDisplayOption": true}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "contentFields": [
    {
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!",
      "uniqueID": "Hello, world!"
    }
  ],
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "dataLabel": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true,
  "userDisplayOption": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The site ID. Not writable."
        }
      },
      "description": "The site of this content type. Not writable."
    },
    "contentFields": {
      "type": "array",
      "description": "The list of content fields."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Created user of this content type. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "dataLabel": {
      "type": "string",
      "description": "The Unique ID of the content field that is data label. If not set will be NULL."
    },
    "description": {
      "type": "string",
      "description": "The description of this content type."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content type. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content type. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this content type."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content type. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content type. / `false`: Current user cannot update this content type.  Not writable."
    },
    "userDisplayOption": {
      "type": "boolean",
      "description": "`true`: Signed-in user can change display options for edit content data screen of this content type in the CMS admin screen. / `false`: Signed-in user cannot change display options for edit content data screen of this content type in the CMS admin screen."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new content type.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Content Type

Fetch single Content Type
GET/sites/{site_id}/contentTypes/{content_type_id}

Authentication required

Fetch single content type. This endpoint requires following permission.

  • Manage Content Types

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID

content_type_id
number (required) Example: 1

The content type ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "contentFields": [
    {
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!",
      "uniqueID": "Hello, world!"
    }
  ],
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "dataLabel": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true,
  "userDisplayOption": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The site ID. Not writable."
        }
      },
      "description": "The site of this content type. Not writable."
    },
    "contentFields": {
      "type": "array",
      "description": "The list of content fields."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Created user of this content type. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "dataLabel": {
      "type": "string",
      "description": "The Unique ID of the content field that is data label. If not set will be NULL."
    },
    "description": {
      "type": "string",
      "description": "The description of this content type."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content type. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content type. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this content type."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content type. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content type. / `false`: Current user cannot update this content type.  Not writable."
    },
    "userDisplayOption": {
      "type": "boolean",
      "description": "`true`: Signed-in user can change display options for edit content data screen of this content type in the CMS admin screen. / `false`: Signed-in user cannot change display options for edit content data screen of this content type in the CMS admin screen."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a content type.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found.

Headers
Content-Type: application/json

Update Content Type
PUT/sites/{site_id}/contentTypes/{content_type_id}

Authentication required

Update content type. This endpoint requires following permission.

  • Manage Content Types

Cannot update/insert/delete content fields by this endpoint. If you want to manage content fields, please use ContentFields API.

This method accepts PUT or POST with parameter ‘__method=PUT’.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID

content_type_id
number (required) Example: 1

The content type ID

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_type={"description": "New description"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "contentFields": [
    {
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!",
      "uniqueID": "Hello, world!"
    }
  ],
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "dataLabel": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true,
  "userDisplayOption": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The site ID. Not writable."
        }
      },
      "description": "The site of this content type. Not writable."
    },
    "contentFields": {
      "type": "array",
      "description": "The list of content fields."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Created user of this content type. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "dataLabel": {
      "type": "string",
      "description": "The Unique ID of the content field that is data label. If not set will be NULL."
    },
    "description": {
      "type": "string",
      "description": "The description of this content type."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content type. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content type. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this content type."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content type. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content type. / `false`: Current user cannot update this content type.  Not writable."
    },
    "userDisplayOption": {
      "type": "boolean",
      "description": "`true`: Signed-in user can change display options for edit content data screen of this content type in the CMS admin screen. / `false`: Signed-in user cannot change display options for edit content data screen of this content type in the CMS admin screen."
    }
  }
}
Response  403
HideShow

Do not have permission to update a content type.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found.

Headers
Content-Type: application/json

Delete Content Type
DELETE/sites/{site_id}/contentTypes/{content_type_id}

Authentication required

Delete content type. This endpoint requires following permission.

  • Manage Content Types

This method accepts DELETE or POST with parameter ‘__method=DELETE’.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID

content_type_id
number (required) Example: 1

The content type ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "contentFields": [
    {
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!",
      "uniqueID": "Hello, world!"
    }
  ],
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "dataLabel": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true,
  "userDisplayOption": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The site ID. Not writable."
        }
      },
      "description": "The site of this content type. Not writable."
    },
    "contentFields": {
      "type": "array",
      "description": "The list of content fields."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Created user of this content type. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "dataLabel": {
      "type": "string",
      "description": "The Unique ID of the content field that is data label. If not set will be NULL."
    },
    "description": {
      "type": "string",
      "description": "The description of this content type."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content type. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content type. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this content type."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content type. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content type. / `false`: Current user cannot update this content type.  Not writable."
    },
    "userDisplayOption": {
      "type": "boolean",
      "description": "`true`: Signed-in user can change display options for edit content data screen of this content type in the CMS admin screen. / `false`: Signed-in user cannot change display options for edit content data screen of this content type in the CMS admin screen."
    }
  }
}
Response  403
HideShow

Do not have permission to delete a content type.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found.

Headers
Content-Type: application/json

Content Fields

Each content fields contains some option fields. Which options are available by the field, please see the table below.

Content Field Options

Single Line Text

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • max_length (number) - The maximum length of this field value.

  • min_length (number) - The minimum length of this field value.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Multi Line Text

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display + value rather than the default value at save.

  • input_format (string) - The name of input format of this field.

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Number

  • decimal_places (number) - The length of decimal places.

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • max_value (number) - The maximum value of this field.

  • min_value (number) - The minimum value of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

URL

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Date and Time

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Date

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Time

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Select Box

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

  • values (array) - List of label-value pairs.

    • checked: checked (string) - If this field value is checked, return checked. Otherwise, return null.
    • label (string) - The label of this field value.
    • value (string) - The value of this field value.

Radio Button

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

  • values (array) - List of label-value pairs.

    • checked: checked (string) - If this field value is checked, return checked. Otherwise, return null.
    • label (string) - The label of this field value.
    • value (string) - The value of this field value.

Checkboxes

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

  • values (array) - List of label-value pairs.

    • checked: checked (string) - If this field value is checked, return checked. Otherwise, return null.
    • label (string) - The label of this field value.
    • value (string) - The value of this field value.

Asset

  • allow_upload (number):

    • 0: Users can upload new asset in this field.
    • 1: Users cannot upload new asset in this field.

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Audio

  • allow_upload (number):

    • 0: Users can upload new asset in this field.
    • 1: Users cannot upload new asset in this field.

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Video

  • allow_upload (number):

    • 0: Users can upload new asset in this field.
    • 1: Users cannot upload new asset in this field.

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Image

  • allow_upload (number):

    • 0: Users can upload new asset in this field.
    • 1: Users cannot upload new asset in this field.

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Embedded Text

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Tag

  • can_add (number) -

    • 0: Users can create a new categories in this field.
    • 1: Users cannot create a new categories in this field.

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • initial_value - Initial value of this field. This means the initial display value rather than the default value at save.

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

List

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Table

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • increase_decrease_cols (number) -

    • 0: Users can increase/decrease columns.
    • 1: Users cannot increase/decrease columns.

  • increase_decrease_rows (number) -

    • 0: Users can increase/decrease rows.
    • 1: Users cannot increase/decrease rows.

  • initial_cols (number) - The number of initial columns.

  • initial_rows (number) - The number of initial rows.

  • label (string) - The label of this field.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Content Type

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

  • source (number) - The ID of content type that linked with this field.

Category Set

  • can_add (number) -

    • 0: Users can create a new categories in this field.
    • 1: Users cannot create a new categories in this field.

  • category_set (number) - The ID of category set that linked with this field.

  • description (string) - The descrption of this field.

  • display (string) - The display option that for the listing screen of this field .

  • label (string) - The label of this field.

  • max (number) - The maximum number that can be selected for this field.

  • min (number) - The minimum number that should be selected for this field.

  • multiple (number) -

    • 0: This field cannot accept multiple selection.
    • 1: This field accept multiple selection.

  • required (number) -

    • 0: This field is not required.
    • 1: This field is required.

Content Field Collection

Content Field Collection
GET/sites/{site_id}/contentTypes/{content_type_id}/fields{?limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds}

Authentication required

Retrieve a list of Content Fields of the specified Content Type. This endpoint requires following permission.

  • Manage Content Types

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/fields?limit=10&offset=0&sortBy=id&sortOrder=descend&fields=&includeIds=&excludeIds=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

limit
number (optional) Example: 10

Maximum number of entries to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: id

The field name for sort. You can specify one of following values.

  • name

  • dataLabel

  • uniqueID

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return entries in descending order.

  • ascend: Return entries in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of entries to include to result.

excludeIds
string (optional) 

The comma separated ID list of entries to exclude from result.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "options": {
        "description": "Hello, world!",
        "display": "Hello, world!",
        "initial_value": "Hello, world!",
        "label": "Hello, world!",
        "max_length": 1,
        "min_length": 1,
        "required": 1,
        "input_format": "Hello, world!",
        "decimal_places": 1,
        "max_value": 1,
        "min_value": 1,
        "max": 1,
        "min": 1,
        "multiple": 1,
        "values": [
          {
            "checked": "checked",
            "label": "Hello, world!",
            "value": "Hello, world!"
          }
        ],
        "allow_upload": 1,
        "can_add": 1,
        "increase_decrease_cols": 1,
        "increase_decrease_rows": 1,
        "initial_cols": 1,
        "initial_rows": 1,
        "source": 1,
        "category_set": 1
      },
      "type": "Hello, world!",
      "uniqueID": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this content field creator. Not writable."
              },
              "id": {
                "type": "number",
                "description": "The ID of this content field creator. Not writable."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this content field creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
              }
            },
            "description": "The site of this content field. Not writable."
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this content field. (format is iso 8601 datetime) Not writable."
          },
          "description": {
            "type": "string",
            "description": "The description of this content field."
          },
          "id": {
            "type": "number",
            "description": "The ID of this content field. Not writable."
          },
          "label": {
            "type": "string",
            "description": "The labeel of this content field."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this content field modifier. Not writable."
              },
              "id": {
                "type": "number",
                "description": "The ID of this content field modifier. Not writable."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this content field modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
              }
            },
            "description": "Last modified user of this content field. Not writable."
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this content field. (format is iso 8601 datetime) Not writable."
          },
          "options": {
            "type": "object",
            "properties": {
              "description": {
                "type": "string",
                "description": "The descrption of this field."
              },
              "display": {
                "type": "string",
                "description": "The display option that for the listing screen of this field ."
              },
              "initial_value": {
                "type": "string",
                "description": "Initial value of this field. This means the initial display value rather than the default value at save."
              },
              "label": {
                "type": "string",
                "description": "The label of this field."
              },
              "max_length": {
                "type": "number",
                "description": "The maximum length of this field value."
              },
              "min_length": {
                "type": "number",
                "description": "The minimum length of this field value."
              },
              "required": {
                "type": "number",
                "description": "`0`: This field is not required. / `1`: This field is required."
              },
              "input_format": {
                "type": "string",
                "description": "The name of input format of this field."
              },
              "decimal_places": {
                "type": "number",
                "description": "The length of decimal places."
              },
              "max_value": {
                "type": "number",
                "description": "The maximum value of this field."
              },
              "min_value": {
                "type": "number",
                "description": "The minimum value of this field."
              },
              "max": {
                "type": "number",
                "description": "The maximum number that can be selected for this field."
              },
              "min": {
                "type": "number",
                "description": "The minimum number that should be selected for this field."
              },
              "multiple": {
                "type": "number",
                "description": "`0`: This field cannot accept multiple selection. / `1`: This field accept multiple selection."
              },
              "values": {
                "type": "array",
                "description": "List of label-value pairs."
              },
              "allow_upload": {
                "type": "number"
              },
              "can_add": {
                "type": "number",
                "description": "`0`: Users can create a new categories in this field. / `1`: Users cannot create a new categories in this field."
              },
              "increase_decrease_cols": {
                "type": "number",
                "description": "`0`: Users can increase/decrease columns. / `1`: Users cannot increase/decrease columns."
              },
              "increase_decrease_rows": {
                "type": "number",
                "description": "`0`: Users can increase/decrease rows. / `1`: Users cannot increase/decrease rows."
              },
              "initial_cols": {
                "type": "number",
                "description": "The number of initial columns."
              },
              "initial_rows": {
                "type": "number",
                "description": "The number of initial rows."
              },
              "source": {
                "type": "number",
                "description": "The ID of content type that linked with this field."
              },
              "category_set": {
                "type": "number",
                "description": "The ID of category set that linked with this field."
              }
            },
            "description": "The field option object. The members of this object are different depending on the type of field."
          },
          "type": {
            "type": "string",
            "description": "The field type. This property can be set only when creating. Available values are follows. `single_line_text`: Single line text field. / `multi_line_text`: Multiple line text field. / `number` Number field. / `url`: URL field. / `date_and_time`: Date and time field. / `date_only`: Date only fiel. / `time_only`: Time only field. / `select_box`: Select box field. / `radio_button`: Radio button field. / `checkboxes`: Checkbox field. / `asset`: Asset (file) type field. / `asset_audio`: Audio asset field. / `asset_video`: Video asset field. / `asset_image`: Image asset field. / `embedded_text`: Embedded text field. / `tags`: Tag field. / `list`: List field. / `tables`: Table field. / `content_type` Content type field. / `categories`: Category set field."
          },
          "uniqueID": {
            "type": "string",
            "description": "The unique ID of this content field. Not writable."
          },
          "updatable": {
            "type": "boolean",
            "description": "`true`: Current user can update this content field. / `false`: Current user cannot update this content field.  Not writable."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve content fields.

Headers
Content-Type: application/json
Response  404
HideShow

Site, content type or content field not found

Headers
Content-Type: application/json

Create Content Field
POST/sites/{site_id}/contentTypes/{content_type_id}/fields

Authentication required

Create a new Content Field. This endpoint requires following permission.

  • Manage Content Types

Post form data is follows.

  • content_field (required, ContentField) - Single Content Field resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/fields
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_field={"type": "single_line_text","label": "New Content Field","options": {"description": "This is new single line field.","required": "1","initial_value":"","max_length":"100","min_length":"0"}}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "options": {
    "description": "Hello, world!",
    "display": "Hello, world!",
    "initial_value": "Hello, world!",
    "label": "Hello, world!",
    "max_length": 1,
    "min_length": 1,
    "required": 1,
    "input_format": "Hello, world!",
    "decimal_places": 1,
    "max_value": 1,
    "min_value": 1,
    "max": 1,
    "min": 1,
    "multiple": 1,
    "values": [
      {
        "checked": "checked",
        "label": "Hello, world!",
        "value": "Hello, world!"
      }
    ],
    "allow_upload": 1,
    "can_add": 1,
    "increase_decrease_cols": 1,
    "increase_decrease_rows": 1,
    "initial_cols": 1,
    "initial_rows": 1,
    "source": 1,
    "category_set": 1
  },
  "type": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content field creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content field creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content field creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "The site of this content field. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content field. (format is iso 8601 datetime) Not writable."
    },
    "description": {
      "type": "string",
      "description": "The description of this content field."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content field. Not writable."
    },
    "label": {
      "type": "string",
      "description": "The labeel of this content field."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content field modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content field modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content field modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content field. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content field. (format is iso 8601 datetime) Not writable."
    },
    "options": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "The descrption of this field."
        },
        "display": {
          "type": "string",
          "description": "The display option that for the listing screen of this field ."
        },
        "initial_value": {
          "type": "string",
          "description": "Initial value of this field. This means the initial display value rather than the default value at save."
        },
        "label": {
          "type": "string",
          "description": "The label of this field."
        },
        "max_length": {
          "type": "number",
          "description": "The maximum length of this field value."
        },
        "min_length": {
          "type": "number",
          "description": "The minimum length of this field value."
        },
        "required": {
          "type": "number",
          "description": "`0`: This field is not required. / `1`: This field is required."
        },
        "input_format": {
          "type": "string",
          "description": "The name of input format of this field."
        },
        "decimal_places": {
          "type": "number",
          "description": "The length of decimal places."
        },
        "max_value": {
          "type": "number",
          "description": "The maximum value of this field."
        },
        "min_value": {
          "type": "number",
          "description": "The minimum value of this field."
        },
        "max": {
          "type": "number",
          "description": "The maximum number that can be selected for this field."
        },
        "min": {
          "type": "number",
          "description": "The minimum number that should be selected for this field."
        },
        "multiple": {
          "type": "number",
          "description": "`0`: This field cannot accept multiple selection. / `1`: This field accept multiple selection."
        },
        "values": {
          "type": "array",
          "description": "List of label-value pairs."
        },
        "allow_upload": {
          "type": "number"
        },
        "can_add": {
          "type": "number",
          "description": "`0`: Users can create a new categories in this field. / `1`: Users cannot create a new categories in this field."
        },
        "increase_decrease_cols": {
          "type": "number",
          "description": "`0`: Users can increase/decrease columns. / `1`: Users cannot increase/decrease columns."
        },
        "increase_decrease_rows": {
          "type": "number",
          "description": "`0`: Users can increase/decrease rows. / `1`: Users cannot increase/decrease rows."
        },
        "initial_cols": {
          "type": "number",
          "description": "The number of initial columns."
        },
        "initial_rows": {
          "type": "number",
          "description": "The number of initial rows."
        },
        "source": {
          "type": "number",
          "description": "The ID of content type that linked with this field."
        },
        "category_set": {
          "type": "number",
          "description": "The ID of category set that linked with this field."
        }
      },
      "description": "The field option object. The members of this object are different depending on the type of field."
    },
    "type": {
      "type": "string",
      "description": "The field type. This property can be set only when creating. Available values are follows. `single_line_text`: Single line text field. / `multi_line_text`: Multiple line text field. / `number` Number field. / `url`: URL field. / `date_and_time`: Date and time field. / `date_only`: Date only fiel. / `time_only`: Time only field. / `select_box`: Select box field. / `radio_button`: Radio button field. / `checkboxes`: Checkbox field. / `asset`: Asset (file) type field. / `asset_audio`: Audio asset field. / `asset_video`: Video asset field. / `asset_image`: Image asset field. / `embedded_text`: Embedded text field. / `tags`: Tag field. / `list`: List field. / `tables`: Table field. / `content_type` Content type field. / `categories`: Category set field."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content field. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content field. / `false`: Current user cannot update this content field.  Not writable."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new content field.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found

Headers
Content-Type: application/json

Content Field

Fetch single Content Field
GET/sites/{site_id}/contentTypes/{content_type_id}/fields/{content_field_id}

Authentication required

Fetch single content field. This endpoint requires following permission.

  • Manage Content Types

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/fields/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID

content_type_id
number (required) Example: 1

The content type ID

content_field_id
number (required) Example: 1

The content field ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "options": {
    "description": "Hello, world!",
    "display": "Hello, world!",
    "initial_value": "Hello, world!",
    "label": "Hello, world!",
    "max_length": 1,
    "min_length": 1,
    "required": 1,
    "input_format": "Hello, world!",
    "decimal_places": 1,
    "max_value": 1,
    "min_value": 1,
    "max": 1,
    "min": 1,
    "multiple": 1,
    "values": [
      {
        "checked": "checked",
        "label": "Hello, world!",
        "value": "Hello, world!"
      }
    ],
    "allow_upload": 1,
    "can_add": 1,
    "increase_decrease_cols": 1,
    "increase_decrease_rows": 1,
    "initial_cols": 1,
    "initial_rows": 1,
    "source": 1,
    "category_set": 1
  },
  "type": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content field creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content field creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content field creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "The site of this content field. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content field. (format is iso 8601 datetime) Not writable."
    },
    "description": {
      "type": "string",
      "description": "The description of this content field."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content field. Not writable."
    },
    "label": {
      "type": "string",
      "description": "The labeel of this content field."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content field modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content field modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content field modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content field. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content field. (format is iso 8601 datetime) Not writable."
    },
    "options": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "The descrption of this field."
        },
        "display": {
          "type": "string",
          "description": "The display option that for the listing screen of this field ."
        },
        "initial_value": {
          "type": "string",
          "description": "Initial value of this field. This means the initial display value rather than the default value at save."
        },
        "label": {
          "type": "string",
          "description": "The label of this field."
        },
        "max_length": {
          "type": "number",
          "description": "The maximum length of this field value."
        },
        "min_length": {
          "type": "number",
          "description": "The minimum length of this field value."
        },
        "required": {
          "type": "number",
          "description": "`0`: This field is not required. / `1`: This field is required."
        },
        "input_format": {
          "type": "string",
          "description": "The name of input format of this field."
        },
        "decimal_places": {
          "type": "number",
          "description": "The length of decimal places."
        },
        "max_value": {
          "type": "number",
          "description": "The maximum value of this field."
        },
        "min_value": {
          "type": "number",
          "description": "The minimum value of this field."
        },
        "max": {
          "type": "number",
          "description": "The maximum number that can be selected for this field."
        },
        "min": {
          "type": "number",
          "description": "The minimum number that should be selected for this field."
        },
        "multiple": {
          "type": "number",
          "description": "`0`: This field cannot accept multiple selection. / `1`: This field accept multiple selection."
        },
        "values": {
          "type": "array",
          "description": "List of label-value pairs."
        },
        "allow_upload": {
          "type": "number"
        },
        "can_add": {
          "type": "number",
          "description": "`0`: Users can create a new categories in this field. / `1`: Users cannot create a new categories in this field."
        },
        "increase_decrease_cols": {
          "type": "number",
          "description": "`0`: Users can increase/decrease columns. / `1`: Users cannot increase/decrease columns."
        },
        "increase_decrease_rows": {
          "type": "number",
          "description": "`0`: Users can increase/decrease rows. / `1`: Users cannot increase/decrease rows."
        },
        "initial_cols": {
          "type": "number",
          "description": "The number of initial columns."
        },
        "initial_rows": {
          "type": "number",
          "description": "The number of initial rows."
        },
        "source": {
          "type": "number",
          "description": "The ID of content type that linked with this field."
        },
        "category_set": {
          "type": "number",
          "description": "The ID of category set that linked with this field."
        }
      },
      "description": "The field option object. The members of this object are different depending on the type of field."
    },
    "type": {
      "type": "string",
      "description": "The field type. This property can be set only when creating. Available values are follows. `single_line_text`: Single line text field. / `multi_line_text`: Multiple line text field. / `number` Number field. / `url`: URL field. / `date_and_time`: Date and time field. / `date_only`: Date only fiel. / `time_only`: Time only field. / `select_box`: Select box field. / `radio_button`: Radio button field. / `checkboxes`: Checkbox field. / `asset`: Asset (file) type field. / `asset_audio`: Audio asset field. / `asset_video`: Video asset field. / `asset_image`: Image asset field. / `embedded_text`: Embedded text field. / `tags`: Tag field. / `list`: List field. / `tables`: Table field. / `content_type` Content type field. / `categories`: Category set field."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content field. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content field. / `false`: Current user cannot update this content field.  Not writable."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a content field.

Headers
Content-Type: application/json
Response  404
HideShow

Site, content field or content field not found.

Headers
Content-Type: application/json

Update Content Field
PUT/sites/{site_id}/contentTypes/{content_type_id}/fields/{content_field_id}

Authentication required

Update content field. This endpoint requires following permission.

  • Manage Content Types

If you want to update label, descrption and required, should be use options field. (e.g, {“options”:{“label”:“foo”}})

This method accepts PUT or POST with parameter ‘__method=PUT’.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/fields/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID

content_type_id
number (required) Example: 1

The content type ID

content_field_id
number (required) Example: 1

The content field ID

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_field={"description": "New description"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1
  },
  "contentFields": [
    {
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!",
      "uniqueID": "Hello, world!"
    }
  ],
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "dataLabel": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true,
  "userDisplayOption": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The site ID. Not writable."
        }
      },
      "description": "The site of this content type. Not writable."
    },
    "contentFields": {
      "type": "array",
      "description": "The list of content fields."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Created user of this content type. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "dataLabel": {
      "type": "string",
      "description": "The Unique ID of the content field that is data label. If not set will be NULL."
    },
    "description": {
      "type": "string",
      "description": "The description of this content type."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content type. Not writable."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content type modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content type modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content type modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content type. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content type. (format is iso 8601 datetime) Not writable."
    },
    "name": {
      "type": "string",
      "description": "The name of this content type."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content type. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content type. / `false`: Current user cannot update this content type.  Not writable."
    },
    "userDisplayOption": {
      "type": "boolean",
      "description": "`true`: Signed-in user can change display options for edit content data screen of this content type in the CMS admin screen. / `false`: Signed-in user cannot change display options for edit content data screen of this content type in the CMS admin screen."
    }
  }
}
Response  403
HideShow

Do not have permission to update a content field.

Headers
Content-Type: application/json
Response  404
HideShow

Site, content type or content field not found

Headers
Content-Type: application/json

Delete Content Field
DELETE/sites/{site_id}/contentTypes/{content_type_id}/fields/{content_field_id}

Authentication required

Delete content field from specified content type. This endpoint requires following permission.

  • Manage Content Types

This method accepts DELETE or POST with parameter ‘__method=DELETE’.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/fields/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID

content_type_id
number (required) Example: 1

The content type ID

content_field_id
number (required) Example: 1

The content field ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "blog": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "options": {
    "description": "Hello, world!",
    "display": "Hello, world!",
    "initial_value": "Hello, world!",
    "label": "Hello, world!",
    "max_length": 1,
    "min_length": 1,
    "required": 1,
    "input_format": "Hello, world!",
    "decimal_places": 1,
    "max_value": 1,
    "min_value": 1,
    "max": 1,
    "min": 1,
    "multiple": 1,
    "values": [
      {
        "checked": "checked",
        "label": "Hello, world!",
        "value": "Hello, world!"
      }
    ],
    "allow_upload": 1,
    "can_add": 1,
    "increase_decrease_cols": 1,
    "increase_decrease_rows": 1,
    "initial_cols": 1,
    "initial_rows": 1,
    "source": 1,
    "category_set": 1
  },
  "type": "Hello, world!",
  "uniqueID": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "blog": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content field creator. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content field creator. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content field creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "The site of this content field. Not writable."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content field. (format is iso 8601 datetime) Not writable."
    },
    "description": {
      "type": "string",
      "description": "The description of this content field."
    },
    "id": {
      "type": "number",
      "description": "The ID of this content field. Not writable."
    },
    "label": {
      "type": "string",
      "description": "The labeel of this content field."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content field modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content field modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content field modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content field. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content field. (format is iso 8601 datetime) Not writable."
    },
    "options": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string",
          "description": "The descrption of this field."
        },
        "display": {
          "type": "string",
          "description": "The display option that for the listing screen of this field ."
        },
        "initial_value": {
          "type": "string",
          "description": "Initial value of this field. This means the initial display value rather than the default value at save."
        },
        "label": {
          "type": "string",
          "description": "The label of this field."
        },
        "max_length": {
          "type": "number",
          "description": "The maximum length of this field value."
        },
        "min_length": {
          "type": "number",
          "description": "The minimum length of this field value."
        },
        "required": {
          "type": "number",
          "description": "`0`: This field is not required. / `1`: This field is required."
        },
        "input_format": {
          "type": "string",
          "description": "The name of input format of this field."
        },
        "decimal_places": {
          "type": "number",
          "description": "The length of decimal places."
        },
        "max_value": {
          "type": "number",
          "description": "The maximum value of this field."
        },
        "min_value": {
          "type": "number",
          "description": "The minimum value of this field."
        },
        "max": {
          "type": "number",
          "description": "The maximum number that can be selected for this field."
        },
        "min": {
          "type": "number",
          "description": "The minimum number that should be selected for this field."
        },
        "multiple": {
          "type": "number",
          "description": "`0`: This field cannot accept multiple selection. / `1`: This field accept multiple selection."
        },
        "values": {
          "type": "array",
          "description": "List of label-value pairs."
        },
        "allow_upload": {
          "type": "number"
        },
        "can_add": {
          "type": "number",
          "description": "`0`: Users can create a new categories in this field. / `1`: Users cannot create a new categories in this field."
        },
        "increase_decrease_cols": {
          "type": "number",
          "description": "`0`: Users can increase/decrease columns. / `1`: Users cannot increase/decrease columns."
        },
        "increase_decrease_rows": {
          "type": "number",
          "description": "`0`: Users can increase/decrease rows. / `1`: Users cannot increase/decrease rows."
        },
        "initial_cols": {
          "type": "number",
          "description": "The number of initial columns."
        },
        "initial_rows": {
          "type": "number",
          "description": "The number of initial rows."
        },
        "source": {
          "type": "number",
          "description": "The ID of content type that linked with this field."
        },
        "category_set": {
          "type": "number",
          "description": "The ID of category set that linked with this field."
        }
      },
      "description": "The field option object. The members of this object are different depending on the type of field."
    },
    "type": {
      "type": "string",
      "description": "The field type. This property can be set only when creating. Available values are follows. `single_line_text`: Single line text field. / `multi_line_text`: Multiple line text field. / `number` Number field. / `url`: URL field. / `date_and_time`: Date and time field. / `date_only`: Date only fiel. / `time_only`: Time only field. / `select_box`: Select box field. / `radio_button`: Radio button field. / `checkboxes`: Checkbox field. / `asset`: Asset (file) type field. / `asset_audio`: Audio asset field. / `asset_video`: Video asset field. / `asset_image`: Image asset field. / `embedded_text`: Embedded text field. / `tags`: Tag field. / `list`: List field. / `tables`: Table field. / `content_type` Content type field. / `categories`: Category set field."
    },
    "uniqueID": {
      "type": "string",
      "description": "The unique ID of this content field. Not writable."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this content field. / `false`: Current user cannot update this content field.  Not writable."
    }
  }
}
Response  403
HideShow

Do not have permission to delete a content field.

Headers
Content-Type: application/json
Response  404
HideShow

Site, content type or content field not found.

Headers
Content-Type: application/json

Save hierarchical content field order

Save hierarchical content field order
POST/sites/{site_id}/content_types{content_type_id}/fields/permutate

Authentication required.

Rearranges content field order in specified content type. This endpoint need folllowing permissions.

  • Manage Content Types

This method returns rearranged ContentField collection.

Post form data is following:

  • content_fields (array[ContentField]) - Array of content fields resource that were rearranged.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/content_types1/fields/permutate
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID

content_type_id
number (required) Example: 1

The content type ID

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_fields=[{"id":"1"}, {"id":"2"}, {"id":"4"}, {"id":"3"},]
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "blog": {
      "id": 1,
      "displayName": "Hello, world!",
      "userpicUrl": "Hello, world!"
    },
    "createdDate": "Hello, world!",
    "description": "Hello, world!",
    "id": 1,
    "label": "Hello, world!",
    "modifiedBy": {
      "displayName": "Hello, world!",
      "id": 1,
      "userpicUrl": "Hello, world!"
    },
    "modifiedDate": "Hello, world!",
    "options": {
      "description": "Hello, world!",
      "display": "Hello, world!",
      "initial_value": "Hello, world!",
      "label": "Hello, world!",
      "max_length": 1,
      "min_length": 1,
      "required": 1,
      "input_format": "Hello, world!",
      "decimal_places": 1,
      "max_value": 1,
      "min_value": 1,
      "max": 1,
      "min": 1,
      "multiple": 1,
      "values": [
        {
          "checked": "checked",
          "label": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "allow_upload": 1,
      "can_add": 1,
      "increase_decrease_cols": 1,
      "increase_decrease_rows": 1,
      "initial_cols": 1,
      "initial_rows": 1,
      "source": 1,
      "category_set": 1
    },
    "type": "Hello, world!",
    "uniqueID": "Hello, world!",
    "updatable": true
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "blog": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of this content field creator. Not writable."
          },
          "id": {
            "type": "number",
            "description": "The ID of this content field creator. Not writable."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of this content field creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
          }
        },
        "description": "The site of this content field. Not writable."
      },
      "createdDate": {
        "type": "string",
        "description": "Created date of this content field. (format is iso 8601 datetime) Not writable."
      },
      "description": {
        "type": "string",
        "description": "The description of this content field."
      },
      "id": {
        "type": "number",
        "description": "The ID of this content field. Not writable."
      },
      "label": {
        "type": "string",
        "description": "The labeel of this content field."
      },
      "modifiedBy": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of this content field modifier. Not writable."
          },
          "id": {
            "type": "number",
            "description": "The ID of this content field modifier. Not writable."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of this content field modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
          }
        },
        "description": "Last modified user of this content field. Not writable."
      },
      "modifiedDate": {
        "type": "string",
        "description": "Last modified date of this content field. (format is iso 8601 datetime) Not writable."
      },
      "options": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string",
            "description": "The descrption of this field."
          },
          "display": {
            "type": "string",
            "description": "The display option that for the listing screen of this field ."
          },
          "initial_value": {
            "type": "string",
            "description": "Initial value of this field. This means the initial display value rather than the default value at save."
          },
          "label": {
            "type": "string",
            "description": "The label of this field."
          },
          "max_length": {
            "type": "number",
            "description": "The maximum length of this field value."
          },
          "min_length": {
            "type": "number",
            "description": "The minimum length of this field value."
          },
          "required": {
            "type": "number",
            "description": "`0`: This field is not required. / `1`: This field is required."
          },
          "input_format": {
            "type": "string",
            "description": "The name of input format of this field."
          },
          "decimal_places": {
            "type": "number",
            "description": "The length of decimal places."
          },
          "max_value": {
            "type": "number",
            "description": "The maximum value of this field."
          },
          "min_value": {
            "type": "number",
            "description": "The minimum value of this field."
          },
          "max": {
            "type": "number",
            "description": "The maximum number that can be selected for this field."
          },
          "min": {
            "type": "number",
            "description": "The minimum number that should be selected for this field."
          },
          "multiple": {
            "type": "number",
            "description": "`0`: This field cannot accept multiple selection. / `1`: This field accept multiple selection."
          },
          "values": {
            "type": "array",
            "description": "List of label-value pairs."
          },
          "allow_upload": {
            "type": "number"
          },
          "can_add": {
            "type": "number",
            "description": "`0`: Users can create a new categories in this field. / `1`: Users cannot create a new categories in this field."
          },
          "increase_decrease_cols": {
            "type": "number",
            "description": "`0`: Users can increase/decrease columns. / `1`: Users cannot increase/decrease columns."
          },
          "increase_decrease_rows": {
            "type": "number",
            "description": "`0`: Users can increase/decrease rows. / `1`: Users cannot increase/decrease rows."
          },
          "initial_cols": {
            "type": "number",
            "description": "The number of initial columns."
          },
          "initial_rows": {
            "type": "number",
            "description": "The number of initial rows."
          },
          "source": {
            "type": "number",
            "description": "The ID of content type that linked with this field."
          },
          "category_set": {
            "type": "number",
            "description": "The ID of category set that linked with this field."
          }
        },
        "description": "The field option object. The members of this object are different depending on the type of field."
      },
      "type": {
        "type": "string",
        "description": "The field type. This property can be set only when creating. Available values are follows. `single_line_text`: Single line text field. / `multi_line_text`: Multiple line text field. / `number` Number field. / `url`: URL field. / `date_and_time`: Date and time field. / `date_only`: Date only fiel. / `time_only`: Time only field. / `select_box`: Select box field. / `radio_button`: Radio button field. / `checkboxes`: Checkbox field. / `asset`: Asset (file) type field. / `asset_audio`: Audio asset field. / `asset_video`: Video asset field. / `asset_image`: Image asset field. / `embedded_text`: Embedded text field. / `tags`: Tag field. / `list`: List field. / `tables`: Table field. / `content_type` Content type field. / `categories`: Category set field."
      },
      "uniqueID": {
        "type": "string",
        "description": "The unique ID of this content field. Not writable."
      },
      "updatable": {
        "type": "boolean",
        "description": "`true`: Current user can update this content field. / `false`: Current user cannot update this content field.  Not writable."
      }
    }
  }
}

Content Data

Content Data Collection

Content Data Collection
GET/sites/{site_id}/contentTypes/{content_type_id}/data{?limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds}

Retrieve list of content data of specified content type in the specified site.

Authentication required if you want to retrieve unpublished content data. Required pemission is follows.

  • Manage Content Data (site, sistem, each content type)

  • Publish Content Data (each content type)

  • Edit All Content Data (each content type)

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/data?limit=10&offset=0&sortBy=id&sortOrder=descend&fields=&includeIds=&excludeIds=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

limit
number (optional) Example: 10

Maximum number of content data to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: id

The field name for sort. You can specify one of following values.

  • id

  • uniqueID

  • authored_on

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return content data in descending order.

  • ascend: Return content data in ascending order.

fields
string (optional) 

The field list to retrieve as part of the content data resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of entries to include to result.

excludeIds
string (optional) 

The comma separated ID list of entries to exclude from result.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "author": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "createdDate": "Hello, world!",
      "data": [
        {
          "data": "Hello, world!",
          "id": 1,
          "label": "Hello, world!",
          "type": "Hello, world!"
        }
      ],
      "date": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "status": "Hello, world!",
      "unpublishedDate": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this content data creator. Not writable"
              },
              "id": {
                "type": "number",
                "description": "The ID of this content data creator. Not writable"
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this content data creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable"
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The identifier for this content data."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this cotent data. Not writable"
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this content data. (format is iso 8601 datetime) Not writable."
          },
          "data": {
            "type": "array",
            "description": "List of data of this content data."
          },
          "date": {
            "type": "string",
            "description": "The published time for this content data. (format is iso 8601 datetime)"
          },
          "id": {
            "type": "number",
            "description": "The ID of this content data.  Not writable."
          },
          "label": {
            "type": "string",
            "description": "The label value of this data."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this content data modifier. Not writable."
              },
              "id": {
                "type": "number",
                "description": "The ID of this content data modifier. Not writable."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this content data modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
              }
            },
            "description": "Last modified user of this content data. Not writable."
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this content data. (format is iso 8601 datetime) Not writable."
          },
          "status": {
            "type": "string",
            "description": "Draft: This content data is saved as draft. cd_status is 1. Publish: This content data is published. cd_status is 2. Review: This content data is waiting for approval. cd_status is 3. Future: This content data is scheduled for future publishing. cd_status is 4. Spam: This content data is marked as Spam. cd_status is 5."
          },
          "unpublishedDate": {
            "type": "string",
            "description": "The unpublished time for this content data. (format is iso 8601 datetime)"
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this contnt data. false: The user who accessed cannot update this content data."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve content data.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found.

Headers
Content-Type: application/json

Create Content Data
POST/sites/{site_id}/contentTypes/{content_type_id}/data

Authentication Required Create a new content data. This endpoint requires following permissions.

  • Manage Content Data (site, sistem, each content type)

  • Create Content Data (each content type)

Post form data is following

  • content_data (ContentData) - Single ContentData resource

Known issues (these will be solved in future release)

  • If content type contains non required Content Type field, request will failed when post data does not contains its data.

  • If content type contains non required Date and Time field, request will failed when post data does not contains its data.

  • Date and Time field must be specified by YYYYMMDDHHmmSS format.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/data
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_data={"label":"From API", "data":[{"id":"58", "data":"20161221092305"}]},
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "createdDate": "Hello, world!",
  "data": [
    {
      "data": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "status": "Hello, world!",
  "unpublishedDate": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data creator. Not writable"
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data creator. Not writable"
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable"
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The identifier for this content data."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this cotent data. Not writable"
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "data": {
      "type": "array",
      "description": "List of data of this content data."
    },
    "date": {
      "type": "string",
      "description": "The published time for this content data. (format is iso 8601 datetime)"
    },
    "id": {
      "type": "number",
      "description": "The ID of this content data.  Not writable."
    },
    "label": {
      "type": "string",
      "description": "The label value of this data."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content data. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "status": {
      "type": "string",
      "description": "Draft: This content data is saved as draft. cd_status is 1. Publish: This content data is published. cd_status is 2. Review: This content data is waiting for approval. cd_status is 3. Future: This content data is scheduled for future publishing. cd_status is 4. Spam: This content data is marked as Spam. cd_status is 5."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this content data. (format is iso 8601 datetime)"
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this contnt data. false: The user who accessed cannot update this content data."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new content data.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found.

Headers
Content-Type: application/json

Content Data

Fetch single Content Data
GET/sites/{site_id}/contentTypes/{content_type_id}/data/{content_data_id}{fields}

Fetch single content data.

Authentication required if you want fetch unpublished content data. Required permission is follows.

  • Manage Content Data (site, sistem, each content type)

  • Edit All Content Data (each content type)

  • Publish Content Data (each content type)

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/data/1fields
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

content_data_id
number (required) Example: 1

The content data ID.

fields
string (optional) 

The field list to retrieve as part of the Content Data resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "createdDate": "Hello, world!",
  "data": [
    {
      "data": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "status": "Hello, world!",
  "unpublishedDate": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data creator. Not writable"
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data creator. Not writable"
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable"
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The identifier for this content data."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this cotent data. Not writable"
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "data": {
      "type": "array",
      "description": "List of data of this content data."
    },
    "date": {
      "type": "string",
      "description": "The published time for this content data. (format is iso 8601 datetime)"
    },
    "id": {
      "type": "number",
      "description": "The ID of this content data.  Not writable."
    },
    "label": {
      "type": "string",
      "description": "The label value of this data."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content data. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "status": {
      "type": "string",
      "description": "Draft: This content data is saved as draft. cd_status is 1. Publish: This content data is published. cd_status is 2. Review: This content data is waiting for approval. cd_status is 3. Future: This content data is scheduled for future publishing. cd_status is 4. Spam: This content data is marked as Spam. cd_status is 5."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this content data. (format is iso 8601 datetime)"
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this contnt data. false: The user who accessed cannot update this content data."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a content data.

Headers
Content-Type: application/json
Response  404
HideShow

Site, content type or content data not found.

Headers
Content-Type: application/json

Update Content Data
PUT/sites/{site_id}/contentTypes/{content_type_id}/data/{content_data_id}

Authentication Required Update a single content data. This endpoint requires folllowing permissions.

  • Manage Content Data (site, sistem, each content type)

  • Edit All Content Data (each content type)

  • Publish Content Data (each content type)

Post form data is following:

  • content_data (ContentData, required) -Single ContentData resource.

This method accepts PUT and POST with __method=PUT.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/data/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

content_data_id
number (required) Example: 1

The content data ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_data={"label" : "New Label"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "createdDate": "Hello, world!",
  "data": [
    {
      "data": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "status": "Hello, world!",
  "unpublishedDate": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data creator. Not writable"
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data creator. Not writable"
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable"
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The identifier for this content data."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this cotent data. Not writable"
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "data": {
      "type": "array",
      "description": "List of data of this content data."
    },
    "date": {
      "type": "string",
      "description": "The published time for this content data. (format is iso 8601 datetime)"
    },
    "id": {
      "type": "number",
      "description": "The ID of this content data.  Not writable."
    },
    "label": {
      "type": "string",
      "description": "The label value of this data."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content data. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "status": {
      "type": "string",
      "description": "Draft: This content data is saved as draft. cd_status is 1. Publish: This content data is published. cd_status is 2. Review: This content data is waiting for approval. cd_status is 3. Future: This content data is scheduled for future publishing. cd_status is 4. Spam: This content data is marked as Spam. cd_status is 5."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this content data. (format is iso 8601 datetime)"
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this contnt data. false: The user who accessed cannot update this content data."
    }
  }
}
Response  403
HideShow

Do not have permission to update a content data.

Headers
Content-Type: application/json
Response  404
HideShow

Site, content type or content data not found.

Headers
Content-Type: application/json

Delete single content data.
DELETE/sites/{site_id}/contentTypes/{content_type_id}/data/{content_data_id}

Authentication required.

Delete a single content data. This endpoint requires folllowing permissions.

  • Manage Content Data (site, sistem, each content type)

  • Edit All Content Data (each content type)

  • Publish Content Data (each content type)

This method accepts PUT and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/contentTypes/1/data/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

content_data_id
number (required) Example: 1

The content data ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "author": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "createdDate": "Hello, world!",
  "data": [
    {
      "data": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "type": "Hello, world!"
    }
  ],
  "date": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "status": "Hello, world!",
  "unpublishedDate": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data creator. Not writable"
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data creator. Not writable"
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable"
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The identifier for this content data."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this cotent data. Not writable"
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "data": {
      "type": "array",
      "description": "List of data of this content data."
    },
    "date": {
      "type": "string",
      "description": "The published time for this content data. (format is iso 8601 datetime)"
    },
    "id": {
      "type": "number",
      "description": "The ID of this content data.  Not writable."
    },
    "label": {
      "type": "string",
      "description": "The label value of this data."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this content data modifier. Not writable."
        },
        "id": {
          "type": "number",
          "description": "The ID of this content data modifier. Not writable."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this content data modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string. Not writable."
        }
      },
      "description": "Last modified user of this content data. Not writable."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this content data. (format is iso 8601 datetime) Not writable."
    },
    "status": {
      "type": "string",
      "description": "Draft: This content data is saved as draft. cd_status is 1. Publish: This content data is published. cd_status is 2. Review: This content data is waiting for approval. cd_status is 3. Future: This content data is scheduled for future publishing. cd_status is 4. Spam: This content data is marked as Spam. cd_status is 5."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this content data. (format is iso 8601 datetime)"
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this contnt data. false: The user who accessed cannot update this content data."
    }
  }
}
Response  403
HideShow

Do not have permission to delete an content data.

Headers
Content-Type: application/json
Response  404
HideShow

Site, content type or content data not found.

Headers
Content-Type: application/json

Preview content data by data

Make a preview by data
POST/sites/{site_id}/content_types/{content_type_id}/data/preview{?raw}

Authentication required.

Make a preview by specified data. This endpoint requires following permissions.

  • Manage Content Data (site, sistem, each content type)

  • Create Content Data (each content type)

Post form data is following

  • content_data (ContentData) - Single ContentData resource

Known issues (these will be solved in future release)

  • If content type contains non required Content Type field, request will failed when post data does not contains its data.

  • If content type contains non required Date and Time field, request will failed when post data does not contains its data.

  • Date and Time field must be specified by YYYYMMDDHHmmSS format.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/content_types/1/data/preview?raw=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_data={"label":"From API", "data":[{"id":"58", "data":"20161221092305"}]},
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The result status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file or preview content if raw parameter is set as `1`."
    }
  }
}
Response  403
HideShow

Do not have permission to get content data preview.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found

Headers
Content-Type: application/json
Response  500
HideShow

Application error occurs.

Headers
Content-Type: application/json

Preview content data by id

Make a preview by id
POST/sites/{site_id}/content_types/{content_type_id}/data/{content_data_id}/preview{?raw}

Authentication required.

Make a preview by ID. This endpoint requires following permissions.

  • Manage Content Data (site, sistem, each content type)

  • Create Content Data (each content type)

Post form data is follows

  • entry (Entry, required) - Should be provide empty json. This parameter will be removed in the future.

Known issues (these will be solved in future release)

  • If content type contains non required Content Type field, request will failed when post data does not contains its data.

  • If content type contains non required Date and Time field, request will failed when post data does not contains its data.

  • Date and Time field must be specified by YYYYMMDDHHmmSS format.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/content_types/1/data/1/preview?raw=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

content_type_id
number (required) Example: 1

The content type ID.

content_data_id
number (required) Example: 1

The content data ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
content_data={},
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The result status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file or preview content if raw parameter is set as `1`."
    }
  }
}
Response  403
HideShow

Do not have permission to get content data preview.

Headers
Content-Type: application/json
Response  404
HideShow

Site or content type not found

Headers
Content-Type: application/json
Response  500
HideShow

Application error occurs.

Headers
Content-Type: application/json

Publish Content Data

Publish Content Data
GET/publish/contentData{blogId,blogIds,ids,startTime}

Authentication Requuired Publish content data. This endpoint requires following permissions.

  • Manage Content Data (site, sistem, each content type)

  • Edit All Content Data (each content type)

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/publish/contentDatablogId&blogIds&ids&startTime
URI Parameters
HideShow
blogId
number (required) 

Target site ID. Either blogID or blogIds must be specified.

blogIds
string (required) 

The comma separated site ID list. Either blogID or blogIds must be specified.

ids
string (optional) 

The comma separated content data ID list. You should specifiy this parameter to next call if this endpoint returns ‘Rebuilding’ status and you want to continue to publish.

startTime
string (optional) 

The string of build start time. You should specifiy this parameter to next call if this endpoint returns ‘Rebuilding’ status and you want to continue to publish.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "startTime": "Hello, world!",
  "restIds": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The result status of this call. `Rebuilding`: It means that there is still content that needs to be rebuilt. / `Complete`: Publishing process has been finished."
    },
    "startTime": {
      "type": "string",
      "description": "The string of build start time. You should specifiy this parameter to next call if this endpoint returns 'Rebuilding' status and you want to continue to publish."
    },
    "restIds": {
      "type": "string",
      "description": "The comma separated content data ID list. You should specifiy this parameter to next call if this endpoint returns 'Rebuilding' status and you want to continue to publish."
    }
  }
}
Response  403
HideShow

Do not have permission to publish content data.

Headers
Content-Type: application/json
Response  500
HideShow

Application error occurs.

Headers
Content-Type: application/json

Entries

Entry Collection

Create a new entry
POST/sites/{site_id}/entries

Authentication required.

Create a new entry. This endpoint need following permission.

  • create_post

Post form data is following

  • entry (Entry) - Single Entries resource

  • publish (number) - If specify 0 this entry and related templates are not rebuild at save.

Update in v2.0

  • You can attach categories and assets in the one request.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/entries
URI Parameters
HideShow
site_id
number (required) Example: 1

The ID of the site.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
entry={"excerpt" : "We are excited to announce that Six Apar-","status" : "Publish","allowComments" : true,"body" : "¥u003cp¥u003e¥u003cspan¥u003eWe are excited to announce that Six Apart has acquired Topics, a dynamic online publishing product. This offering will provide Six Apart customers with an easy and cost-effective way to adapt existing content to evolving digital platforms.¥u003c/span¥u003e¥u003c/p¥u003e¥n¥u003cp¥u003e¥u003cspan¥u003eThis new product will save Six Apart customers a significant amount of time and money by allowing users to upgrade their websites and applications without migrating from their current content management systems. Clients who need to scale large amounts of data or even revamp a website on an entirely new platform can now achieve these changes with minimal effort.¥u003c/span¥u003e¥u003c/p¥u003e¥n¥u003cp¥u003e¥u003cspan¥u003eSix Apart customers will benefit not only from saved time and money, but also from ease of use. Topics does not have a user interface, so there is no new software to learn. Instead, it exists as a middle layer between the data library and the published page - automatically gathering, organizing and redistributing data.¥u003c/span¥u003e¥u003c/p¥u003e","keywords" : "","allowTrackbacks" : false,"basename" : "six_apart_acquires_topics_server_to_simplify_site_upgrades","title" : "Six Apart Acquires Topics Server to Simplify Site Upgrades","more" : "","customFields" : [{"basename" : "place","value" : "New York City"},{"basename" : "agenda","value" : "Movable Type¥nTopics"}]}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "categories": [
    {
      "archiveLink": "",
      "basename": "",
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "id": 0,
      "label": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "updatable": false
    }
  ],
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    },
    "basename",
    "value"
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": "",
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "unpublishedDate": ""
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
    },
    "assets": {
      "type": "array",
      "description": "A list of asses that related with the enry."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this entry creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this entry creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this entry."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this entry."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "categories": {
      "type": "array",
      "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
    },
    "class": {
      "type": "string",
      "description": "The object class for this entry."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this entry."
    },
    "comments": {
      "type": "array",
      "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this entry. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The published time for this entry. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this entry."
    },
    "id": {
      "type": "number",
      "description": "The ID of this entry."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this entry."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this entry. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this entry."
    },
    "pingsSentUrl": {
      "type": "string",
      "description": "A list of TrackBack pings sent from this entry."
    },
    "status": {
      "type": "string",
      "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
    },
    "tags": {
      "type": "array",
      "description": "A list of entry tags for this entry."
    },
    "title": {
      "type": "string",
      "description": "The title of this entry."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this entry."
    },
    "trackbacks": {
      "type": "array",
      "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new entry.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found

Headers
Content-Type: application/json

Entries Collection
GET/sites/{site_id}/entries{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve list of entries in the specified site.

Authentication required if you want to retrieve unpublished entries. Required pemission is follows.

  • edit_entry

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/entries?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=authored_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) Example: 1

The ID of the site.

search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of entries to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: authored_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return entries in descending order.

  • ascend: Return entries in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of entries to include to result.

excludeIds
string (optional) 

The comma separated ID list of entries to exclude from result.

status
string (optional) 

Filter by container entry’s status.

  • Draft: entry_status is 1.

  • Publish: entry_status is 2.

  • Review: entry_status is 3.

  • Future: entry_status is 4.

  • Spam: entry_status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of comments to retrieve as part of the Entries resource. If this parameter is not supplied, no comments will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Entries resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "categories": [
        {
          "archiveLink": "",
          "basename": "",
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "id": 0,
          "label": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "updatable": false
        }
      ],
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        },
        "basename",
        "value"
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": "",
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "unpublishedDate": ""
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
          },
          "assets": {
            "type": "array",
            "description": "A list of asses that related with the enry."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this entry creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this entry creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this entry."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this entry."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "categories": {
            "type": "array",
            "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
          },
          "class": {
            "type": "string",
            "description": "The object class for this entry."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this entry."
          },
          "comments": {
            "type": "array",
            "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this entry. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The published time for this entry. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this entry."
          },
          "id": {
            "type": "number",
            "description": "The ID of this entry."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this entry."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this entry. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this entry."
          },
          "pingsSentUrl": {
            "type": "string",
            "description": "A list of TrackBack pings sent from this entry."
          },
          "status": {
            "type": "string",
            "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
          },
          "tags": {
            "type": "array",
            "description": "A list of entry tags for this entry."
          },
          "title": {
            "type": "string",
            "description": "The title of this entry."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this entry."
          },
          "trackbacks": {
            "type": "array",
            "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
          },
          "unpublishedDate": {
            "type": "string",
            "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve entries.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Entry Collection by category

Entry Collection by category
GET/sites/{site_id}/categories/{category_id}/entries{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve a list of entries that related with specified category.

Authentication required. if want to retrieve unpublished entries. Required pemission is follows.

  • edit_entry

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/categories/1/entries?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=authored_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

category_id
number (required) Example: 1

The category ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of entries to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: authored_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return entries in descending order.

  • ascend: Return entries in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of entries to include to result.

excludeIds
string (optional) 

The comma separated ID list of entries to exclude from result.

status
string (optional) 

Filter by container entry’s status.

  • Draft: entry_status is 1.

  • Publish: entry_status is 2.

  • Review: entry_status is 3.

  • Future: entry_status is 4.

  • Spam: entry_status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of comments to retrieve as part of the Entries resource. If this parameter is not supplied, no comments will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Entries resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "categories": [
        {
          "archiveLink": "",
          "basename": "",
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "id": 0,
          "label": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "updatable": false
        }
      ],
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        },
        "basename",
        "value"
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": "",
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "unpublishedDate": ""
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
          },
          "assets": {
            "type": "array",
            "description": "A list of asses that related with the enry."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this entry creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this entry creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this entry."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this entry."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "categories": {
            "type": "array",
            "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
          },
          "class": {
            "type": "string",
            "description": "The object class for this entry."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this entry."
          },
          "comments": {
            "type": "array",
            "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this entry. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The published time for this entry. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this entry."
          },
          "id": {
            "type": "number",
            "description": "The ID of this entry."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this entry."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this entry. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this entry."
          },
          "pingsSentUrl": {
            "type": "string",
            "description": "A list of TrackBack pings sent from this entry."
          },
          "status": {
            "type": "string",
            "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
          },
          "tags": {
            "type": "array",
            "description": "A list of entry tags for this entry."
          },
          "title": {
            "type": "string",
            "description": "The title of this entry."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this entry."
          },
          "trackbacks": {
            "type": "array",
            "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
          },
          "unpublishedDate": {
            "type": "string",
            "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve entries.

Headers
Content-Type: application/json
Response  404
HideShow

Site or category not found.

Headers
Content-Type: application/json

Entries Collection by asset

Entry Collection by asset
GET/sites/{site_id}/assets/{asset_id}/entries{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve a list of entries that related with specified asset.

Authentication required. if want to retrieve unpublished entries. Required pemission is follows.

  • edit_entry

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/assets/1/entries?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=authored_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

asset_id
number (required) Example: 1

The asset ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of entries to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: authored_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return entries in descending order.

  • ascend: Return entries in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of entries to include to result.

excludeIds
string (optional) 

The comma separated ID list of entries to exclude from result.

status
string (optional) 

Filter by container entry’s status.

  • Draft: entry_status is 1.

  • Publish: entry_status is 2.

  • Review: entry_status is 3.

  • Future: entry_status is 4.

  • Spam: entry_status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of comments to retrieve as part of the Entries resource. If this parameter is not supplied, no comments will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Entries resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "categories": [
        {
          "archiveLink": "",
          "basename": "",
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "id": 0,
          "label": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "updatable": false
        }
      ],
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        },
        "basename",
        "value"
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": "",
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "unpublishedDate": ""
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
          },
          "assets": {
            "type": "array",
            "description": "A list of asses that related with the enry."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this entry creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this entry creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this entry."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this entry."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "categories": {
            "type": "array",
            "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
          },
          "class": {
            "type": "string",
            "description": "The object class for this entry."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this entry."
          },
          "comments": {
            "type": "array",
            "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this entry. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The published time for this entry. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this entry."
          },
          "id": {
            "type": "number",
            "description": "The ID of this entry."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this entry."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this entry. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this entry."
          },
          "pingsSentUrl": {
            "type": "string",
            "description": "A list of TrackBack pings sent from this entry."
          },
          "status": {
            "type": "string",
            "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
          },
          "tags": {
            "type": "array",
            "description": "A list of entry tags for this entry."
          },
          "title": {
            "type": "string",
            "description": "The title of this entry."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this entry."
          },
          "trackbacks": {
            "type": "array",
            "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
          },
          "unpublishedDate": {
            "type": "string",
            "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve entries.

Headers
Content-Type: application/json
Response  404
HideShow

Site or asset not found.

Headers
Content-Type: application/json

Entries Collection by tag

Entry Collection by tag
GET/sites/{site_id}/tags/{tag_id}/entries{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve a list of entries that related with specified tag.

Authentication required. if want to retrieve unpublished entries. Required pemission is follows.

  • edit_entry

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/tags/1/entries?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=authored_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

tag_id
number (required) Example: 1

The tag ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of entries to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: authored_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return entries in descending order.

  • ascend: Return entries in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of entries to include to result.

excludeIds
string (optional) 

The comma separated ID list of entries to exclude from result.

status
string (optional) 

Filter by container entry’s status.

  • Draft: entry_status is 1.

  • Publish: entry_status is 2.

  • Review: entry_status is 3.

  • Future: entry_status is 4.

  • Spam: entry_status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of comments to retrieve as part of the Entries resource. If this parameter is not supplied, no comments will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Entries resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "categories": [
        {
          "archiveLink": "",
          "basename": "",
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "id": 0,
          "label": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "updatable": false
        }
      ],
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        },
        "basename",
        "value"
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": "",
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "unpublishedDate": ""
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
          },
          "assets": {
            "type": "array",
            "description": "A list of asses that related with the enry."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this entry creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this entry creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this entry."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this entry."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "categories": {
            "type": "array",
            "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
          },
          "class": {
            "type": "string",
            "description": "The object class for this entry."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this entry."
          },
          "comments": {
            "type": "array",
            "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this entry. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The published time for this entry. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this entry."
          },
          "id": {
            "type": "number",
            "description": "The ID of this entry."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this entry."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this entry. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this entry."
          },
          "pingsSentUrl": {
            "type": "string",
            "description": "A list of TrackBack pings sent from this entry."
          },
          "status": {
            "type": "string",
            "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
          },
          "tags": {
            "type": "array",
            "description": "A list of entry tags for this entry."
          },
          "title": {
            "type": "string",
            "description": "The title of this entry."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this entry."
          },
          "trackbacks": {
            "type": "array",
            "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
          },
          "unpublishedDate": {
            "type": "string",
            "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve entries.

Headers
Content-Type: application/json
Response  404
HideShow

Site or tag not found.

Headers
Content-Type: application/json

Entry

Fetch single entry
GET/sites/{site_id}/entries/{entry_id}{?fields}

Fetch single entry.

Authentication required if you want fetch unpublished entry. Required permission is follows.

  • edit_entry

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/entry_id?fields=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

entry_id
number (required) 

The entry ID.

fields
string (optional) 

The field list to retrieve as part of the Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "categories": [
    {
      "archiveLink": "",
      "basename": "",
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "id": 0,
      "label": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "updatable": false
    }
  ],
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    },
    "basename",
    "value"
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": "",
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "unpublishedDate": ""
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
    },
    "assets": {
      "type": "array",
      "description": "A list of asses that related with the enry."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this entry creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this entry creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this entry."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this entry."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "categories": {
      "type": "array",
      "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
    },
    "class": {
      "type": "string",
      "description": "The object class for this entry."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this entry."
    },
    "comments": {
      "type": "array",
      "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this entry. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The published time for this entry. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this entry."
    },
    "id": {
      "type": "number",
      "description": "The ID of this entry."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this entry."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this entry. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this entry."
    },
    "pingsSentUrl": {
      "type": "string",
      "description": "A list of TrackBack pings sent from this entry."
    },
    "status": {
      "type": "string",
      "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
    },
    "tags": {
      "type": "array",
      "description": "A list of entry tags for this entry."
    },
    "title": {
      "type": "string",
      "description": "The title of this entry."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this entry."
    },
    "trackbacks": {
      "type": "array",
      "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
    }
  }
}
Response  403
HideShow

Do not have permission to fetch an entry.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Update single entry.
PUT/sites/{site_id}/entries/{entry_id}

Authentication required.

Update a single entry. This endpoint need folllowing permissions.

  • edit_entry

This method accepts PUT and POST with __method=PUT.

Post form data is following:

  • entry (Entry, required) -Single Entries resource.

  • publish (number) - If specify 0 this entry and related templates are not rebuild at save.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/entry_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

entry_id
number (required) 

The entry ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
entry={"excerpt" : "We are very excited to announce that Six Apar-"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "categories": [
    {
      "archiveLink": "",
      "basename": "",
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "id": 0,
      "label": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "updatable": false
    }
  ],
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    },
    "basename",
    "value"
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": "",
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "unpublishedDate": ""
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
    },
    "assets": {
      "type": "array",
      "description": "A list of asses that related with the enry."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this entry creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this entry creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this entry."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this entry."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "categories": {
      "type": "array",
      "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
    },
    "class": {
      "type": "string",
      "description": "The object class for this entry."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this entry."
    },
    "comments": {
      "type": "array",
      "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this entry. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The published time for this entry. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this entry."
    },
    "id": {
      "type": "number",
      "description": "The ID of this entry."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this entry."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this entry. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this entry."
    },
    "pingsSentUrl": {
      "type": "string",
      "description": "A list of TrackBack pings sent from this entry."
    },
    "status": {
      "type": "string",
      "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
    },
    "tags": {
      "type": "array",
      "description": "A list of entry tags for this entry."
    },
    "title": {
      "type": "string",
      "description": "The title of this entry."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this entry."
    },
    "trackbacks": {
      "type": "array",
      "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
    }
  }
}
Response  403
HideShow

Do not have permission to update an entry.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Delete single entry.
DELETE/sites/{site_id}/entries/{entry_id}

Authentication required.

Delete a single entry. This endpoint need folllowing permissions.

  • edit_entry

This method accepts PUT and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/entry_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

entry_id
number (required) 

The entry ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "categories": [
    {
      "archiveLink": "",
      "basename": "",
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "id": 0,
      "label": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "updatable": false
    }
  ],
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    },
    "basename",
    "value"
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": "",
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "unpublishedDate": ""
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
    },
    "assets": {
      "type": "array",
      "description": "A list of asses that related with the enry."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this entry creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this entry creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this entry."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this entry."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "categories": {
      "type": "array",
      "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
    },
    "class": {
      "type": "string",
      "description": "The object class for this entry."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this entry."
    },
    "comments": {
      "type": "array",
      "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this entry. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array"
    },
    "date": {
      "type": "string",
      "description": "The published time for this entry. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this entry."
    },
    "id": {
      "type": "number",
      "description": "The ID of this entry."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this entry."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this entry. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this entry."
    },
    "pingsSentUrl": {
      "type": "string",
      "description": "A list of TrackBack pings sent from this entry."
    },
    "status": {
      "type": "string",
      "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
    },
    "tags": {
      "type": "array",
      "description": "A list of entry tags for this entry."
    },
    "title": {
      "type": "string",
      "description": "The title of this entry."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this entry."
    },
    "trackbacks": {
      "type": "array",
      "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
    },
    "unpublishedDate": {
      "type": "string",
      "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
    }
  }
}
Response  403
HideShow

Do not have permission to delete an entry.

Headers
Content-Type: application/json
Response  404
HideShow

Site or entry not found.

Headers
Content-Type: application/json

Preview entry by data

Make a preview by data
POST/sites/{site_id}/entries/preview{?raw}

Authentication required.

Make a preview by specified data. This endpoint needs following permissions.

  • create_post

This endpoint is available in Movable Type 6.1.2 or later.

Post form data is follows

  • entry (Entry, required) - Entry data to make a preview.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/preview?raw=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
entry={ "title" : "My First Post", "body" : "This is my first post!" }
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The result status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file."
    }
  }
}
Response  403
HideShow

Do not have permission to get entry preview.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found

Headers
Content-Type: application/json
Response  500
HideShow

Application error occurs.

Headers
Content-Type: application/json

Preview entry by id

Make a preview by id
POST/sites/{site_id}/entries/{entry_id}/preview{?raw}

Authentication required.

Make a preview by ID. This endpoint needs following permissions.

+ create_post

This endpoint is available in Movable Type 6.1.2 or later.

Post form data is follows

  • entry (Entry, required) - Should be provide empty json. This parameter will be removed in the future.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/entries/entry_id/preview?raw=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

entry_id
number (required) 

The entry ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
entry={}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The result status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file."
    }
  }
}
Response  403
HideShow

Do not have permission to get entry preview.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found

Headers
Content-Type: application/json
Response  500
HideShow

Application error occurs.

Headers
Content-Type: application/json

Folders

Folder Collection

Create a new folder
POST/sites/{site_id}/folders

Authentication required.

Create a new folder. This endpoint needs following permissions.

  • Manage Pages

Post form data is following:

  • folder (Folder) - Folder resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders
URI Parameters
HideShow
site_id
number (required) 

The site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
folder={"basename" : "news","parent" : "0","label" : "News","description" : null}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "path": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "basename": {
      "type": "string",
      "description": "The basename for this folder."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this folder."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The class for this folder. Always \"folder\"."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this folder. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this folder."
    },
    "description": {
      "type": "string",
      "description": "The description for this folder."
    },
    "id": {
      "type": "number",
      "description": "The ID for this folder."
    },
    "label": {
      "type": "string",
      "description": "The label for this folder."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this folder. (format is iso 8601 datetime)"
    },
    "path": {
      "type": "string",
      "description": "The path for this folder."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new folder.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Folder Collection
GET/sites/:site_id/folders{?limit,offset,sortBy,sortOrder,fields,searchFields,search,includeIds,excludeIds,top,dateField,dateFrom,dateTo}

Retrieve a list of folders.

Authentication required if you want to get private properties. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/:site_id/folders?limit=10&offset=0&sortBy=user_custom&sortOrder=descend&fields=&searchFields=label,basename&search=&includeIds=&excludeIds=&top=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
limit
number (optional) Example: 10

Maximum number of folders to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: user_custom

  • user_custom: Sort order you specified on the Manage Folders screen.

  • created_by: Sort by the ID of creator.

  • id: Sort by its own ID.

  • basename: Sort by the basename of each folders.

  • label: Sort by the label of each folders.

sortOrder
string (optional) Example: descend

  • descend (default): Return folders in descending order.

  • ascend: Return folders in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Folders resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

searchFields
string (optional) Example: label,basename

The comma separated field name list to search.

search
string (optional) 

Search query.

includeIds
string (optional) 

The comma separated ID list of folders to include to result.

excludeIds
string (optional) 

The comma separated ID list of folders to exclude from result.

top
number (optional) Example: 0

If set to 1, retrieves only top level folders.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "path": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "basename": {
      "type": "string",
      "description": "The basename for this folder."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this folder."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The class for this folder. Always \"folder\"."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this folder. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this folder."
    },
    "description": {
      "type": "string",
      "description": "The description for this folder."
    },
    "id": {
      "type": "number",
      "description": "The ID for this folder."
    },
    "label": {
      "type": "string",
      "description": "The label for this folder."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this folder. (format is iso 8601 datetime)"
    },
    "path": {
      "type": "string",
      "description": "The path for this folder."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve folders.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Folder Collection for parent folders

Folder Collection for parent folders
GET/sites/{site_id}/folders/{folder_id}/parents{?maxDepth,includeCurrent,dateField,dateFrom,dateTo}

Retrieve a list of parent folders.

Authentication required if you want to get private properties. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/folder_id/parents?maxDepth=&includeCurrent=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

folder_id
number (required) 

The folder ID.

maxDepth
numner (optional) 

The depth of retrieving parent folders.

includeCurrent
number (optional) Example: 0

  • 1: The results includes current folder.

  • 0: The results do not include current folder.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "path": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "basename": {
            "type": "string",
            "description": "The basename for this folder."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this folder."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The class for this folder. Always \"folder\"."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this folder creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this folder creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this folder. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data for this folder."
          },
          "description": {
            "type": "string",
            "description": "The description for this folder."
          },
          "id": {
            "type": "number",
            "description": "The ID for this folder."
          },
          "label": {
            "type": "string",
            "description": "The label for this folder."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this folder modifier."
              },
              "id": {
                "type": "number",
                "description": "The ID of this folder modifier."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this folder. (format is iso 8601 datetime)"
          },
          "path": {
            "type": "string",
            "description": "The path for this folder."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve folders.

Headers
Content-Type: application/json
Response  404
HideShow

Site or folder not found.

Headers
Content-Type: application/json

Folders Collection for siblings folders

Folders Collection for siblings folders
GET/sites/{site_id}/folders/{folder_id}/siblings{?limit,offset,sortBy,sortOrder,fields,searchFields,search,includeIds,excludeIds,top,dateField,dateFrom,dateTo}

Retrieve a list of siblings folders.

Authentication required if you want to get private properties. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/folder_id/siblings?limit=10&offset=0&sortBy=user_custom&sortOrder=descend&fields=&searchFields=label,basename&search=&includeIds=&excludeIds=&top=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID

folder_id
number (required) 

The folder ID.

limit
number (optional) Example: 10

Maximum number of folders to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: user_custom

  • user_custom: Sort order you specified on the Manage Folders screen.

  • created_by: Sort by the ID of creator.

  • id: Sort by its own ID.

  • basename: Sort by the basename of each folders.

  • label: Sort by the label of each folders.

sortOrder
string (optional) Example: descend

  • descend (default): Return folders in descending order.

  • ascend: Return folders in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Folders resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

searchFields
string (optional) Example: label,basename

The comma separated field name list to search.

search
string (optional) 

Search query.

includeIds
string (optional) 

The comma separated ID list of folders to include to result.

excludeIds
string (optional) 

The comma separated ID list of folders to exclude from result.

top
number (optional) Example: 0

If set to 1, retrieves only top level folders.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "path": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "basename": {
            "type": "string",
            "description": "The basename for this folder."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this folder."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The class for this folder. Always \"folder\"."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this folder creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this folder creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this folder. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data for this folder."
          },
          "description": {
            "type": "string",
            "description": "The description for this folder."
          },
          "id": {
            "type": "number",
            "description": "The ID for this folder."
          },
          "label": {
            "type": "string",
            "description": "The label for this folder."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this folder modifier."
              },
              "id": {
                "type": "number",
                "description": "The ID of this folder modifier."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this folder. (format is iso 8601 datetime)"
          },
          "path": {
            "type": "string",
            "description": "The path for this folder."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve folders.

Headers
Content-Type: application/json
Response  404
HideShow

Site or folder not found.

Headers
Content-Type: application/json

Folders Collection for child filders

Folders Collection for child filders
GET/sites/{site_id}/folders/{folder_id}/children{?maxDepth,includeCurrent,dateField,dateFrom,dateTo}

Retrieve a list of child folders.

Authentication required if you want to get private properties. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/folder_id/children?maxDepth=&includeCurrent=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

folder_id
number (required) 

The folder ID.

maxDepth
numner (optional) 

The depth of retrieving child folders.

includeCurrent
number (optional) Example: 0

  • 1: The results includes current folder.

  • 0: The results do not include current folder.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "basename": "Hello, world!",
      "blog": {
        "id": 1
      },
      "class": "Hello, world!",
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "description": "Hello, world!",
      "id": 1,
      "label": "Hello, world!",
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "path": "Hello, world!",
      "updatable": true
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "basename": {
            "type": "string",
            "description": "The basename for this folder."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this folder."
              }
            }
          },
          "class": {
            "type": "string",
            "description": "The class for this folder. Always \"folder\"."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this folder creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this folder creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this folder. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data for this folder."
          },
          "description": {
            "type": "string",
            "description": "The description for this folder."
          },
          "id": {
            "type": "number",
            "description": "The ID for this folder."
          },
          "label": {
            "type": "string",
            "description": "The label for this folder."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this folder modifier."
              },
              "id": {
                "type": "number",
                "description": "The ID of this folder modifier."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this folder. (format is iso 8601 datetime)"
          },
          "path": {
            "type": "string",
            "description": "The path for this folder."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve folders.

Headers
Content-Type: application/json
Response  404
HideShow

Site or folder not found.

Headers
Content-Type: application/json

folder

Fetch single folder
GET/sites/{site_id}/folders/{folder_id}{?fields}

Retrieve a single folder by its ID.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/folder_id?fields=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

folder_id
number (required) 

The folder ID.

fields
string (optional) 

The field list to retrieve as part of the folders resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "path": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "basename": {
      "type": "string",
      "description": "The basename for this folder."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this folder."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The class for this folder. Always \"folder\"."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this folder. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this folder."
    },
    "description": {
      "type": "string",
      "description": "The description for this folder."
    },
    "id": {
      "type": "number",
      "description": "The ID for this folder."
    },
    "label": {
      "type": "string",
      "description": "The label for this folder."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this folder. (format is iso 8601 datetime)"
    },
    "path": {
      "type": "string",
      "description": "The path for this folder."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a folder.

Headers
Content-Type: application/json
Response  404
HideShow

Site or folder not found.

Headers
Content-Type: application/json

Update single folder
PUT/sites/{site_id}/folders/{folder_id}

Authentication required.

Update an existing folder. This endpoint need folllowing permissions.

  • Manage Pages

This method accepts PUT and POST with __method=PUT.

Post form data is following:

  • folder (Folder) - folder resource

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/folder_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

folder_id
number (required) 

The folder ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
folder={"basename" : "news","parent" : "0","archiveLink" : "http://example.com/news/index.html","updatable" : false,"label" : "News","class" : "folder","id" : "1","blog" : {"id" : "1"},"description" : null,"customFields" : [{"basename" : "bannerImage","value" : "http://example.com/images/banner.jpg"}]}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "path": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "basename": {
      "type": "string",
      "description": "The basename for this folder."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this folder."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The class for this folder. Always \"folder\"."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this folder. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this folder."
    },
    "description": {
      "type": "string",
      "description": "The description for this folder."
    },
    "id": {
      "type": "number",
      "description": "The ID for this folder."
    },
    "label": {
      "type": "string",
      "description": "The label for this folder."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this folder. (format is iso 8601 datetime)"
    },
    "path": {
      "type": "string",
      "description": "The path for this folder."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
    }
  }
}
Response  403
HideShow

Do not have permission to update a folder.

Headers
Content-Type: application/json
Response  404
HideShow

Site or folder not found.

Headers
Content-Type: application/json

Delete single folder
DELETE/sites/{site_id}/folders/{folder_id}

Authentication required.

Update an existing folder. This endpoint need folllowing permissions.

  • Manage Pages

This method accepts DELETE and POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/folder_id
URI Parameters
HideShow
site_id
number (required) 

The site ID.

folder_id
number (required) 

The folder ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "basename": "Hello, world!",
  "blog": {
    "id": 1
  },
  "class": "Hello, world!",
  "createdBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "description": "Hello, world!",
  "id": 1,
  "label": "Hello, world!",
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "path": "Hello, world!",
  "updatable": true
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "basename": {
      "type": "string",
      "description": "The basename for this folder."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this folder."
        }
      }
    },
    "class": {
      "type": "string",
      "description": "The class for this folder. Always \"folder\"."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this folder. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this folder."
    },
    "description": {
      "type": "string",
      "description": "The description for this folder."
    },
    "id": {
      "type": "number",
      "description": "The ID for this folder."
    },
    "label": {
      "type": "string",
      "description": "The label for this folder."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this folder modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this folder modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this folder. (format is iso 8601 datetime)"
    },
    "path": {
      "type": "string",
      "description": "The path for this folder."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
    }
  }
}
Response  403
HideShow

Do not have permission to update a folder.

Headers
Content-Type: application/json
Response  404
HideShow

Site or folder not found.

Headers
Content-Type: application/json

Save hierarchical folders order

Save hierarchical folders order
POST/sites/{site_id}/folders/permutate

Authentication required.

Save hierarchical folders order. This endpoint need folllowing permissions.

  • Manage Pages

This method returns rearranged folders collection.

Post form data is following:

  • folders (array[Folder]) - Array of folders resource that were rearranged.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/permutate
URI Parameters
HideShow
site_id
number (required) 

The site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
folders=[{"basename" : "news","parent" : "0","archiveLink" : "http://example.com/news/index.html","updatable" : false,"label" : "News","class" : "folder","id" : "1","blog" : {"id" : "1"},"description" : null,"customFields" : [{"basename" : "bannerImage","value" : "http://example.com/images/banner.jpg"},{"basename" : "pressreleases","parent" : "0","archiveLink" : "http://example.com/pressreleases/index.html","updatable" : false,"label" : "Press releases","class" : "folder","id" : "2","blog" : {"id" : "1"},"description" : null,}]
Response  200
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "basename": "Hello, world!",
    "blog": {
      "id": 1
    },
    "class": "Hello, world!",
    "createdBy": {
      "displayName": "Hello, world!",
      "id": 1,
      "userpicUrl": "Hello, world!"
    },
    "createdDate": "Hello, world!",
    "customFields": [
      {
        "basename": "Hello, world!",
        "value": "Hello, world!"
      }
    ],
    "description": "Hello, world!",
    "id": 1,
    "label": "Hello, world!",
    "modifiedBy": {
      "displayName": "Hello, world!",
      "id": 1,
      "userpicUrl": "Hello, world!"
    },
    "modifiedDate": "Hello, world!",
    "path": "Hello, world!",
    "updatable": true
  }
]
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "basename": {
        "type": "string",
        "description": "The basename for this folder."
      },
      "blog": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "The ID of the site that contains this folder."
          }
        }
      },
      "class": {
        "type": "string",
        "description": "The class for this folder. Always \"folder\"."
      },
      "createdBy": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of this folder creator."
          },
          "id": {
            "type": "number",
            "description": "The ID of this folder creator."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
          }
        }
      },
      "createdDate": {
        "type": "string",
        "description": "Created date of this folder. (format is iso 8601 datetime)"
      },
      "customFields": {
        "type": "array",
        "description": "The list of customfields data for this folder."
      },
      "description": {
        "type": "string",
        "description": "The description for this folder."
      },
      "id": {
        "type": "number",
        "description": "The ID for this folder."
      },
      "label": {
        "type": "string",
        "description": "The label for this folder."
      },
      "modifiedBy": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string",
            "description": "The display name of this folder modifier."
          },
          "id": {
            "type": "number",
            "description": "The ID of this folder modifier."
          },
          "userpicUrl": {
            "type": "string",
            "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
          }
        }
      },
      "modifiedDate": {
        "type": "string",
        "description": "Last modified date of this folder. (format is iso 8601 datetime)"
      },
      "path": {
        "type": "string",
        "description": "The path for this folder."
      },
      "updatable": {
        "type": "boolean",
        "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
      }
    }
  }
}

Pages

Page Collection

Create a new page
POST/sites/{site_id}/pages/

Authentication required. Create a new page. This endpoint need following permissions.

  • Manage Pages

Post form data is follows

  • page (Page, required) - Single Pages resource.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/The site ID./pages/
URI Parameters
HideShow
site_id
string (required) Example: The site ID.
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "folder": {
    "basename": "",
    "blog": {
      "id": 0
    },
    "class": "",
    "createdBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "createdDate": "",
    "customFields": [
      {
        "basename": "",
        "value": ""
      }
    ],
    "description": "",
    "id": 0,
    "label": "",
    "modifiedBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "modifiedDate": "",
    "path": "",
    "updatable": false
  },
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    }
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": [],
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "updatable": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
    },
    "assets": {
      "type": "array",
      "description": "The list of related assets for this page."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this page creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this page creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this page."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this page."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "folder": {
      "type": "object",
      "properties": {
        "basename": {
          "type": "string",
          "description": "The basename for this folder."
        },
        "blog": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "The ID of the site that contains this folder."
            }
          }
        },
        "class": {
          "type": "string",
          "description": "The class for this folder. Always \"folder\"."
        },
        "createdBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder creator."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder creator."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "createdDate": {
          "type": "string",
          "description": "Created date of this folder. (format is iso 8601 datetime)"
        },
        "customFields": {
          "type": "array",
          "description": "The list of customfields data for this folder."
        },
        "description": {
          "type": "string",
          "description": "The description for this folder."
        },
        "id": {
          "type": "number",
          "description": "The ID for this folder."
        },
        "label": {
          "type": "string",
          "description": "The label for this folder."
        },
        "modifiedBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder modifier."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder modifier."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "modifiedDate": {
          "type": "string",
          "description": "Last modified date of this folder. (format is iso 8601 datetime)"
        },
        "path": {
          "type": "string",
          "description": "The path for this folder."
        },
        "updatable": {
          "type": "boolean",
          "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
        }
      },
      "description": "The container folder of this page."
    },
    "class": {
      "type": "string",
      "description": "The object class for this page."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this page."
    },
    "comments": {
      "type": "array",
      "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this page. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this page."
    },
    "date": {
      "type": "string",
      "description": "The published time for this page. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this page."
    },
    "id": {
      "type": "number",
      "description": "The ID of this page."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this page."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this page. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this page."
    },
    "pingsSentUrl": {
      "type": "array",
      "description": "The list of TrackBack pings sent from this page."
    },
    "status": {
      "type": "string",
      "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
    },
    "tags": {
      "type": "array",
      "description": "The list of page tags for this page."
    },
    "title": {
      "type": "string",
      "description": "The title of this page."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this page."
    },
    "trackbacks": {
      "type": "array",
      "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new page.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found

Headers
Content-Type: application/json

Page Collection
GET/sites/{site_id}/pages/{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve a list of pages. Authentication required if you want to retrieve unpublished pages. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/The site ID./pages/?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=modified_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
string (required) Example: The site ID.
search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of pages to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: modified_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return pages in descending order.

  • ascend: Return pages in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Pages resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of pages to include to result.

excludeIds
string (optional) 

The comma separated ID list of pages to exclude from result.

status
string (optional) 

Filter by container page’s status.

  • Draft: status is 1.

  • Publish: status is 2.

  • Review: status is 3.

  • Future: status is 4.

  • Spam: status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of pages to retrieve as part of the Pages resource. If this parameter is not supplied, no pages will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Pages resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "folder": {
        "basename": "",
        "blog": {
          "id": 0
        },
        "class": "",
        "createdBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "createdDate": "",
        "customFields": [
          {
            "basename": "",
            "value": ""
          }
        ],
        "description": "",
        "id": 0,
        "label": "",
        "modifiedBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "modifiedDate": "",
        "path": "",
        "updatable": false
      },
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": [],
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "updatable": false
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
          },
          "assets": {
            "type": "array",
            "description": "The list of related assets for this page."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this page creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this page creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this page."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this page."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "folder": {
            "type": "object",
            "properties": {
              "basename": {
                "type": "string",
                "description": "The basename for this folder."
              },
              "blog": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "The ID of the site that contains this folder."
                  }
                }
              },
              "class": {
                "type": "string",
                "description": "The class for this folder. Always \"folder\"."
              },
              "createdBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder creator."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder creator."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "createdDate": {
                "type": "string",
                "description": "Created date of this folder. (format is iso 8601 datetime)"
              },
              "customFields": {
                "type": "array",
                "description": "The list of customfields data for this folder."
              },
              "description": {
                "type": "string",
                "description": "The description for this folder."
              },
              "id": {
                "type": "number",
                "description": "The ID for this folder."
              },
              "label": {
                "type": "string",
                "description": "The label for this folder."
              },
              "modifiedBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder modifier."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder modifier."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "modifiedDate": {
                "type": "string",
                "description": "Last modified date of this folder. (format is iso 8601 datetime)"
              },
              "path": {
                "type": "string",
                "description": "The path for this folder."
              },
              "updatable": {
                "type": "boolean",
                "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
              }
            },
            "description": "The container folder of this page."
          },
          "class": {
            "type": "string",
            "description": "The object class for this page."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this page."
          },
          "comments": {
            "type": "array",
            "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this page. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data for this page."
          },
          "date": {
            "type": "string",
            "description": "The published time for this page. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this page."
          },
          "id": {
            "type": "number",
            "description": "The ID of this page."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this page."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this page. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this page."
          },
          "pingsSentUrl": {
            "type": "array",
            "description": "The list of TrackBack pings sent from this page."
          },
          "status": {
            "type": "string",
            "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
          },
          "tags": {
            "type": "array",
            "description": "The list of page tags for this page."
          },
          "title": {
            "type": "string",
            "description": "The title of this page."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this page."
          },
          "trackbacks": {
            "type": "array",
            "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve pages.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Pages Collection by folder

Pages Collection by folder
GET/sites/{site_id}/folders/{folder_id}/pages{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve a list of pages by folder.

Authentication required if want to include unpublished pages. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/folders/folder_id/pages?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=modified_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

folder_id
number (required) 

The folder ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of pages to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: modified_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return pages in descending order.

  • ascend: Return pages in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Pages resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of pages to include to result.

excludeIds
string (optional) 

The comma separated ID list of pages to exclude from result.

status
string (optional) 

Filter by container page’s status.

  • Draft: status is 1.

  • Publish: status is 2.

  • Review: status is 3.

  • Future: status is 4.

  • Spam: status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of pages to retrieve as part of the Pages resource. If this parameter is not supplied, no pages will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Pages resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "folder": {
        "basename": "",
        "blog": {
          "id": 0
        },
        "class": "",
        "createdBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "createdDate": "",
        "customFields": [
          {
            "basename": "",
            "value": ""
          }
        ],
        "description": "",
        "id": 0,
        "label": "",
        "modifiedBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "modifiedDate": "",
        "path": "",
        "updatable": false
      },
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": [],
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "updatable": false
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
          },
          "assets": {
            "type": "array",
            "description": "The list of related assets for this page."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this page creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this page creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this page."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this page."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "folder": {
            "type": "object",
            "properties": {
              "basename": {
                "type": "string",
                "description": "The basename for this folder."
              },
              "blog": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "The ID of the site that contains this folder."
                  }
                }
              },
              "class": {
                "type": "string",
                "description": "The class for this folder. Always \"folder\"."
              },
              "createdBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder creator."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder creator."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "createdDate": {
                "type": "string",
                "description": "Created date of this folder. (format is iso 8601 datetime)"
              },
              "customFields": {
                "type": "array",
                "description": "The list of customfields data for this folder."
              },
              "description": {
                "type": "string",
                "description": "The description for this folder."
              },
              "id": {
                "type": "number",
                "description": "The ID for this folder."
              },
              "label": {
                "type": "string",
                "description": "The label for this folder."
              },
              "modifiedBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder modifier."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder modifier."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "modifiedDate": {
                "type": "string",
                "description": "Last modified date of this folder. (format is iso 8601 datetime)"
              },
              "path": {
                "type": "string",
                "description": "The path for this folder."
              },
              "updatable": {
                "type": "boolean",
                "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
              }
            },
            "description": "The container folder of this page."
          },
          "class": {
            "type": "string",
            "description": "The object class for this page."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this page."
          },
          "comments": {
            "type": "array",
            "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this page. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data for this page."
          },
          "date": {
            "type": "string",
            "description": "The published time for this page. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this page."
          },
          "id": {
            "type": "number",
            "description": "The ID of this page."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this page."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this page. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this page."
          },
          "pingsSentUrl": {
            "type": "array",
            "description": "The list of TrackBack pings sent from this page."
          },
          "status": {
            "type": "string",
            "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
          },
          "tags": {
            "type": "array",
            "description": "The list of page tags for this page."
          },
          "title": {
            "type": "string",
            "description": "The title of this page."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this page."
          },
          "trackbacks": {
            "type": "array",
            "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve pages.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Pages Collection by asset

Pages Collection by asset
GET/sites/{site_id}/assets/{asset_id}/pages{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve a list of pages that related with asset.

Authentication required if want to include unpublished pages. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/assets/asset_id/pages?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=modified_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

asset_id
number (required) 

The asset ID.

search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of pages to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: modified_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return pages in descending order.

  • ascend: Return pages in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Pages resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of pages to include to result.

excludeIds
string (optional) 

The comma separated ID list of pages to exclude from result.

status
string (optional) 

Filter by container page’s status.

  • Draft: status is 1.

  • Publish: status is 2.

  • Review: status is 3.

  • Future: status is 4.

  • Spam: status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of pages to retrieve as part of the Pages resource. If this parameter is not supplied, no pages will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Pages resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "folder": {
        "basename": "",
        "blog": {
          "id": 0
        },
        "class": "",
        "createdBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "createdDate": "",
        "customFields": [
          {
            "basename": "",
            "value": ""
          }
        ],
        "description": "",
        "id": 0,
        "label": "",
        "modifiedBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "modifiedDate": "",
        "path": "",
        "updatable": false
      },
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": [],
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "updatable": false
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
          },
          "assets": {
            "type": "array",
            "description": "The list of related assets for this page."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this page creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this page creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this page."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this page."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "folder": {
            "type": "object",
            "properties": {
              "basename": {
                "type": "string",
                "description": "The basename for this folder."
              },
              "blog": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "The ID of the site that contains this folder."
                  }
                }
              },
              "class": {
                "type": "string",
                "description": "The class for this folder. Always \"folder\"."
              },
              "createdBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder creator."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder creator."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "createdDate": {
                "type": "string",
                "description": "Created date of this folder. (format is iso 8601 datetime)"
              },
              "customFields": {
                "type": "array",
                "description": "The list of customfields data for this folder."
              },
              "description": {
                "type": "string",
                "description": "The description for this folder."
              },
              "id": {
                "type": "number",
                "description": "The ID for this folder."
              },
              "label": {
                "type": "string",
                "description": "The label for this folder."
              },
              "modifiedBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder modifier."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder modifier."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "modifiedDate": {
                "type": "string",
                "description": "Last modified date of this folder. (format is iso 8601 datetime)"
              },
              "path": {
                "type": "string",
                "description": "The path for this folder."
              },
              "updatable": {
                "type": "boolean",
                "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
              }
            },
            "description": "The container folder of this page."
          },
          "class": {
            "type": "string",
            "description": "The object class for this page."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this page."
          },
          "comments": {
            "type": "array",
            "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this page. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data for this page."
          },
          "date": {
            "type": "string",
            "description": "The published time for this page. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this page."
          },
          "id": {
            "type": "number",
            "description": "The ID of this page."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this page."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this page. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this page."
          },
          "pingsSentUrl": {
            "type": "array",
            "description": "The list of TrackBack pings sent from this page."
          },
          "status": {
            "type": "string",
            "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
          },
          "tags": {
            "type": "array",
            "description": "The list of page tags for this page."
          },
          "title": {
            "type": "string",
            "description": "The title of this page."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this page."
          },
          "trackbacks": {
            "type": "array",
            "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve pages.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Pages Collection by tag

  • Paramegers
    • site_id (number, required) - The site ID.
    • tag_id (number, required) - The tag ID.

Pages Collection by tag
GET/sites/tags/pages{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,maxComments,maxTrackbacks,no_text_filter,dateField,dateFrom,dateTo}

Retrieve a list of pages that related with tag.

Authentication required if want to include unpublished pages. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/tags/pages?search=&searchFields=title,body,more,keywords,excerpt,basename&limit=10&offset=0&sortBy=modified_on&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&maxComments=&maxTrackbacks=&no_text_filter=0&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
search
string (optional) 

Search query.

searchFields
string (optional) Example: title,body,more,keywords,excerpt,basename

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of pages to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: modified_on

The field name for sort. You can specify one of following values.

  • authored_on

  • title

  • created_on

  • modified_on

sortOrder
string (optional) Example: descend

  • descend (default): Return pages in descending order.

  • ascend: Return pages in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Pages resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of pages to include to result.

excludeIds
string (optional) 

The comma separated ID list of pages to exclude from result.

status
string (optional) 

Filter by container page’s status.

  • Draft: status is 1.

  • Publish: status is 2.

  • Review: status is 3.

  • Future: status is 4.

  • Spam: status is 5.

maxComments
number (optional) 

This is an optional parameter. Maximum number of pages to retrieve as part of the Pages resource. If this parameter is not supplied, no pages will be returned.

maxTrackbacks
number (optional) 

This is an optional parameter. Maximum number of received trackbacks to retrieve as part of the Pages resource. If this parameter is not supplied, no trackbacks will be returned.

no_text_filter
number (optional) Example: 0

If you want to fetch the raw text, set to ‘1’. New in v2

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "folder": {
        "basename": "",
        "blog": {
          "id": 0
        },
        "class": "",
        "createdBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "createdDate": "",
        "customFields": [
          {
            "basename": "",
            "value": ""
          }
        ],
        "description": "",
        "id": 0,
        "label": "",
        "modifiedBy": {
          "displayName": "",
          "id": 0,
          "userpicUrl": ""
        },
        "modifiedDate": "",
        "path": "",
        "updatable": false
      },
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": [],
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "updatable": false
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
          },
          "assets": {
            "type": "array",
            "description": "The list of related assets for this page."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this page creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this page creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this page."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this page."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "folder": {
            "type": "object",
            "properties": {
              "basename": {
                "type": "string",
                "description": "The basename for this folder."
              },
              "blog": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "number",
                    "description": "The ID of the site that contains this folder."
                  }
                }
              },
              "class": {
                "type": "string",
                "description": "The class for this folder. Always \"folder\"."
              },
              "createdBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder creator."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder creator."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "createdDate": {
                "type": "string",
                "description": "Created date of this folder. (format is iso 8601 datetime)"
              },
              "customFields": {
                "type": "array",
                "description": "The list of customfields data for this folder."
              },
              "description": {
                "type": "string",
                "description": "The description for this folder."
              },
              "id": {
                "type": "number",
                "description": "The ID for this folder."
              },
              "label": {
                "type": "string",
                "description": "The label for this folder."
              },
              "modifiedBy": {
                "type": "object",
                "properties": {
                  "displayName": {
                    "type": "string",
                    "description": "The display name of this folder modifier."
                  },
                  "id": {
                    "type": "number",
                    "description": "The ID of this folder modifier."
                  },
                  "userpicUrl": {
                    "type": "string",
                    "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
                  }
                }
              },
              "modifiedDate": {
                "type": "string",
                "description": "Last modified date of this folder. (format is iso 8601 datetime)"
              },
              "path": {
                "type": "string",
                "description": "The path for this folder."
              },
              "updatable": {
                "type": "boolean",
                "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
              }
            },
            "description": "The container folder of this page."
          },
          "class": {
            "type": "string",
            "description": "The object class for this page."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this page."
          },
          "comments": {
            "type": "array",
            "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this page. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data for this page."
          },
          "date": {
            "type": "string",
            "description": "The published time for this page. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this page."
          },
          "id": {
            "type": "number",
            "description": "The ID of this page."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this page."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this page. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this page."
          },
          "pingsSentUrl": {
            "type": "array",
            "description": "The list of TrackBack pings sent from this page."
          },
          "status": {
            "type": "string",
            "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
          },
          "tags": {
            "type": "array",
            "description": "The list of page tags for this page."
          },
          "title": {
            "type": "string",
            "description": "The title of this page."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this page."
          },
          "trackbacks": {
            "type": "array",
            "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
          },
          "updatable": {
            "type": "boolean",
            "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve pages.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Page

Fetch single page
GET/sites/{site_id}/pages/{page_id}{?fields}

Fetch single page.

Authentication required if the page status is “unpublished”. Requires permission is follows.

  • Manage Pages

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/pages/1?fields=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

page_id
number (required) Example: 1

The page ID.

fields
string (optional) 

The field list to retrieve as part of the Pages resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "folder": {
    "basename": "",
    "blog": {
      "id": 0
    },
    "class": "",
    "createdBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "createdDate": "",
    "customFields": [
      {
        "basename": "",
        "value": ""
      }
    ],
    "description": "",
    "id": 0,
    "label": "",
    "modifiedBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "modifiedDate": "",
    "path": "",
    "updatable": false
  },
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    }
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": [],
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "updatable": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
    },
    "assets": {
      "type": "array",
      "description": "The list of related assets for this page."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this page creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this page creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this page."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this page."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "folder": {
      "type": "object",
      "properties": {
        "basename": {
          "type": "string",
          "description": "The basename for this folder."
        },
        "blog": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "The ID of the site that contains this folder."
            }
          }
        },
        "class": {
          "type": "string",
          "description": "The class for this folder. Always \"folder\"."
        },
        "createdBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder creator."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder creator."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "createdDate": {
          "type": "string",
          "description": "Created date of this folder. (format is iso 8601 datetime)"
        },
        "customFields": {
          "type": "array",
          "description": "The list of customfields data for this folder."
        },
        "description": {
          "type": "string",
          "description": "The description for this folder."
        },
        "id": {
          "type": "number",
          "description": "The ID for this folder."
        },
        "label": {
          "type": "string",
          "description": "The label for this folder."
        },
        "modifiedBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder modifier."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder modifier."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "modifiedDate": {
          "type": "string",
          "description": "Last modified date of this folder. (format is iso 8601 datetime)"
        },
        "path": {
          "type": "string",
          "description": "The path for this folder."
        },
        "updatable": {
          "type": "boolean",
          "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
        }
      },
      "description": "The container folder of this page."
    },
    "class": {
      "type": "string",
      "description": "The object class for this page."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this page."
    },
    "comments": {
      "type": "array",
      "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this page. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this page."
    },
    "date": {
      "type": "string",
      "description": "The published time for this page. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this page."
    },
    "id": {
      "type": "number",
      "description": "The ID of this page."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this page."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this page. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this page."
    },
    "pingsSentUrl": {
      "type": "array",
      "description": "The list of TrackBack pings sent from this page."
    },
    "status": {
      "type": "string",
      "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
    },
    "tags": {
      "type": "array",
      "description": "The list of page tags for this page."
    },
    "title": {
      "type": "string",
      "description": "The title of this page."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this page."
    },
    "trackbacks": {
      "type": "array",
      "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
    }
  }
}

Update single page
PUT/sites/{site_id}/pages/{page_id}

Authentication required.

Update single page. This endpoint is authentication required. Required permission is follows.

  • Manage Pages

Update in v2.0

  • You can attach/detach folder and assets by one request.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/pages/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

page_id
number (required) Example: 1

The page ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
page={"excerpt" : "We are excited to announce that Six Apar-"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "folder": {
    "basename": "",
    "blog": {
      "id": 0
    },
    "class": "",
    "createdBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "createdDate": "",
    "customFields": [
      {
        "basename": "",
        "value": ""
      }
    ],
    "description": "",
    "id": 0,
    "label": "",
    "modifiedBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "modifiedDate": "",
    "path": "",
    "updatable": false
  },
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    }
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": [],
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "updatable": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
    },
    "assets": {
      "type": "array",
      "description": "The list of related assets for this page."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this page creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this page creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this page."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this page."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "folder": {
      "type": "object",
      "properties": {
        "basename": {
          "type": "string",
          "description": "The basename for this folder."
        },
        "blog": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "The ID of the site that contains this folder."
            }
          }
        },
        "class": {
          "type": "string",
          "description": "The class for this folder. Always \"folder\"."
        },
        "createdBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder creator."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder creator."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "createdDate": {
          "type": "string",
          "description": "Created date of this folder. (format is iso 8601 datetime)"
        },
        "customFields": {
          "type": "array",
          "description": "The list of customfields data for this folder."
        },
        "description": {
          "type": "string",
          "description": "The description for this folder."
        },
        "id": {
          "type": "number",
          "description": "The ID for this folder."
        },
        "label": {
          "type": "string",
          "description": "The label for this folder."
        },
        "modifiedBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder modifier."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder modifier."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "modifiedDate": {
          "type": "string",
          "description": "Last modified date of this folder. (format is iso 8601 datetime)"
        },
        "path": {
          "type": "string",
          "description": "The path for this folder."
        },
        "updatable": {
          "type": "boolean",
          "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
        }
      },
      "description": "The container folder of this page."
    },
    "class": {
      "type": "string",
      "description": "The object class for this page."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this page."
    },
    "comments": {
      "type": "array",
      "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this page. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this page."
    },
    "date": {
      "type": "string",
      "description": "The published time for this page. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this page."
    },
    "id": {
      "type": "number",
      "description": "The ID of this page."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this page."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this page. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this page."
    },
    "pingsSentUrl": {
      "type": "array",
      "description": "The list of TrackBack pings sent from this page."
    },
    "status": {
      "type": "string",
      "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
    },
    "tags": {
      "type": "array",
      "description": "The list of page tags for this page."
    },
    "title": {
      "type": "string",
      "description": "The title of this page."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this page."
    },
    "trackbacks": {
      "type": "array",
      "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
    }
  }
}

Delete single page
DELETE/sites/{site_id}/pages/{page_id}

Authentication required.

Delete single page. This endpoint is authentication required. Required permission is follows.

  • Manage Pages

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/pages/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID.

page_id
number (required) Example: 1

The page ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowComments": false,
  "allowTrackbacks": false,
  "assets": [
    {
      "blog": {
        "id": 0
      },
      "class": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "description": "",
      "fileExt": "",
      "filename": "",
      "id": 0,
      "label": "",
      "meta": {
        "fileSize": 0,
        "height": 0,
        "width": 0
      },
      "mimeType": "",
      "modifiedBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": {
        "id": 0
      },
      "tags": [],
      "updatable": false,
      "url": ""
    }
  ],
  "author": {
    "displayName": "",
    "id": 0,
    "userpicUrl": ""
  },
  "basename": "",
  "blog": {
    "id": 0
  },
  "body": "",
  "folder": {
    "basename": "",
    "blog": {
      "id": 0
    },
    "class": "",
    "createdBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "createdDate": "",
    "customFields": [
      {
        "basename": "",
        "value": ""
      }
    ],
    "description": "",
    "id": 0,
    "label": "",
    "modifiedBy": {
      "displayName": "",
      "id": 0,
      "userpicUrl": ""
    },
    "modifiedDate": "",
    "path": "",
    "updatable": false
  },
  "class": "",
  "commentCount": 0,
  "comments": [
    {
      "author": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "createdBy": {
        "id": 0,
        "displayName": "",
        "userpicUrl": ""
      },
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        }
      ],
      "date": "",
      "entry": {
        "id": 0
      },
      "id": 0,
      "link": "",
      "modifiedBy": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "modifiedDate": "",
      "parent": 0,
      "status": "",
      "updatable": false
    }
  ],
  "createdDate": "",
  "customFields": [
    {
      "basename": "",
      "value": ""
    }
  ],
  "date": "",
  "excerpt": "",
  "format": "",
  "id": 0,
  "keywords": "",
  "modifiedDate": "",
  "more": "",
  "permalink": "",
  "pingsSentUrl": [],
  "status": "",
  "tags": [],
  "title": "",
  "trackbackCount": 0,
  "trackbacks": [],
  "updatable": false
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowComments": {
      "type": "boolean",
      "description": "false: This page does not accepts comments. In the database, this value is 0. true: This page accepts comments. In the database, this value is 1."
    },
    "allowTrackbacks": {
      "type": "boolean",
      "description": "false: This page does not accepts trackbacks. In the database, this value is 0. true: This page accepts trackbacks. In the database, this value is 1."
    },
    "assets": {
      "type": "array",
      "description": "The list of related assets for this page."
    },
    "author": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this page creator."
        },
        "id": {
          "type": "number",
          "description": "The ID of this page creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this page creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "basename": {
      "type": "string",
      "description": "The basename for this page."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this page."
        }
      }
    },
    "body": {
      "type": "string",
      "description": "The contents of this page that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "folder": {
      "type": "object",
      "properties": {
        "basename": {
          "type": "string",
          "description": "The basename for this folder."
        },
        "blog": {
          "type": "object",
          "properties": {
            "id": {
              "type": "number",
              "description": "The ID of the site that contains this folder."
            }
          }
        },
        "class": {
          "type": "string",
          "description": "The class for this folder. Always \"folder\"."
        },
        "createdBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder creator."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder creator."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "createdDate": {
          "type": "string",
          "description": "Created date of this folder. (format is iso 8601 datetime)"
        },
        "customFields": {
          "type": "array",
          "description": "The list of customfields data for this folder."
        },
        "description": {
          "type": "string",
          "description": "The description for this folder."
        },
        "id": {
          "type": "number",
          "description": "The ID for this folder."
        },
        "label": {
          "type": "string",
          "description": "The label for this folder."
        },
        "modifiedBy": {
          "type": "object",
          "properties": {
            "displayName": {
              "type": "string",
              "description": "The display name of this folder modifier."
            },
            "id": {
              "type": "number",
              "description": "The ID of this folder modifier."
            },
            "userpicUrl": {
              "type": "string",
              "description": "The URL of this folder modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
            }
          }
        },
        "modifiedDate": {
          "type": "string",
          "description": "Last modified date of this folder. (format is iso 8601 datetime)"
        },
        "path": {
          "type": "string",
          "description": "The path for this folder."
        },
        "updatable": {
          "type": "boolean",
          "description": "true: The user who accessed can update this folder. false: The user who accessed cannot update this folder."
        }
      },
      "description": "The container folder of this page."
    },
    "class": {
      "type": "string",
      "description": "The object class for this page."
    },
    "commentCount": {
      "type": "number",
      "description": "The number of comments for this page."
    },
    "comments": {
      "type": "array",
      "description": "The list of comments for this page. The list is sorted by ID of the comment and The parent ID of the comment."
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this page. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data for this page."
    },
    "date": {
      "type": "string",
      "description": "The published time for this page. (format is iso 8601 datetime)"
    },
    "excerpt": {
      "type": "string",
      "description": "The excerpt value of this page if one is specified or, if not, an auto-generated excerpt from the page Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s page Settings."
    },
    "format": {
      "type": "string",
      "description": "The text format of this page."
    },
    "id": {
      "type": "number",
      "description": "The ID of this page."
    },
    "keywords": {
      "type": "string",
      "description": "The keywords text for this page."
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this page. (format is iso 8601 datetime)"
    },
    "more": {
      "type": "string",
      "description": "The extended contents for this page. if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
    },
    "permalink": {
      "type": "string",
      "description": "The parmalink URL for this page."
    },
    "pingsSentUrl": {
      "type": "array",
      "description": "The list of TrackBack pings sent from this page."
    },
    "status": {
      "type": "string",
      "description": "Draft: This page is saved as draft. status is 1. / Publish: This page is published. status is 2. / Review: This page is waiting for approval. status is 3. / Future: This page is scheduled for future publishing. status is 4. / Spam: This page is marked as Spam. status is 5."
    },
    "tags": {
      "type": "array",
      "description": "The list of page tags for this page."
    },
    "title": {
      "type": "string",
      "description": "The title of this page."
    },
    "trackbackCount": {
      "type": "number",
      "description": "The number of received trackbacks for this page."
    },
    "trackbacks": {
      "type": "array",
      "description": "The list of received trackbacks for this page. The list is sorted by the ID of trackback."
    },
    "updatable": {
      "type": "boolean",
      "description": "true: The user who accessed can update this entry. / false: The user who accessed cannot update this page."
    }
  }
}

Preview page by data

Make a preview by data
POST/sites/{site_id}/pages/preview{?raw}

Authentication required.

Make a preview by specified data. This endpoint requires authentication. Required permission is follows.

  • manage_pages

  • This endpoint is available in Movable Type 6.1.2 or later.

Post form data is follows

  • page (Page, required) - Page data to make a preview.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/pages/preview?raw=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request  Entries resource
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
page={ "title" : "My First Post", "body" : "This is my first post!" }
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The resukt status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file."
    }
  }
}
Response  403
HideShow

Do not have permission to get page preview.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found

Headers
Content-Type: application/json
Response  500
HideShow

Application error occurs.

Headers
Content-Type: application/json

Preview page by id

Make a preview for exising data
POST/sites/{site_id}/pages/{page_id}/preview{?raw}

Authentication required.

Make a preview by specified data. This endpoint needs following permissions.

  • manage_post

  • This endpoint is available in Movable Type 6.1.2 or later.

Post form data is follows

  • page (Page, required) - Should be provide empty json. This parameter will be removed in the future.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/pages/page_id/preview?raw=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

page_id
number (required) 

The page ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request  Templates resource
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
page={}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The resukt status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file."
    }
  }
}
Response  403
HideShow

Do not have permission to get page preview.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found

Headers
Content-Type: application/json
Response  500
HideShow

Application error occurs.

Headers
Content-Type: application/json

Permissions

Permission Collection

Permission Collection
GET/permissions{?limit,offset,sortBy,sortOrder,fields,blogIds,dateField,dateFrom,dateTo}

Authentication required Retrieve a list of permissions. Only system administrator can call this endpoint.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/permissions?limit=25&offset=0&sortBy=bog_id&sortOrder=ascend&fields=&blogIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
limit
number (optional) Example: 25

Maximum number of permissions to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: bog_id

The field name for sort. You can specify one of following values

  • id

  • blog_id

  • author_id

  • created_by

  • created_on

sortOrder
string (optional) Example: ascend

  • descend (default): Return permissions in descending order.

  • ascend: Return permissions in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Permissions resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

blogIds
number (optional) 

The comma-separated blog id list that to be included in the result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "id": 1,
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "permissions": [
        "Hello, world!"
      ],
      "roles": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ],
      "user": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site."
              }
            }
          },
          "id": {
            "type": "number",
            "description": "The ID for this permission."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this permission creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this permission creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this permission. (format is iso 8601 datetime)"
          },
          "permissions": {
            "type": "array",
            "description": "The list of granted permissions. The restricted permissions are excluded from this list."
          },
          "roles": {
            "type": "array",
            "description": "The list of roles."
          },
          "user": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The nickname for this permission user."
              },
              "id": {
                "type": "number",
                "description": "The ID for this permission user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a permission list.

Headers
Content-Type: application/json

Permission Collection by user

Permission Collection by user
GET/users/{user_id}/permissions{?limit,offset,sortBy,sortOrder,fields,blogIds,dateField,dateFrom,dateTo}

Authentication required Retrieve a list of permissions by user.

System administrator can retrieve all user’s permission list. Other users, can retrieve their own permission list.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id/permissions?limit=25&offset=0&sortBy=bog_id&sortOrder=ascend&fields=&blogIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
user_id
string (required) 

The user ID or ‘me’.

limit
number (optional) Example: 25

Maximum number of permissions to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: bog_id

The field name for sort. You can specify one of following values

  • id

  • blog_id

  • author_id

  • created_by

  • created_on

sortOrder
string (optional) Example: ascend

  • descend (default): Return permissions in descending order.

  • ascend: Return permissions in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Permissions resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

blogIds
number (optional) 

The comma-separated blog id list that to be included in the result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "id": 1,
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "permissions": [
        "Hello, world!"
      ],
      "roles": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ],
      "user": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site."
              }
            }
          },
          "id": {
            "type": "number",
            "description": "The ID for this permission."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this permission creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this permission creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this permission. (format is iso 8601 datetime)"
          },
          "permissions": {
            "type": "array",
            "description": "The list of granted permissions. The restricted permissions are excluded from this list."
          },
          "roles": {
            "type": "array",
            "description": "The list of roles."
          },
          "user": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The nickname for this permission user."
              },
              "id": {
                "type": "number",
                "description": "The ID for this permission user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a permission list.

Headers
Content-Type: application/json

Permission Collection by site

Permission Collection by site
GET/sites/{site_id}/permissions{?limit,offset,sortBy,sortOrder,fields,dateField,dateFrom,dateTo}

Authentication required Retrieve a list of permissions by site.

System administrator can retrieve permission list for every site. Site Administrator can retrieve their own site permission list.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/permissions?limit=25&offset=0&sortBy=bog_id&sortOrder=ascend&fields=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

limit
number (optional) Example: 25

Maximum number of permissions to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: bog_id

The field name for sort. You can specify one of following values

  • id

  • blog_id

  • author_id

  • created_by

  • created_on

sortOrder
string (optional) Example: ascend

  • descend (default): Return permissions in descending order.

  • ascend: Return permissions in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Permissions resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "id": 1,
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "permissions": [
        "Hello, world!"
      ],
      "roles": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ],
      "user": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site."
              }
            }
          },
          "id": {
            "type": "number",
            "description": "The ID for this permission."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this permission creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this permission creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this permission. (format is iso 8601 datetime)"
          },
          "permissions": {
            "type": "array",
            "description": "The list of granted permissions. The restricted permissions are excluded from this list."
          },
          "roles": {
            "type": "array",
            "description": "The list of roles."
          },
          "user": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The nickname for this permission user."
              },
              "id": {
                "type": "number",
                "description": "The ID for this permission user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a permission list.

Headers
Content-Type: application/json

Permission Collection by role

Permission Collection by role
GET/roles/{role_id}/permissions{?limit,offset,sortBy,sortOrder,fields,blogIds,dateField,dateFrom,dateTo}

Authentication required Retrieve a list of permissions by role. Only system administrator can call this endpoint.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/roles/role_id/permissions?limit=25&offset=0&sortBy=bog_id&sortOrder=ascend&fields=&blogIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
role_id
number (required) 

The role ID.

limit
number (optional) Example: 25

Maximum number of permissions to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: bog_id

The field name for sort. You can specify one of following values

  • id

  • blog_id

  • author_id

  • created_by

  • created_on

sortOrder
string (optional) Example: ascend

  • descend (default): Return permissions in descending order.

  • ascend: Return permissions in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Permissions resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

blogIds
number (optional) 

The comma-separated blog id list that to be included in the result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "blog": {
        "id": 1
      },
      "id": 1,
      "createdBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "permissions": [
        "Hello, world!"
      ],
      "roles": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ],
      "user": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      }
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site."
              }
            }
          },
          "id": {
            "type": "number",
            "description": "The ID for this permission."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this permission creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this permission creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this permission. (format is iso 8601 datetime)"
          },
          "permissions": {
            "type": "array",
            "description": "The list of granted permissions. The restricted permissions are excluded from this list."
          },
          "roles": {
            "type": "array",
            "description": "The list of roles."
          },
          "user": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The nickname for this permission user."
              },
              "id": {
                "type": "number",
                "description": "The ID for this permission user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this permission user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve a permission list.

Headers
Content-Type: application/json

Grant role by site

Grant role by site
POST/sites/{site_id}/permissions/grant

Authentication required

Grant a role to user by site. System administrators can grant roles to users for each site. Site Administrators can grant roles to users for their own site.

Post form data is follows

  • role_id (required, number) - The role ID.

  • user_id (required, number) - The user ID.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/permissions/grant
URI Parameters
HideShow
site_id
number (required) 

The site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
role_id=1&user_id=1
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "result of this request."
    }
  }
}

Grant role by user

Grant role by user
POST/users/{user_id}/permissions/grant

Authentication required

Grant a role to user. System administrators can grant roles to users for each site. Site Administrators can grant roles to users for their own site.

Post form data is follows.

  • site_id (required, number) - The site ID.

  • role_id (required, number) - The role ID.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id/permissions/grant
URI Parameters
HideShow
user_id
number (required) 

The user ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
role_id=1&site_id=1
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "result of this request."
    }
  }
}

Revoke permission by site

Revoke permission by site
POST/sites/{site_id}/permissions/revoke

Authentication required

Revoke a role from user by site. System administrators can revoke roles from users for each site. Site Administrators can revoke roles from users for their own site.

Post form data is follows.

  • user_id (required, number) - The user ID.

  • role_id (required, number) - The role ID.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/permissions/revoke
URI Parameters
HideShow
site_id
number (required) 

The site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
role_id=1&user_id=1
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "result of this request."
    }
  }
}

Revoke role by user

Revoke role by user
POST/users/{user_id}/permissions/revoke

Authentication required

Revoke a role from user by site. System administrators can revoke roles from users for each site. Site Administrators can revoke roles from users for their own site.

Post form data is follows.

  • site_id (required, number) - The site ID.

  • role_id (required, number) - The role ID.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id/permissions/revoke
URI Parameters
HideShow
user_id
number (required) 

The user ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
role_id=1&site_id=1
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "result of this request."
    }
  }
}

Sites

Site Collection

Site Collection
GET/sites{?limit,offset,sortBy,sortOrder,fields,searchFields,search,includeIds,excludeIds,dateField,dateFrom,dateTo}

Retrieve a list of sites.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites?limit=25&offset=0&sortBy=name&sortOrder=descend&fields=&searchFields=name&search=&includeIds=&excludeIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
search
string (optional) 

Search query.

searchFields
string (optional) Example: name

Only ‘name’ is available.

limit
number (optional) Example: 25

Maximum number of sites to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: name

Only ‘name’ is available

sortOrder
string (optional) Example: descend

  • descend (default): Return sites in descending order.

  • ascend: Return sites in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Sites resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of sites to include to result.

excludeIds
string (optional) 

The comma separated ID list of sites to exclude from result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowCommenterRegist": true,
      "allowCommentHtml": true,
      "allowComments": true,
      "allowCommentsDefault": true,
      "allowPings": true,
      "allowPingsDefault": true,
      "allowToChangeAtUpload": true,
      "allowUnregComments": true,
      "archivePath": "Hello, world!",
      "archiveTypePreferred": "Hello, world!",
      "archiveUrl": "Hello, world!",
      "autodiscoverLinks": true,
      "autolinkUrls": true,
      "autoRenameNonAscii": true,
      "basenameLimit": 1,
      "ccLicenseImage": "Hello, world!",
      "ccLicenseUrl": "Hello, world!",
      "class": "Hello, world!",
      "commenterAuthenticators": [
        "Hello, world!"
      ],
      "convertParasComments": "Hello, world!",
      "contentCss": "Hello, world!",
      "convertParas": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customDynamicTemplates": "Hello, world!",
      "daysOrPosts": "Hello, world!",
      "dateLanguage": "Hello, world!",
      "description": "Hello, world!",
      "dynamicCache": true,
      "dynamicConditional": true,
      "entryCustomPrefs": [
        "Hello, world!"
      ],
      "emailNewComments": 1,
      "emailNewPings": 1,
      "extraPath": "Hello, world!",
      "fileExtension": "Hello, world!",
      "followAuthLinks": true,
      "host": "Hello, world!",
      "id": 1,
      "includeCache": true,
      "includeSystem": "Hello, world!",
      "language": "Hello, world!",
      "internalAutodiscovery": true,
      "junkFolderExpiry": 1,
      "junkScoreThreshold": 1,
      "listOnIndex": 1,
      "maxRevisionsEntry": 1,
      "maxRevisionsTemplate": 1,
      "moderateComments": 1,
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "name": "Hello, world!",
      "newCreatedUserRoles": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ],
      "nofollowUrls": true,
      "normalizeOrientation": true,
      "operationIfExists": 1,
      "pageCustomPrefs": [
        "Hello, world!"
      ],
      "parent": {
        "id": 1,
        "name": "Hello, world!"
      },
      "publishEmptyArchive": true,
      "pingGoogle": true,
      "pingWeblogs": true,
      "pingOthers": [
        "Hello, world!"
      ],
      "relativeUrl": "Hello, world!",
      "requireCommentEmails": true,
      "sanitizeSpec": "Hello, world!",
      "serverOffset": 1,
      "sitePath": "Hello, world!",
      "smartReplace": 1,
      "sortOrderPosts": "Hello, world!",
      "sortOrderComments": "Hello, world!",
      "smartReplaceFields": [
        "Hello, world!"
      ],
      "statusDefault": "Hello, world!",
      "themeId": "Hello, world!",
      "timezone": 1,
      "updatable": true,
      "uploadDestination": "Hello, world!",
      "url": "Hello, world!",
      "useCommentConfirmation": true,
      "useRevision": true,
      "wordsInExcerpt": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowCommenterRegist": {
            "type": "boolean",
            "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
          },
          "allowCommentHtml": {
            "type": "boolean",
            "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
          },
          "allowComments": {
            "type": "boolean",
            "description": "true: Accept comments. false: Do not accept comments."
          },
          "allowCommentsDefault": {
            "type": "boolean",
            "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
          },
          "allowPings": {
            "type": "boolean"
          },
          "allowPingsDefault": {
            "type": "boolean",
            "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
          },
          "allowToChangeAtUpload": {
            "type": "boolean",
            "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
          },
          "allowUnregComments": {
            "type": "boolean",
            "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
          },
          "archivePath": {
            "type": "string",
            "description": "The archive path for this site. This property only accepts absolute path."
          },
          "archiveTypePreferred": {
            "type": "string",
            "description": "The preferred archive type for this site."
          },
          "archiveUrl": {
            "type": "string",
            "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
          },
          "autodiscoverLinks": {
            "type": "boolean",
            "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
          },
          "autolinkUrls": {
            "type": "boolean",
            "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
          },
          "autoRenameNonAscii": {
            "type": "boolean",
            "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
          },
          "basenameLimit": {
            "type": "number",
            "description": "The maximum length of basename."
          },
          "ccLicenseImage": {
            "type": "string",
            "description": "The URL for the Creative Commons License image for this site."
          },
          "ccLicenseUrl": {
            "type": "string",
            "description": "The URL for the Creative Commons License url for this site."
          },
          "class": {
            "type": "string",
            "description": "The object class for this site."
          },
          "commenterAuthenticators": {
            "type": "array",
            "description": "Array of commenter authenticators for this site."
          },
          "convertParasComments": {
            "type": "string",
            "description": "The text formatting of this site's comment."
          },
          "contentCss": {
            "type": "string",
            "description": "The CSS applying to WYSIWYG editor of this site."
          },
          "convertParas": {
            "type": "string",
            "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of created user."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of created user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this website. (format is iso 8601 datetime)"
          },
          "customDynamicTemplates": {
            "type": "string",
            "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
          },
          "daysOrPosts": {
            "type": "string",
            "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
          },
          "dateLanguage": {
            "type": "string",
            "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
          },
          "description": {
            "type": "string",
            "description": "The description of this site. [Update in v2] This property was changed to updatable."
          },
          "dynamicCache": {
            "type": "boolean",
            "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
          },
          "dynamicConditional": {
            "type": "boolean",
            "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
          },
          "entryCustomPrefs": {
            "type": "array",
            "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
          },
          "emailNewComments": {
            "type": "number",
            "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
          },
          "emailNewPings": {
            "type": "number",
            "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
          },
          "extraPath": {
            "type": "string",
            "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
          },
          "fileExtension": {
            "type": "string",
            "description": "The file extension for this site."
          },
          "followAuthLinks": {
            "type": "boolean",
            "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
          },
          "host": {
            "type": "string",
            "description": "The host name of this site."
          },
          "id": {
            "type": "number",
            "description": "The ID of this site."
          },
          "includeCache": {
            "type": "boolean",
            "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
          },
          "includeSystem": {
            "type": "string",
            "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
          },
          "language": {
            "type": "string",
            "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
          },
          "internalAutodiscovery": {
            "type": "boolean",
            "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
          },
          "junkFolderExpiry": {
            "type": "number",
            "description": "The period for deleting spam comments and trackbacks."
          },
          "junkScoreThreshold": {
            "type": "number",
            "description": "The spam score threshold of this site."
          },
          "listOnIndex": {
            "type": "number",
            "description": "The number of entries shown in the list by default."
          },
          "maxRevisionsEntry": {
            "type": "number",
            "description": "The number of revisions per entries and pages in this site."
          },
          "maxRevisionsTemplate": {
            "type": "number",
            "description": "The number of revisions per templates in this site."
          },
          "moderateComments": {
            "type": "number",
            "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of last modified user."
              },
              "id": {
                "type": "number",
                "description": "The ID of last modified user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this website. (format is iso 8601 datetime)"
          },
          "name": {
            "type": "string",
            "description": "The name for this site. [Update in v2] This property was changed to updatable."
          },
          "newCreatedUserRoles": {
            "type": "array",
            "description": "Assigned to users that are created in the future on this site."
          },
          "nofollowUrls": {
            "type": "boolean",
            "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
          },
          "normalizeOrientation": {
            "type": "boolean",
            "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
          },
          "operationIfExists": {
            "type": "number",
            "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
          },
          "pageCustomPrefs": {
            "type": "array",
            "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
          },
          "parent": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of parent website."
              },
              "name": {
                "type": "string",
                "description": "The name of parent website."
              }
            },
            "description": "The parent website of this blog. If this object is top level sige, this field must be null."
          },
          "publishEmptyArchive": {
            "type": "boolean",
            "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
          },
          "pingGoogle": {
            "type": "boolean",
            "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
          },
          "pingWeblogs": {
            "type": "boolean",
            "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
          },
          "pingOthers": {
            "type": "array",
            "description": "Array of update ping services."
          },
          "relativeUrl": {
            "type": "string",
            "description": "The relative site url of this site."
          },
          "requireCommentEmails": {
            "type": "boolean",
            "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
          },
          "sanitizeSpec": {
            "type": "string",
            "description": "The limit html tags of this site's comment. \"0\" is default."
          },
          "serverOffset": {
            "type": "number",
            "description": "The server offset for this site."
          },
          "sitePath": {
            "type": "string",
            "description": "The site path for this site. This property only accepts absolute path."
          },
          "smartReplace": {
            "type": "number",
            "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
          },
          "sortOrderPosts": {
            "type": "string",
            "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
          },
          "sortOrderComments": {
            "type": "string",
            "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
          },
          "smartReplaceFields": {
            "type": "array",
            "description": "Replace fields of this site."
          },
          "statusDefault": {
            "type": "string",
            "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
          },
          "themeId": {
            "type": "string",
            "description": "The theme ID for this site."
          },
          "timezone": {
            "type": "number",
            "description": "The timezone of this site."
          },
          "updatable": {
            "type": "boolean",
            "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
          },
          "uploadDestination": {
            "type": "string",
            "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
          },
          "url": {
            "type": "string",
            "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
          },
          "useCommentConfirmation": {
            "type": "boolean",
            "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
          },
          "useRevision": {
            "type": "boolean",
            "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
          },
          "wordsInExcerpt": {
            "type": "number",
            "description": "The default length for excerpt."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of sites.

Headers
Content-Type: application/json

Create a new top level site
POST/sites

Authentication required.

Create a new website. This endpoint need following permission.

  • Create Site

Post form data is following.

  • website (Site, required) - Single Site resource

This method accepts PUT or POST with __method=PUT.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken={Token}
Body
website={"url" : "http://example.com/", "name" : "New Website", "sitePath":"/path/to/document_root/"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowCommenterRegist": true,
  "allowCommentHtml": true,
  "allowComments": true,
  "allowCommentsDefault": true,
  "allowPings": true,
  "allowPingsDefault": true,
  "allowToChangeAtUpload": true,
  "allowUnregComments": true,
  "archivePath": "Hello, world!",
  "archiveTypePreferred": "Hello, world!",
  "archiveUrl": "Hello, world!",
  "autodiscoverLinks": true,
  "autolinkUrls": true,
  "autoRenameNonAscii": true,
  "basenameLimit": 1,
  "ccLicenseImage": "Hello, world!",
  "ccLicenseUrl": "Hello, world!",
  "class": "Hello, world!",
  "commenterAuthenticators": [
    "Hello, world!"
  ],
  "convertParasComments": "Hello, world!",
  "contentCss": "Hello, world!",
  "convertParas": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customDynamicTemplates": "Hello, world!",
  "daysOrPosts": "Hello, world!",
  "dateLanguage": "Hello, world!",
  "description": "Hello, world!",
  "dynamicCache": true,
  "dynamicConditional": true,
  "entryCustomPrefs": [
    "Hello, world!"
  ],
  "emailNewComments": 1,
  "emailNewPings": 1,
  "extraPath": "Hello, world!",
  "fileExtension": "Hello, world!",
  "followAuthLinks": true,
  "host": "Hello, world!",
  "id": 1,
  "includeCache": true,
  "includeSystem": "Hello, world!",
  "language": "Hello, world!",
  "internalAutodiscovery": true,
  "junkFolderExpiry": 1,
  "junkScoreThreshold": 1,
  "listOnIndex": 1,
  "maxRevisionsEntry": 1,
  "maxRevisionsTemplate": 1,
  "moderateComments": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "newCreatedUserRoles": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ],
  "nofollowUrls": true,
  "normalizeOrientation": true,
  "operationIfExists": 1,
  "pageCustomPrefs": [
    "Hello, world!"
  ],
  "parent": {
    "id": 1,
    "name": "Hello, world!"
  },
  "publishEmptyArchive": true,
  "pingGoogle": true,
  "pingWeblogs": true,
  "pingOthers": [
    "Hello, world!"
  ],
  "relativeUrl": "Hello, world!",
  "requireCommentEmails": true,
  "sanitizeSpec": "Hello, world!",
  "serverOffset": 1,
  "sitePath": "Hello, world!",
  "smartReplace": 1,
  "sortOrderPosts": "Hello, world!",
  "sortOrderComments": "Hello, world!",
  "smartReplaceFields": [
    "Hello, world!"
  ],
  "statusDefault": "Hello, world!",
  "themeId": "Hello, world!",
  "timezone": 1,
  "updatable": true,
  "uploadDestination": "Hello, world!",
  "url": "Hello, world!",
  "useCommentConfirmation": true,
  "useRevision": true,
  "wordsInExcerpt": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowCommenterRegist": {
      "type": "boolean",
      "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
    },
    "allowCommentHtml": {
      "type": "boolean",
      "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
    },
    "allowComments": {
      "type": "boolean",
      "description": "true: Accept comments. false: Do not accept comments."
    },
    "allowCommentsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
    },
    "allowPings": {
      "type": "boolean"
    },
    "allowPingsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
    },
    "allowToChangeAtUpload": {
      "type": "boolean",
      "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
    },
    "allowUnregComments": {
      "type": "boolean",
      "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
    },
    "archivePath": {
      "type": "string",
      "description": "The archive path for this site. This property only accepts absolute path."
    },
    "archiveTypePreferred": {
      "type": "string",
      "description": "The preferred archive type for this site."
    },
    "archiveUrl": {
      "type": "string",
      "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
    },
    "autodiscoverLinks": {
      "type": "boolean",
      "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
    },
    "autolinkUrls": {
      "type": "boolean",
      "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
    },
    "autoRenameNonAscii": {
      "type": "boolean",
      "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
    },
    "basenameLimit": {
      "type": "number",
      "description": "The maximum length of basename."
    },
    "ccLicenseImage": {
      "type": "string",
      "description": "The URL for the Creative Commons License image for this site."
    },
    "ccLicenseUrl": {
      "type": "string",
      "description": "The URL for the Creative Commons License url for this site."
    },
    "class": {
      "type": "string",
      "description": "The object class for this site."
    },
    "commenterAuthenticators": {
      "type": "array",
      "description": "Array of commenter authenticators for this site."
    },
    "convertParasComments": {
      "type": "string",
      "description": "The text formatting of this site's comment."
    },
    "contentCss": {
      "type": "string",
      "description": "The CSS applying to WYSIWYG editor of this site."
    },
    "convertParas": {
      "type": "string",
      "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this website. (format is iso 8601 datetime)"
    },
    "customDynamicTemplates": {
      "type": "string",
      "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
    },
    "daysOrPosts": {
      "type": "string",
      "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
    },
    "dateLanguage": {
      "type": "string",
      "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
    },
    "description": {
      "type": "string",
      "description": "The description of this site. [Update in v2] This property was changed to updatable."
    },
    "dynamicCache": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
    },
    "dynamicConditional": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
    },
    "entryCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
    },
    "emailNewComments": {
      "type": "number",
      "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
    },
    "emailNewPings": {
      "type": "number",
      "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
    },
    "extraPath": {
      "type": "string",
      "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
    },
    "fileExtension": {
      "type": "string",
      "description": "The file extension for this site."
    },
    "followAuthLinks": {
      "type": "boolean",
      "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
    },
    "host": {
      "type": "string",
      "description": "The host name of this site."
    },
    "id": {
      "type": "number",
      "description": "The ID of this site."
    },
    "includeCache": {
      "type": "boolean",
      "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
    },
    "includeSystem": {
      "type": "string",
      "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
    },
    "language": {
      "type": "string",
      "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
    },
    "internalAutodiscovery": {
      "type": "boolean",
      "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
    },
    "junkFolderExpiry": {
      "type": "number",
      "description": "The period for deleting spam comments and trackbacks."
    },
    "junkScoreThreshold": {
      "type": "number",
      "description": "The spam score threshold of this site."
    },
    "listOnIndex": {
      "type": "number",
      "description": "The number of entries shown in the list by default."
    },
    "maxRevisionsEntry": {
      "type": "number",
      "description": "The number of revisions per entries and pages in this site."
    },
    "maxRevisionsTemplate": {
      "type": "number",
      "description": "The number of revisions per templates in this site."
    },
    "moderateComments": {
      "type": "number",
      "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this website. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this site. [Update in v2] This property was changed to updatable."
    },
    "newCreatedUserRoles": {
      "type": "array",
      "description": "Assigned to users that are created in the future on this site."
    },
    "nofollowUrls": {
      "type": "boolean",
      "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
    },
    "normalizeOrientation": {
      "type": "boolean",
      "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
    },
    "operationIfExists": {
      "type": "number",
      "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
    },
    "pageCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent website."
        },
        "name": {
          "type": "string",
          "description": "The name of parent website."
        }
      },
      "description": "The parent website of this blog. If this object is top level sige, this field must be null."
    },
    "publishEmptyArchive": {
      "type": "boolean",
      "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
    },
    "pingGoogle": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
    },
    "pingWeblogs": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
    },
    "pingOthers": {
      "type": "array",
      "description": "Array of update ping services."
    },
    "relativeUrl": {
      "type": "string",
      "description": "The relative site url of this site."
    },
    "requireCommentEmails": {
      "type": "boolean",
      "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
    },
    "sanitizeSpec": {
      "type": "string",
      "description": "The limit html tags of this site's comment. \"0\" is default."
    },
    "serverOffset": {
      "type": "number",
      "description": "The server offset for this site."
    },
    "sitePath": {
      "type": "string",
      "description": "The site path for this site. This property only accepts absolute path."
    },
    "smartReplace": {
      "type": "number",
      "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
    },
    "sortOrderPosts": {
      "type": "string",
      "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
    },
    "sortOrderComments": {
      "type": "string",
      "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
    },
    "smartReplaceFields": {
      "type": "array",
      "description": "Replace fields of this site."
    },
    "statusDefault": {
      "type": "string",
      "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
    },
    "themeId": {
      "type": "string",
      "description": "The theme ID for this site."
    },
    "timezone": {
      "type": "number",
      "description": "The timezone of this site."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
    },
    "uploadDestination": {
      "type": "string",
      "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
    },
    "url": {
      "type": "string",
      "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
    },
    "useCommentConfirmation": {
      "type": "boolean",
      "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
    },
    "useRevision": {
      "type": "boolean",
      "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
    },
    "wordsInExcerpt": {
      "type": "number",
      "description": "The default length for excerpt."
    }
  }
}
Response  403
HideShow

Do not have permission to create a site.

Headers
Content-Type: application/json

Site Collection by user

Site Collection by user
GET/users/{user_id}/sites{?limit,offset,sortBy,sortOrder,fields,searchFields,search,includeIds,excludeIds,dateField,dateFrom,dateTo}

Retrieve a list of sites by user. The list includes only the site for which the user has any permissions.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id/sites?limit=25&offset=0&sortBy=name&sortOrder=descend&fields=&searchFields=name&search=&includeIds=&excludeIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
user_id
number or 'me' (required) 

The user ID or the word ‘me’.

search
string (optional) 

Search query.

searchFields
string (optional) Example: name

Only ‘name’ is available.

limit
number (optional) Example: 25

Maximum number of sites to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: name

Only ‘name’ is available

sortOrder
string (optional) Example: descend

  • descend (default): Return sites in descending order.

  • ascend: Return sites in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Sites resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of sites to include to result.

excludeIds
string (optional) 

The comma separated ID list of sites to exclude from result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowCommenterRegist": true,
      "allowCommentHtml": true,
      "allowComments": true,
      "allowCommentsDefault": true,
      "allowPings": true,
      "allowPingsDefault": true,
      "allowToChangeAtUpload": true,
      "allowUnregComments": true,
      "archivePath": "Hello, world!",
      "archiveTypePreferred": "Hello, world!",
      "archiveUrl": "Hello, world!",
      "autodiscoverLinks": true,
      "autolinkUrls": true,
      "autoRenameNonAscii": true,
      "basenameLimit": 1,
      "ccLicenseImage": "Hello, world!",
      "ccLicenseUrl": "Hello, world!",
      "class": "Hello, world!",
      "commenterAuthenticators": [
        "Hello, world!"
      ],
      "convertParasComments": "Hello, world!",
      "contentCss": "Hello, world!",
      "convertParas": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customDynamicTemplates": "Hello, world!",
      "daysOrPosts": "Hello, world!",
      "dateLanguage": "Hello, world!",
      "description": "Hello, world!",
      "dynamicCache": true,
      "dynamicConditional": true,
      "entryCustomPrefs": [
        "Hello, world!"
      ],
      "emailNewComments": 1,
      "emailNewPings": 1,
      "extraPath": "Hello, world!",
      "fileExtension": "Hello, world!",
      "followAuthLinks": true,
      "host": "Hello, world!",
      "id": 1,
      "includeCache": true,
      "includeSystem": "Hello, world!",
      "language": "Hello, world!",
      "internalAutodiscovery": true,
      "junkFolderExpiry": 1,
      "junkScoreThreshold": 1,
      "listOnIndex": 1,
      "maxRevisionsEntry": 1,
      "maxRevisionsTemplate": 1,
      "moderateComments": 1,
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "name": "Hello, world!",
      "newCreatedUserRoles": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ],
      "nofollowUrls": true,
      "normalizeOrientation": true,
      "operationIfExists": 1,
      "pageCustomPrefs": [
        "Hello, world!"
      ],
      "parent": {
        "id": 1,
        "name": "Hello, world!"
      },
      "publishEmptyArchive": true,
      "pingGoogle": true,
      "pingWeblogs": true,
      "pingOthers": [
        "Hello, world!"
      ],
      "relativeUrl": "Hello, world!",
      "requireCommentEmails": true,
      "sanitizeSpec": "Hello, world!",
      "serverOffset": 1,
      "sitePath": "Hello, world!",
      "smartReplace": 1,
      "sortOrderPosts": "Hello, world!",
      "sortOrderComments": "Hello, world!",
      "smartReplaceFields": [
        "Hello, world!"
      ],
      "statusDefault": "Hello, world!",
      "themeId": "Hello, world!",
      "timezone": 1,
      "updatable": true,
      "uploadDestination": "Hello, world!",
      "url": "Hello, world!",
      "useCommentConfirmation": true,
      "useRevision": true,
      "wordsInExcerpt": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowCommenterRegist": {
            "type": "boolean",
            "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
          },
          "allowCommentHtml": {
            "type": "boolean",
            "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
          },
          "allowComments": {
            "type": "boolean",
            "description": "true: Accept comments. false: Do not accept comments."
          },
          "allowCommentsDefault": {
            "type": "boolean",
            "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
          },
          "allowPings": {
            "type": "boolean"
          },
          "allowPingsDefault": {
            "type": "boolean",
            "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
          },
          "allowToChangeAtUpload": {
            "type": "boolean",
            "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
          },
          "allowUnregComments": {
            "type": "boolean",
            "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
          },
          "archivePath": {
            "type": "string",
            "description": "The archive path for this site. This property only accepts absolute path."
          },
          "archiveTypePreferred": {
            "type": "string",
            "description": "The preferred archive type for this site."
          },
          "archiveUrl": {
            "type": "string",
            "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
          },
          "autodiscoverLinks": {
            "type": "boolean",
            "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
          },
          "autolinkUrls": {
            "type": "boolean",
            "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
          },
          "autoRenameNonAscii": {
            "type": "boolean",
            "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
          },
          "basenameLimit": {
            "type": "number",
            "description": "The maximum length of basename."
          },
          "ccLicenseImage": {
            "type": "string",
            "description": "The URL for the Creative Commons License image for this site."
          },
          "ccLicenseUrl": {
            "type": "string",
            "description": "The URL for the Creative Commons License url for this site."
          },
          "class": {
            "type": "string",
            "description": "The object class for this site."
          },
          "commenterAuthenticators": {
            "type": "array",
            "description": "Array of commenter authenticators for this site."
          },
          "convertParasComments": {
            "type": "string",
            "description": "The text formatting of this site's comment."
          },
          "contentCss": {
            "type": "string",
            "description": "The CSS applying to WYSIWYG editor of this site."
          },
          "convertParas": {
            "type": "string",
            "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of created user."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of created user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this website. (format is iso 8601 datetime)"
          },
          "customDynamicTemplates": {
            "type": "string",
            "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
          },
          "daysOrPosts": {
            "type": "string",
            "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
          },
          "dateLanguage": {
            "type": "string",
            "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
          },
          "description": {
            "type": "string",
            "description": "The description of this site. [Update in v2] This property was changed to updatable."
          },
          "dynamicCache": {
            "type": "boolean",
            "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
          },
          "dynamicConditional": {
            "type": "boolean",
            "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
          },
          "entryCustomPrefs": {
            "type": "array",
            "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
          },
          "emailNewComments": {
            "type": "number",
            "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
          },
          "emailNewPings": {
            "type": "number",
            "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
          },
          "extraPath": {
            "type": "string",
            "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
          },
          "fileExtension": {
            "type": "string",
            "description": "The file extension for this site."
          },
          "followAuthLinks": {
            "type": "boolean",
            "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
          },
          "host": {
            "type": "string",
            "description": "The host name of this site."
          },
          "id": {
            "type": "number",
            "description": "The ID of this site."
          },
          "includeCache": {
            "type": "boolean",
            "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
          },
          "includeSystem": {
            "type": "string",
            "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
          },
          "language": {
            "type": "string",
            "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
          },
          "internalAutodiscovery": {
            "type": "boolean",
            "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
          },
          "junkFolderExpiry": {
            "type": "number",
            "description": "The period for deleting spam comments and trackbacks."
          },
          "junkScoreThreshold": {
            "type": "number",
            "description": "The spam score threshold of this site."
          },
          "listOnIndex": {
            "type": "number",
            "description": "The number of entries shown in the list by default."
          },
          "maxRevisionsEntry": {
            "type": "number",
            "description": "The number of revisions per entries and pages in this site."
          },
          "maxRevisionsTemplate": {
            "type": "number",
            "description": "The number of revisions per templates in this site."
          },
          "moderateComments": {
            "type": "number",
            "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of last modified user."
              },
              "id": {
                "type": "number",
                "description": "The ID of last modified user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this website. (format is iso 8601 datetime)"
          },
          "name": {
            "type": "string",
            "description": "The name for this site. [Update in v2] This property was changed to updatable."
          },
          "newCreatedUserRoles": {
            "type": "array",
            "description": "Assigned to users that are created in the future on this site."
          },
          "nofollowUrls": {
            "type": "boolean",
            "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
          },
          "normalizeOrientation": {
            "type": "boolean",
            "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
          },
          "operationIfExists": {
            "type": "number",
            "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
          },
          "pageCustomPrefs": {
            "type": "array",
            "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
          },
          "parent": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of parent website."
              },
              "name": {
                "type": "string",
                "description": "The name of parent website."
              }
            },
            "description": "The parent website of this blog. If this object is top level sige, this field must be null."
          },
          "publishEmptyArchive": {
            "type": "boolean",
            "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
          },
          "pingGoogle": {
            "type": "boolean",
            "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
          },
          "pingWeblogs": {
            "type": "boolean",
            "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
          },
          "pingOthers": {
            "type": "array",
            "description": "Array of update ping services."
          },
          "relativeUrl": {
            "type": "string",
            "description": "The relative site url of this site."
          },
          "requireCommentEmails": {
            "type": "boolean",
            "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
          },
          "sanitizeSpec": {
            "type": "string",
            "description": "The limit html tags of this site's comment. \"0\" is default."
          },
          "serverOffset": {
            "type": "number",
            "description": "The server offset for this site."
          },
          "sitePath": {
            "type": "string",
            "description": "The site path for this site. This property only accepts absolute path."
          },
          "smartReplace": {
            "type": "number",
            "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
          },
          "sortOrderPosts": {
            "type": "string",
            "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
          },
          "sortOrderComments": {
            "type": "string",
            "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
          },
          "smartReplaceFields": {
            "type": "array",
            "description": "Replace fields of this site."
          },
          "statusDefault": {
            "type": "string",
            "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
          },
          "themeId": {
            "type": "string",
            "description": "The theme ID for this site."
          },
          "timezone": {
            "type": "number",
            "description": "The timezone of this site."
          },
          "updatable": {
            "type": "boolean",
            "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
          },
          "uploadDestination": {
            "type": "string",
            "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
          },
          "url": {
            "type": "string",
            "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
          },
          "useCommentConfirmation": {
            "type": "boolean",
            "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
          },
          "useRevision": {
            "type": "boolean",
            "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
          },
          "wordsInExcerpt": {
            "type": "number",
            "description": "The default length for excerpt."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of sites.

Headers
Content-Type: application/json
Response  404
HideShow

User not found.

Headers
Content-Type: application/json

Site Collection by parent site

Site Collection by parent site
GET/sites/{site_id}/children{?limit,offset,sortBy,sortOrder,fields,searchFields,search,includeIds,excludeIds,dateField,dateFrom,dateTo}

Retrieve a list of sites by parent site.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1/children?limit=25&offset=0&sortBy=name&sortOrder=descend&fields=&searchFields=name&search=&includeIds=&excludeIds=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
site_id
number (required) Example: 1

The site ID of parent.

search
string (optional) 

Search query.

searchFields
string (optional) Example: name

Only ‘name’ is available.

limit
number (optional) Example: 25

Maximum number of sites to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: name

Only ‘name’ is available

sortOrder
string (optional) Example: descend

  • descend (default): Return sites in descending order.

  • ascend: Return sites in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Sites resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of sites to include to result.

excludeIds
string (optional) 

The comma separated ID list of sites to exclude from result.

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowCommenterRegist": true,
      "allowCommentHtml": true,
      "allowComments": true,
      "allowCommentsDefault": true,
      "allowPings": true,
      "allowPingsDefault": true,
      "allowToChangeAtUpload": true,
      "allowUnregComments": true,
      "archivePath": "Hello, world!",
      "archiveTypePreferred": "Hello, world!",
      "archiveUrl": "Hello, world!",
      "autodiscoverLinks": true,
      "autolinkUrls": true,
      "autoRenameNonAscii": true,
      "basenameLimit": 1,
      "ccLicenseImage": "Hello, world!",
      "ccLicenseUrl": "Hello, world!",
      "class": "Hello, world!",
      "commenterAuthenticators": [
        "Hello, world!"
      ],
      "convertParasComments": "Hello, world!",
      "contentCss": "Hello, world!",
      "convertParas": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customDynamicTemplates": "Hello, world!",
      "daysOrPosts": "Hello, world!",
      "dateLanguage": "Hello, world!",
      "description": "Hello, world!",
      "dynamicCache": true,
      "dynamicConditional": true,
      "entryCustomPrefs": [
        "Hello, world!"
      ],
      "emailNewComments": 1,
      "emailNewPings": 1,
      "extraPath": "Hello, world!",
      "fileExtension": "Hello, world!",
      "followAuthLinks": true,
      "host": "Hello, world!",
      "id": 1,
      "includeCache": true,
      "includeSystem": "Hello, world!",
      "language": "Hello, world!",
      "internalAutodiscovery": true,
      "junkFolderExpiry": 1,
      "junkScoreThreshold": 1,
      "listOnIndex": 1,
      "maxRevisionsEntry": 1,
      "maxRevisionsTemplate": 1,
      "moderateComments": 1,
      "modifiedBy": {
        "displayName": "Hello, world!",
        "id": 1,
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "name": "Hello, world!",
      "newCreatedUserRoles": [
        {
          "id": 1,
          "name": "Hello, world!"
        }
      ],
      "nofollowUrls": true,
      "normalizeOrientation": true,
      "operationIfExists": 1,
      "pageCustomPrefs": [
        "Hello, world!"
      ],
      "parent": {
        "id": 1,
        "name": "Hello, world!"
      },
      "publishEmptyArchive": true,
      "pingGoogle": true,
      "pingWeblogs": true,
      "pingOthers": [
        "Hello, world!"
      ],
      "relativeUrl": "Hello, world!",
      "requireCommentEmails": true,
      "sanitizeSpec": "Hello, world!",
      "serverOffset": 1,
      "sitePath": "Hello, world!",
      "smartReplace": 1,
      "sortOrderPosts": "Hello, world!",
      "sortOrderComments": "Hello, world!",
      "smartReplaceFields": [
        "Hello, world!"
      ],
      "statusDefault": "Hello, world!",
      "themeId": "Hello, world!",
      "timezone": 1,
      "updatable": true,
      "uploadDestination": "Hello, world!",
      "url": "Hello, world!",
      "useCommentConfirmation": true,
      "useRevision": true,
      "wordsInExcerpt": 1
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowCommenterRegist": {
            "type": "boolean",
            "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
          },
          "allowCommentHtml": {
            "type": "boolean",
            "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
          },
          "allowComments": {
            "type": "boolean",
            "description": "true: Accept comments. false: Do not accept comments."
          },
          "allowCommentsDefault": {
            "type": "boolean",
            "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
          },
          "allowPings": {
            "type": "boolean"
          },
          "allowPingsDefault": {
            "type": "boolean",
            "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
          },
          "allowToChangeAtUpload": {
            "type": "boolean",
            "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
          },
          "allowUnregComments": {
            "type": "boolean",
            "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
          },
          "archivePath": {
            "type": "string",
            "description": "The archive path for this site. This property only accepts absolute path."
          },
          "archiveTypePreferred": {
            "type": "string",
            "description": "The preferred archive type for this site."
          },
          "archiveUrl": {
            "type": "string",
            "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
          },
          "autodiscoverLinks": {
            "type": "boolean",
            "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
          },
          "autolinkUrls": {
            "type": "boolean",
            "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
          },
          "autoRenameNonAscii": {
            "type": "boolean",
            "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
          },
          "basenameLimit": {
            "type": "number",
            "description": "The maximum length of basename."
          },
          "ccLicenseImage": {
            "type": "string",
            "description": "The URL for the Creative Commons License image for this site."
          },
          "ccLicenseUrl": {
            "type": "string",
            "description": "The URL for the Creative Commons License url for this site."
          },
          "class": {
            "type": "string",
            "description": "The object class for this site."
          },
          "commenterAuthenticators": {
            "type": "array",
            "description": "Array of commenter authenticators for this site."
          },
          "convertParasComments": {
            "type": "string",
            "description": "The text formatting of this site's comment."
          },
          "contentCss": {
            "type": "string",
            "description": "The CSS applying to WYSIWYG editor of this site."
          },
          "convertParas": {
            "type": "string",
            "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of created user."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of created user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this website. (format is iso 8601 datetime)"
          },
          "customDynamicTemplates": {
            "type": "string",
            "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
          },
          "daysOrPosts": {
            "type": "string",
            "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
          },
          "dateLanguage": {
            "type": "string",
            "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
          },
          "description": {
            "type": "string",
            "description": "The description of this site. [Update in v2] This property was changed to updatable."
          },
          "dynamicCache": {
            "type": "boolean",
            "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
          },
          "dynamicConditional": {
            "type": "boolean",
            "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
          },
          "entryCustomPrefs": {
            "type": "array",
            "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
          },
          "emailNewComments": {
            "type": "number",
            "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
          },
          "emailNewPings": {
            "type": "number",
            "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
          },
          "extraPath": {
            "type": "string",
            "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
          },
          "fileExtension": {
            "type": "string",
            "description": "The file extension for this site."
          },
          "followAuthLinks": {
            "type": "boolean",
            "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
          },
          "host": {
            "type": "string",
            "description": "The host name of this site."
          },
          "id": {
            "type": "number",
            "description": "The ID of this site."
          },
          "includeCache": {
            "type": "boolean",
            "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
          },
          "includeSystem": {
            "type": "string",
            "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
          },
          "language": {
            "type": "string",
            "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
          },
          "internalAutodiscovery": {
            "type": "boolean",
            "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
          },
          "junkFolderExpiry": {
            "type": "number",
            "description": "The period for deleting spam comments and trackbacks."
          },
          "junkScoreThreshold": {
            "type": "number",
            "description": "The spam score threshold of this site."
          },
          "listOnIndex": {
            "type": "number",
            "description": "The number of entries shown in the list by default."
          },
          "maxRevisionsEntry": {
            "type": "number",
            "description": "The number of revisions per entries and pages in this site."
          },
          "maxRevisionsTemplate": {
            "type": "number",
            "description": "The number of revisions per templates in this site."
          },
          "moderateComments": {
            "type": "number",
            "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of last modified user."
              },
              "id": {
                "type": "number",
                "description": "The ID of last modified user."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this website. (format is iso 8601 datetime)"
          },
          "name": {
            "type": "string",
            "description": "The name for this site. [Update in v2] This property was changed to updatable."
          },
          "newCreatedUserRoles": {
            "type": "array",
            "description": "Assigned to users that are created in the future on this site."
          },
          "nofollowUrls": {
            "type": "boolean",
            "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
          },
          "normalizeOrientation": {
            "type": "boolean",
            "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
          },
          "operationIfExists": {
            "type": "number",
            "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
          },
          "pageCustomPrefs": {
            "type": "array",
            "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
          },
          "parent": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of parent website."
              },
              "name": {
                "type": "string",
                "description": "The name of parent website."
              }
            },
            "description": "The parent website of this blog. If this object is top level sige, this field must be null."
          },
          "publishEmptyArchive": {
            "type": "boolean",
            "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
          },
          "pingGoogle": {
            "type": "boolean",
            "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
          },
          "pingWeblogs": {
            "type": "boolean",
            "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
          },
          "pingOthers": {
            "type": "array",
            "description": "Array of update ping services."
          },
          "relativeUrl": {
            "type": "string",
            "description": "The relative site url of this site."
          },
          "requireCommentEmails": {
            "type": "boolean",
            "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
          },
          "sanitizeSpec": {
            "type": "string",
            "description": "The limit html tags of this site's comment. \"0\" is default."
          },
          "serverOffset": {
            "type": "number",
            "description": "The server offset for this site."
          },
          "sitePath": {
            "type": "string",
            "description": "The site path for this site. This property only accepts absolute path."
          },
          "smartReplace": {
            "type": "number",
            "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
          },
          "sortOrderPosts": {
            "type": "string",
            "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
          },
          "sortOrderComments": {
            "type": "string",
            "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
          },
          "smartReplaceFields": {
            "type": "array",
            "description": "Replace fields of this site."
          },
          "statusDefault": {
            "type": "string",
            "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
          },
          "themeId": {
            "type": "string",
            "description": "The theme ID for this site."
          },
          "timezone": {
            "type": "number",
            "description": "The timezone of this site."
          },
          "updatable": {
            "type": "boolean",
            "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
          },
          "uploadDestination": {
            "type": "string",
            "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
          },
          "url": {
            "type": "string",
            "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
          },
          "useCommentConfirmation": {
            "type": "boolean",
            "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
          },
          "useRevision": {
            "type": "boolean",
            "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
          },
          "wordsInExcerpt": {
            "type": "number",
            "description": "The default length for excerpt."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of sites.

Headers
Content-Type: application/json
Response  404
HideShow

User not found.

Headers
Content-Type: application/json

Site

Fetch single site
GET/sites/{site_id}{?fields}

Fetch a single site by its ID.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1?fields=
URI Parameters
HideShow
site_id
number (required) Example: 1

The Site ID.

fields
string (optional) 

The field list to retrieve as part of the Sites resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowCommenterRegist": true,
  "allowCommentHtml": true,
  "allowComments": true,
  "allowCommentsDefault": true,
  "allowPings": true,
  "allowPingsDefault": true,
  "allowToChangeAtUpload": true,
  "allowUnregComments": true,
  "archivePath": "Hello, world!",
  "archiveTypePreferred": "Hello, world!",
  "archiveUrl": "Hello, world!",
  "autodiscoverLinks": true,
  "autolinkUrls": true,
  "autoRenameNonAscii": true,
  "basenameLimit": 1,
  "ccLicenseImage": "Hello, world!",
  "ccLicenseUrl": "Hello, world!",
  "class": "Hello, world!",
  "commenterAuthenticators": [
    "Hello, world!"
  ],
  "convertParasComments": "Hello, world!",
  "contentCss": "Hello, world!",
  "convertParas": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customDynamicTemplates": "Hello, world!",
  "daysOrPosts": "Hello, world!",
  "dateLanguage": "Hello, world!",
  "description": "Hello, world!",
  "dynamicCache": true,
  "dynamicConditional": true,
  "entryCustomPrefs": [
    "Hello, world!"
  ],
  "emailNewComments": 1,
  "emailNewPings": 1,
  "extraPath": "Hello, world!",
  "fileExtension": "Hello, world!",
  "followAuthLinks": true,
  "host": "Hello, world!",
  "id": 1,
  "includeCache": true,
  "includeSystem": "Hello, world!",
  "language": "Hello, world!",
  "internalAutodiscovery": true,
  "junkFolderExpiry": 1,
  "junkScoreThreshold": 1,
  "listOnIndex": 1,
  "maxRevisionsEntry": 1,
  "maxRevisionsTemplate": 1,
  "moderateComments": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "newCreatedUserRoles": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ],
  "nofollowUrls": true,
  "normalizeOrientation": true,
  "operationIfExists": 1,
  "pageCustomPrefs": [
    "Hello, world!"
  ],
  "parent": {
    "id": 1,
    "name": "Hello, world!"
  },
  "publishEmptyArchive": true,
  "pingGoogle": true,
  "pingWeblogs": true,
  "pingOthers": [
    "Hello, world!"
  ],
  "relativeUrl": "Hello, world!",
  "requireCommentEmails": true,
  "sanitizeSpec": "Hello, world!",
  "serverOffset": 1,
  "sitePath": "Hello, world!",
  "smartReplace": 1,
  "sortOrderPosts": "Hello, world!",
  "sortOrderComments": "Hello, world!",
  "smartReplaceFields": [
    "Hello, world!"
  ],
  "statusDefault": "Hello, world!",
  "themeId": "Hello, world!",
  "timezone": 1,
  "updatable": true,
  "uploadDestination": "Hello, world!",
  "url": "Hello, world!",
  "useCommentConfirmation": true,
  "useRevision": true,
  "wordsInExcerpt": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowCommenterRegist": {
      "type": "boolean",
      "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
    },
    "allowCommentHtml": {
      "type": "boolean",
      "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
    },
    "allowComments": {
      "type": "boolean",
      "description": "true: Accept comments. false: Do not accept comments."
    },
    "allowCommentsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
    },
    "allowPings": {
      "type": "boolean"
    },
    "allowPingsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
    },
    "allowToChangeAtUpload": {
      "type": "boolean",
      "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
    },
    "allowUnregComments": {
      "type": "boolean",
      "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
    },
    "archivePath": {
      "type": "string",
      "description": "The archive path for this site. This property only accepts absolute path."
    },
    "archiveTypePreferred": {
      "type": "string",
      "description": "The preferred archive type for this site."
    },
    "archiveUrl": {
      "type": "string",
      "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
    },
    "autodiscoverLinks": {
      "type": "boolean",
      "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
    },
    "autolinkUrls": {
      "type": "boolean",
      "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
    },
    "autoRenameNonAscii": {
      "type": "boolean",
      "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
    },
    "basenameLimit": {
      "type": "number",
      "description": "The maximum length of basename."
    },
    "ccLicenseImage": {
      "type": "string",
      "description": "The URL for the Creative Commons License image for this site."
    },
    "ccLicenseUrl": {
      "type": "string",
      "description": "The URL for the Creative Commons License url for this site."
    },
    "class": {
      "type": "string",
      "description": "The object class for this site."
    },
    "commenterAuthenticators": {
      "type": "array",
      "description": "Array of commenter authenticators for this site."
    },
    "convertParasComments": {
      "type": "string",
      "description": "The text formatting of this site's comment."
    },
    "contentCss": {
      "type": "string",
      "description": "The CSS applying to WYSIWYG editor of this site."
    },
    "convertParas": {
      "type": "string",
      "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this website. (format is iso 8601 datetime)"
    },
    "customDynamicTemplates": {
      "type": "string",
      "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
    },
    "daysOrPosts": {
      "type": "string",
      "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
    },
    "dateLanguage": {
      "type": "string",
      "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
    },
    "description": {
      "type": "string",
      "description": "The description of this site. [Update in v2] This property was changed to updatable."
    },
    "dynamicCache": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
    },
    "dynamicConditional": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
    },
    "entryCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
    },
    "emailNewComments": {
      "type": "number",
      "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
    },
    "emailNewPings": {
      "type": "number",
      "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
    },
    "extraPath": {
      "type": "string",
      "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
    },
    "fileExtension": {
      "type": "string",
      "description": "The file extension for this site."
    },
    "followAuthLinks": {
      "type": "boolean",
      "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
    },
    "host": {
      "type": "string",
      "description": "The host name of this site."
    },
    "id": {
      "type": "number",
      "description": "The ID of this site."
    },
    "includeCache": {
      "type": "boolean",
      "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
    },
    "includeSystem": {
      "type": "string",
      "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
    },
    "language": {
      "type": "string",
      "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
    },
    "internalAutodiscovery": {
      "type": "boolean",
      "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
    },
    "junkFolderExpiry": {
      "type": "number",
      "description": "The period for deleting spam comments and trackbacks."
    },
    "junkScoreThreshold": {
      "type": "number",
      "description": "The spam score threshold of this site."
    },
    "listOnIndex": {
      "type": "number",
      "description": "The number of entries shown in the list by default."
    },
    "maxRevisionsEntry": {
      "type": "number",
      "description": "The number of revisions per entries and pages in this site."
    },
    "maxRevisionsTemplate": {
      "type": "number",
      "description": "The number of revisions per templates in this site."
    },
    "moderateComments": {
      "type": "number",
      "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this website. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this site. [Update in v2] This property was changed to updatable."
    },
    "newCreatedUserRoles": {
      "type": "array",
      "description": "Assigned to users that are created in the future on this site."
    },
    "nofollowUrls": {
      "type": "boolean",
      "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
    },
    "normalizeOrientation": {
      "type": "boolean",
      "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
    },
    "operationIfExists": {
      "type": "number",
      "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
    },
    "pageCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent website."
        },
        "name": {
          "type": "string",
          "description": "The name of parent website."
        }
      },
      "description": "The parent website of this blog. If this object is top level sige, this field must be null."
    },
    "publishEmptyArchive": {
      "type": "boolean",
      "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
    },
    "pingGoogle": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
    },
    "pingWeblogs": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
    },
    "pingOthers": {
      "type": "array",
      "description": "Array of update ping services."
    },
    "relativeUrl": {
      "type": "string",
      "description": "The relative site url of this site."
    },
    "requireCommentEmails": {
      "type": "boolean",
      "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
    },
    "sanitizeSpec": {
      "type": "string",
      "description": "The limit html tags of this site's comment. \"0\" is default."
    },
    "serverOffset": {
      "type": "number",
      "description": "The server offset for this site."
    },
    "sitePath": {
      "type": "string",
      "description": "The site path for this site. This property only accepts absolute path."
    },
    "smartReplace": {
      "type": "number",
      "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
    },
    "sortOrderPosts": {
      "type": "string",
      "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
    },
    "sortOrderComments": {
      "type": "string",
      "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
    },
    "smartReplaceFields": {
      "type": "array",
      "description": "Replace fields of this site."
    },
    "statusDefault": {
      "type": "string",
      "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
    },
    "themeId": {
      "type": "string",
      "description": "The theme ID for this site."
    },
    "timezone": {
      "type": "number",
      "description": "The timezone of this site."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
    },
    "uploadDestination": {
      "type": "string",
      "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
    },
    "url": {
      "type": "string",
      "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
    },
    "useCommentConfirmation": {
      "type": "boolean",
      "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
    },
    "useRevision": {
      "type": "boolean",
      "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
    },
    "wordsInExcerpt": {
      "type": "number",
      "description": "The default length for excerpt."
    }
  }
}
Response  403
HideShow

Do not have permission to fetch site.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Create a new child site
POST/sites/{site_id}

Authentication required. Create a new blog under the top level site. This endpoint need following permissions.

  • Create Site

Post form data is follows.

  • blog (Site, required) - Single Site resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The Site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken={Token}
Body
blog={"name":"New Blog", "url":"blog", "sitePath":"blog"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowCommenterRegist": true,
  "allowCommentHtml": true,
  "allowComments": true,
  "allowCommentsDefault": true,
  "allowPings": true,
  "allowPingsDefault": true,
  "allowToChangeAtUpload": true,
  "allowUnregComments": true,
  "archivePath": "Hello, world!",
  "archiveTypePreferred": "Hello, world!",
  "archiveUrl": "Hello, world!",
  "autodiscoverLinks": true,
  "autolinkUrls": true,
  "autoRenameNonAscii": true,
  "basenameLimit": 1,
  "ccLicenseImage": "Hello, world!",
  "ccLicenseUrl": "Hello, world!",
  "class": "Hello, world!",
  "commenterAuthenticators": [
    "Hello, world!"
  ],
  "convertParasComments": "Hello, world!",
  "contentCss": "Hello, world!",
  "convertParas": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customDynamicTemplates": "Hello, world!",
  "daysOrPosts": "Hello, world!",
  "dateLanguage": "Hello, world!",
  "description": "Hello, world!",
  "dynamicCache": true,
  "dynamicConditional": true,
  "entryCustomPrefs": [
    "Hello, world!"
  ],
  "emailNewComments": 1,
  "emailNewPings": 1,
  "extraPath": "Hello, world!",
  "fileExtension": "Hello, world!",
  "followAuthLinks": true,
  "host": "Hello, world!",
  "id": 1,
  "includeCache": true,
  "includeSystem": "Hello, world!",
  "language": "Hello, world!",
  "internalAutodiscovery": true,
  "junkFolderExpiry": 1,
  "junkScoreThreshold": 1,
  "listOnIndex": 1,
  "maxRevisionsEntry": 1,
  "maxRevisionsTemplate": 1,
  "moderateComments": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "newCreatedUserRoles": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ],
  "nofollowUrls": true,
  "normalizeOrientation": true,
  "operationIfExists": 1,
  "pageCustomPrefs": [
    "Hello, world!"
  ],
  "parent": {
    "id": 1,
    "name": "Hello, world!"
  },
  "publishEmptyArchive": true,
  "pingGoogle": true,
  "pingWeblogs": true,
  "pingOthers": [
    "Hello, world!"
  ],
  "relativeUrl": "Hello, world!",
  "requireCommentEmails": true,
  "sanitizeSpec": "Hello, world!",
  "serverOffset": 1,
  "sitePath": "Hello, world!",
  "smartReplace": 1,
  "sortOrderPosts": "Hello, world!",
  "sortOrderComments": "Hello, world!",
  "smartReplaceFields": [
    "Hello, world!"
  ],
  "statusDefault": "Hello, world!",
  "themeId": "Hello, world!",
  "timezone": 1,
  "updatable": true,
  "uploadDestination": "Hello, world!",
  "url": "Hello, world!",
  "useCommentConfirmation": true,
  "useRevision": true,
  "wordsInExcerpt": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowCommenterRegist": {
      "type": "boolean",
      "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
    },
    "allowCommentHtml": {
      "type": "boolean",
      "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
    },
    "allowComments": {
      "type": "boolean",
      "description": "true: Accept comments. false: Do not accept comments."
    },
    "allowCommentsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
    },
    "allowPings": {
      "type": "boolean"
    },
    "allowPingsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
    },
    "allowToChangeAtUpload": {
      "type": "boolean",
      "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
    },
    "allowUnregComments": {
      "type": "boolean",
      "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
    },
    "archivePath": {
      "type": "string",
      "description": "The archive path for this site. This property only accepts absolute path."
    },
    "archiveTypePreferred": {
      "type": "string",
      "description": "The preferred archive type for this site."
    },
    "archiveUrl": {
      "type": "string",
      "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
    },
    "autodiscoverLinks": {
      "type": "boolean",
      "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
    },
    "autolinkUrls": {
      "type": "boolean",
      "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
    },
    "autoRenameNonAscii": {
      "type": "boolean",
      "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
    },
    "basenameLimit": {
      "type": "number",
      "description": "The maximum length of basename."
    },
    "ccLicenseImage": {
      "type": "string",
      "description": "The URL for the Creative Commons License image for this site."
    },
    "ccLicenseUrl": {
      "type": "string",
      "description": "The URL for the Creative Commons License url for this site."
    },
    "class": {
      "type": "string",
      "description": "The object class for this site."
    },
    "commenterAuthenticators": {
      "type": "array",
      "description": "Array of commenter authenticators for this site."
    },
    "convertParasComments": {
      "type": "string",
      "description": "The text formatting of this site's comment."
    },
    "contentCss": {
      "type": "string",
      "description": "The CSS applying to WYSIWYG editor of this site."
    },
    "convertParas": {
      "type": "string",
      "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this website. (format is iso 8601 datetime)"
    },
    "customDynamicTemplates": {
      "type": "string",
      "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
    },
    "daysOrPosts": {
      "type": "string",
      "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
    },
    "dateLanguage": {
      "type": "string",
      "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
    },
    "description": {
      "type": "string",
      "description": "The description of this site. [Update in v2] This property was changed to updatable."
    },
    "dynamicCache": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
    },
    "dynamicConditional": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
    },
    "entryCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
    },
    "emailNewComments": {
      "type": "number",
      "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
    },
    "emailNewPings": {
      "type": "number",
      "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
    },
    "extraPath": {
      "type": "string",
      "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
    },
    "fileExtension": {
      "type": "string",
      "description": "The file extension for this site."
    },
    "followAuthLinks": {
      "type": "boolean",
      "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
    },
    "host": {
      "type": "string",
      "description": "The host name of this site."
    },
    "id": {
      "type": "number",
      "description": "The ID of this site."
    },
    "includeCache": {
      "type": "boolean",
      "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
    },
    "includeSystem": {
      "type": "string",
      "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
    },
    "language": {
      "type": "string",
      "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
    },
    "internalAutodiscovery": {
      "type": "boolean",
      "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
    },
    "junkFolderExpiry": {
      "type": "number",
      "description": "The period for deleting spam comments and trackbacks."
    },
    "junkScoreThreshold": {
      "type": "number",
      "description": "The spam score threshold of this site."
    },
    "listOnIndex": {
      "type": "number",
      "description": "The number of entries shown in the list by default."
    },
    "maxRevisionsEntry": {
      "type": "number",
      "description": "The number of revisions per entries and pages in this site."
    },
    "maxRevisionsTemplate": {
      "type": "number",
      "description": "The number of revisions per templates in this site."
    },
    "moderateComments": {
      "type": "number",
      "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this website. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this site. [Update in v2] This property was changed to updatable."
    },
    "newCreatedUserRoles": {
      "type": "array",
      "description": "Assigned to users that are created in the future on this site."
    },
    "nofollowUrls": {
      "type": "boolean",
      "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
    },
    "normalizeOrientation": {
      "type": "boolean",
      "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
    },
    "operationIfExists": {
      "type": "number",
      "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
    },
    "pageCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent website."
        },
        "name": {
          "type": "string",
          "description": "The name of parent website."
        }
      },
      "description": "The parent website of this blog. If this object is top level sige, this field must be null."
    },
    "publishEmptyArchive": {
      "type": "boolean",
      "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
    },
    "pingGoogle": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
    },
    "pingWeblogs": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
    },
    "pingOthers": {
      "type": "array",
      "description": "Array of update ping services."
    },
    "relativeUrl": {
      "type": "string",
      "description": "The relative site url of this site."
    },
    "requireCommentEmails": {
      "type": "boolean",
      "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
    },
    "sanitizeSpec": {
      "type": "string",
      "description": "The limit html tags of this site's comment. \"0\" is default."
    },
    "serverOffset": {
      "type": "number",
      "description": "The server offset for this site."
    },
    "sitePath": {
      "type": "string",
      "description": "The site path for this site. This property only accepts absolute path."
    },
    "smartReplace": {
      "type": "number",
      "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
    },
    "sortOrderPosts": {
      "type": "string",
      "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
    },
    "sortOrderComments": {
      "type": "string",
      "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
    },
    "smartReplaceFields": {
      "type": "array",
      "description": "Replace fields of this site."
    },
    "statusDefault": {
      "type": "string",
      "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
    },
    "themeId": {
      "type": "string",
      "description": "The theme ID for this site."
    },
    "timezone": {
      "type": "number",
      "description": "The timezone of this site."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
    },
    "uploadDestination": {
      "type": "string",
      "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
    },
    "url": {
      "type": "string",
      "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
    },
    "useCommentConfirmation": {
      "type": "boolean",
      "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
    },
    "useRevision": {
      "type": "boolean",
      "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
    },
    "wordsInExcerpt": {
      "type": "number",
      "description": "The default length for excerpt."
    }
  }
}
Response  403
HideShow

Do not have permission to create child site.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Update site
PUT/sites/{site_id}

Authentication required. Update site. This endpoint needs following permission.

  • Change Settings

Post form data is follows.

  • blog (Site, required) - Single Site resource

This method accepts PUT or POST with __method=PUT.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The Site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
website={"name" : "Our new Website"} or blog={"name" : "Our new Website"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowCommenterRegist": true,
  "allowCommentHtml": true,
  "allowComments": true,
  "allowCommentsDefault": true,
  "allowPings": true,
  "allowPingsDefault": true,
  "allowToChangeAtUpload": true,
  "allowUnregComments": true,
  "archivePath": "Hello, world!",
  "archiveTypePreferred": "Hello, world!",
  "archiveUrl": "Hello, world!",
  "autodiscoverLinks": true,
  "autolinkUrls": true,
  "autoRenameNonAscii": true,
  "basenameLimit": 1,
  "ccLicenseImage": "Hello, world!",
  "ccLicenseUrl": "Hello, world!",
  "class": "Hello, world!",
  "commenterAuthenticators": [
    "Hello, world!"
  ],
  "convertParasComments": "Hello, world!",
  "contentCss": "Hello, world!",
  "convertParas": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customDynamicTemplates": "Hello, world!",
  "daysOrPosts": "Hello, world!",
  "dateLanguage": "Hello, world!",
  "description": "Hello, world!",
  "dynamicCache": true,
  "dynamicConditional": true,
  "entryCustomPrefs": [
    "Hello, world!"
  ],
  "emailNewComments": 1,
  "emailNewPings": 1,
  "extraPath": "Hello, world!",
  "fileExtension": "Hello, world!",
  "followAuthLinks": true,
  "host": "Hello, world!",
  "id": 1,
  "includeCache": true,
  "includeSystem": "Hello, world!",
  "language": "Hello, world!",
  "internalAutodiscovery": true,
  "junkFolderExpiry": 1,
  "junkScoreThreshold": 1,
  "listOnIndex": 1,
  "maxRevisionsEntry": 1,
  "maxRevisionsTemplate": 1,
  "moderateComments": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "newCreatedUserRoles": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ],
  "nofollowUrls": true,
  "normalizeOrientation": true,
  "operationIfExists": 1,
  "pageCustomPrefs": [
    "Hello, world!"
  ],
  "parent": {
    "id": 1,
    "name": "Hello, world!"
  },
  "publishEmptyArchive": true,
  "pingGoogle": true,
  "pingWeblogs": true,
  "pingOthers": [
    "Hello, world!"
  ],
  "relativeUrl": "Hello, world!",
  "requireCommentEmails": true,
  "sanitizeSpec": "Hello, world!",
  "serverOffset": 1,
  "sitePath": "Hello, world!",
  "smartReplace": 1,
  "sortOrderPosts": "Hello, world!",
  "sortOrderComments": "Hello, world!",
  "smartReplaceFields": [
    "Hello, world!"
  ],
  "statusDefault": "Hello, world!",
  "themeId": "Hello, world!",
  "timezone": 1,
  "updatable": true,
  "uploadDestination": "Hello, world!",
  "url": "Hello, world!",
  "useCommentConfirmation": true,
  "useRevision": true,
  "wordsInExcerpt": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowCommenterRegist": {
      "type": "boolean",
      "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
    },
    "allowCommentHtml": {
      "type": "boolean",
      "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
    },
    "allowComments": {
      "type": "boolean",
      "description": "true: Accept comments. false: Do not accept comments."
    },
    "allowCommentsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
    },
    "allowPings": {
      "type": "boolean"
    },
    "allowPingsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
    },
    "allowToChangeAtUpload": {
      "type": "boolean",
      "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
    },
    "allowUnregComments": {
      "type": "boolean",
      "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
    },
    "archivePath": {
      "type": "string",
      "description": "The archive path for this site. This property only accepts absolute path."
    },
    "archiveTypePreferred": {
      "type": "string",
      "description": "The preferred archive type for this site."
    },
    "archiveUrl": {
      "type": "string",
      "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
    },
    "autodiscoverLinks": {
      "type": "boolean",
      "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
    },
    "autolinkUrls": {
      "type": "boolean",
      "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
    },
    "autoRenameNonAscii": {
      "type": "boolean",
      "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
    },
    "basenameLimit": {
      "type": "number",
      "description": "The maximum length of basename."
    },
    "ccLicenseImage": {
      "type": "string",
      "description": "The URL for the Creative Commons License image for this site."
    },
    "ccLicenseUrl": {
      "type": "string",
      "description": "The URL for the Creative Commons License url for this site."
    },
    "class": {
      "type": "string",
      "description": "The object class for this site."
    },
    "commenterAuthenticators": {
      "type": "array",
      "description": "Array of commenter authenticators for this site."
    },
    "convertParasComments": {
      "type": "string",
      "description": "The text formatting of this site's comment."
    },
    "contentCss": {
      "type": "string",
      "description": "The CSS applying to WYSIWYG editor of this site."
    },
    "convertParas": {
      "type": "string",
      "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this website. (format is iso 8601 datetime)"
    },
    "customDynamicTemplates": {
      "type": "string",
      "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
    },
    "daysOrPosts": {
      "type": "string",
      "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
    },
    "dateLanguage": {
      "type": "string",
      "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
    },
    "description": {
      "type": "string",
      "description": "The description of this site. [Update in v2] This property was changed to updatable."
    },
    "dynamicCache": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
    },
    "dynamicConditional": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
    },
    "entryCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
    },
    "emailNewComments": {
      "type": "number",
      "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
    },
    "emailNewPings": {
      "type": "number",
      "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
    },
    "extraPath": {
      "type": "string",
      "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
    },
    "fileExtension": {
      "type": "string",
      "description": "The file extension for this site."
    },
    "followAuthLinks": {
      "type": "boolean",
      "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
    },
    "host": {
      "type": "string",
      "description": "The host name of this site."
    },
    "id": {
      "type": "number",
      "description": "The ID of this site."
    },
    "includeCache": {
      "type": "boolean",
      "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
    },
    "includeSystem": {
      "type": "string",
      "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
    },
    "language": {
      "type": "string",
      "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
    },
    "internalAutodiscovery": {
      "type": "boolean",
      "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
    },
    "junkFolderExpiry": {
      "type": "number",
      "description": "The period for deleting spam comments and trackbacks."
    },
    "junkScoreThreshold": {
      "type": "number",
      "description": "The spam score threshold of this site."
    },
    "listOnIndex": {
      "type": "number",
      "description": "The number of entries shown in the list by default."
    },
    "maxRevisionsEntry": {
      "type": "number",
      "description": "The number of revisions per entries and pages in this site."
    },
    "maxRevisionsTemplate": {
      "type": "number",
      "description": "The number of revisions per templates in this site."
    },
    "moderateComments": {
      "type": "number",
      "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this website. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this site. [Update in v2] This property was changed to updatable."
    },
    "newCreatedUserRoles": {
      "type": "array",
      "description": "Assigned to users that are created in the future on this site."
    },
    "nofollowUrls": {
      "type": "boolean",
      "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
    },
    "normalizeOrientation": {
      "type": "boolean",
      "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
    },
    "operationIfExists": {
      "type": "number",
      "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
    },
    "pageCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent website."
        },
        "name": {
          "type": "string",
          "description": "The name of parent website."
        }
      },
      "description": "The parent website of this blog. If this object is top level sige, this field must be null."
    },
    "publishEmptyArchive": {
      "type": "boolean",
      "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
    },
    "pingGoogle": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
    },
    "pingWeblogs": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
    },
    "pingOthers": {
      "type": "array",
      "description": "Array of update ping services."
    },
    "relativeUrl": {
      "type": "string",
      "description": "The relative site url of this site."
    },
    "requireCommentEmails": {
      "type": "boolean",
      "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
    },
    "sanitizeSpec": {
      "type": "string",
      "description": "The limit html tags of this site's comment. \"0\" is default."
    },
    "serverOffset": {
      "type": "number",
      "description": "The server offset for this site."
    },
    "sitePath": {
      "type": "string",
      "description": "The site path for this site. This property only accepts absolute path."
    },
    "smartReplace": {
      "type": "number",
      "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
    },
    "sortOrderPosts": {
      "type": "string",
      "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
    },
    "sortOrderComments": {
      "type": "string",
      "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
    },
    "smartReplaceFields": {
      "type": "array",
      "description": "Replace fields of this site."
    },
    "statusDefault": {
      "type": "string",
      "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
    },
    "themeId": {
      "type": "string",
      "description": "The theme ID for this site."
    },
    "timezone": {
      "type": "number",
      "description": "The timezone of this site."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
    },
    "uploadDestination": {
      "type": "string",
      "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
    },
    "url": {
      "type": "string",
      "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
    },
    "useCommentConfirmation": {
      "type": "boolean",
      "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
    },
    "useRevision": {
      "type": "boolean",
      "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
    },
    "wordsInExcerpt": {
      "type": "number",
      "description": "The default length for excerpt."
    }
  }
}
Response  403
HideShow

Do not have permission to update site.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Delete site
DELETE/sites/{site_id}

Authentication required. Delete site. This endpoint needs following permissions.

  • Site Administrator

This method accepts DELETE or POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/1
URI Parameters
HideShow
site_id
number (required) Example: 1

The Site ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken={Token}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "allowCommenterRegist": true,
  "allowCommentHtml": true,
  "allowComments": true,
  "allowCommentsDefault": true,
  "allowPings": true,
  "allowPingsDefault": true,
  "allowToChangeAtUpload": true,
  "allowUnregComments": true,
  "archivePath": "Hello, world!",
  "archiveTypePreferred": "Hello, world!",
  "archiveUrl": "Hello, world!",
  "autodiscoverLinks": true,
  "autolinkUrls": true,
  "autoRenameNonAscii": true,
  "basenameLimit": 1,
  "ccLicenseImage": "Hello, world!",
  "ccLicenseUrl": "Hello, world!",
  "class": "Hello, world!",
  "commenterAuthenticators": [
    "Hello, world!"
  ],
  "convertParasComments": "Hello, world!",
  "contentCss": "Hello, world!",
  "convertParas": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customDynamicTemplates": "Hello, world!",
  "daysOrPosts": "Hello, world!",
  "dateLanguage": "Hello, world!",
  "description": "Hello, world!",
  "dynamicCache": true,
  "dynamicConditional": true,
  "entryCustomPrefs": [
    "Hello, world!"
  ],
  "emailNewComments": 1,
  "emailNewPings": 1,
  "extraPath": "Hello, world!",
  "fileExtension": "Hello, world!",
  "followAuthLinks": true,
  "host": "Hello, world!",
  "id": 1,
  "includeCache": true,
  "includeSystem": "Hello, world!",
  "language": "Hello, world!",
  "internalAutodiscovery": true,
  "junkFolderExpiry": 1,
  "junkScoreThreshold": 1,
  "listOnIndex": 1,
  "maxRevisionsEntry": 1,
  "maxRevisionsTemplate": 1,
  "moderateComments": 1,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "newCreatedUserRoles": [
    {
      "id": 1,
      "name": "Hello, world!"
    }
  ],
  "nofollowUrls": true,
  "normalizeOrientation": true,
  "operationIfExists": 1,
  "pageCustomPrefs": [
    "Hello, world!"
  ],
  "parent": {
    "id": 1,
    "name": "Hello, world!"
  },
  "publishEmptyArchive": true,
  "pingGoogle": true,
  "pingWeblogs": true,
  "pingOthers": [
    "Hello, world!"
  ],
  "relativeUrl": "Hello, world!",
  "requireCommentEmails": true,
  "sanitizeSpec": "Hello, world!",
  "serverOffset": 1,
  "sitePath": "Hello, world!",
  "smartReplace": 1,
  "sortOrderPosts": "Hello, world!",
  "sortOrderComments": "Hello, world!",
  "smartReplaceFields": [
    "Hello, world!"
  ],
  "statusDefault": "Hello, world!",
  "themeId": "Hello, world!",
  "timezone": 1,
  "updatable": true,
  "uploadDestination": "Hello, world!",
  "url": "Hello, world!",
  "useCommentConfirmation": true,
  "useRevision": true,
  "wordsInExcerpt": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "allowCommenterRegist": {
      "type": "boolean",
      "description": "true: Allow visitors to register as members of this website using one of the Authentication Methods selected below. false: Not allowed."
    },
    "allowCommentHtml": {
      "type": "boolean",
      "description": "true: Allow commenters to include a limited set of HTML tags in their comments. false: All HTML will be stripped out."
    },
    "allowComments": {
      "type": "boolean",
      "description": "true: Accept comments. false: Do not accept comments."
    },
    "allowCommentsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site.  true: Comments are accepted. false: Comments are not accepted."
    },
    "allowPings": {
      "type": "boolean"
    },
    "allowPingsDefault": {
      "type": "boolean",
      "description": "The state of the comment acceptance of default in this site. Available value is follows. true: Trackbacks are accepted. false: Trackbacks are not accepted."
    },
    "allowToChangeAtUpload": {
      "type": "boolean",
      "description": "true: Allow user to change the upload destination when upload a file. false: Not allowed."
    },
    "allowUnregComments": {
      "type": "boolean",
      "description": "true: Allow comments from anonymous or unauthenticated users. false: Not allowed."
    },
    "archivePath": {
      "type": "string",
      "description": "The archive path for this site. This property only accepts absolute path."
    },
    "archiveTypePreferred": {
      "type": "string",
      "description": "The preferred archive type for this site."
    },
    "archiveUrl": {
      "type": "string",
      "description": "The archive url of this site. [Update in v2] This property was changed to updatable."
    },
    "autodiscoverLinks": {
      "type": "boolean",
      "description": "true: Enable External TrackBack Auto-Discovery. false: Disable."
    },
    "autolinkUrls": {
      "type": "boolean",
      "description": "true: Transform URLs in comment text into HTML links. false: Do not transform."
    },
    "autoRenameNonAscii": {
      "type": "boolean",
      "description": "true: Uploded file name  will be automatically changed to randam filename if uploaded filename contains non-ascii character. false: File name is not changed."
    },
    "basenameLimit": {
      "type": "number",
      "description": "The maximum length of basename."
    },
    "ccLicenseImage": {
      "type": "string",
      "description": "The URL for the Creative Commons License image for this site."
    },
    "ccLicenseUrl": {
      "type": "string",
      "description": "The URL for the Creative Commons License url for this site."
    },
    "class": {
      "type": "string",
      "description": "The object class for this site."
    },
    "commenterAuthenticators": {
      "type": "array",
      "description": "Array of commenter authenticators for this site."
    },
    "convertParasComments": {
      "type": "string",
      "description": "The text formatting of this site's comment."
    },
    "contentCss": {
      "type": "string",
      "description": "The CSS applying to WYSIWYG editor of this site."
    },
    "convertParas": {
      "type": "string",
      "description": "The default text formatting in this site. Available value in default is follows. `0`: The default text formatting is 'None' `__default__`: The default text formatting is 'Convert Line Breaks' `markdown`: The default text formatting is 'Markdown' `markdown_with_smartypants`: The default text formatting is 'Markdown With SmartyPants' `richtext`: The default text formatting is 'Rich Text' `textile_2`: The default text formatting is 'Textile 2'"
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of created user."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of created user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of created user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "createdDate": {
      "type": "string",
      "description": "The created time for this website. (format is iso 8601 datetime)"
    },
    "customDynamicTemplates": {
      "type": "string",
      "description": "Publishing profile for this site. Available value is follows. `none`: Immediately publish all index templates and archive templates statically. `all`: Publish all index templates and archive templates dynamically. `archives`: Publish all archive templates dynamically. Immediately publish all index templates statically. `async_all`: All index templates and archive templates published statically via Publish Que. `async_partial`: mmediately publish Main Index template, Page archives statically. Use Publish Queue to publish all other index templates and archive templates statically."
    },
    "daysOrPosts": {
      "type": "string",
      "description": "The type of listing default. Available value is follows. `days`: Listing entries that written in the past N days. N is a value of listOnIndex. `posts`: Listing most recent N entries. N is a value of listOnIndex."
    },
    "dateLanguage": {
      "type": "string",
      "description": "The date locale settings for this site. Available valus is follow. `cz`: Czech / `dk`: Danish / `nl`: Dutch / `en`: English / `et`: Estonian / `fr`: French / `de`: German / `is`: Icelandic / `it`: Italian / `ja`: Japanese / `no`: Norwegian / `pl`: Polish / `pt`: Portuguese / `sk`: Slovak / `si`: Slovenian / `es`: Spanish / `fi`: Suomi / `se`: Swedish"
    },
    "description": {
      "type": "string",
      "description": "The description of this site. [Update in v2] This property was changed to updatable."
    },
    "dynamicCache": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic cache for dynamic publishing is enabled. / `false`: Dynamic cache for dynamic publishing is disabled."
    },
    "dynamicConditional": {
      "type": "boolean",
      "description": "Cannot set this property when dynamic templates does not exist. `true`: Dynamic conditional retrieval of dynamic publishing is enabled. / `false`: Dynamic conditional retrieval of dynamic publishing is disabled."
    },
    "entryCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's entry. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Entry assets list / customfield_basename: Each custom Fields"
    },
    "emailNewComments": {
      "type": "number",
      "description": "Email notification when posting comment to this site. `0`: Off. / `1`: On. / `2`: Only when attension is required."
    },
    "emailNewPings": {
      "type": "number",
      "description": "\"Email notification setting when accepting trackback to this site. `0`: Off. / `1`: On. / `2`: Only when attention is required."
    },
    "extraPath": {
      "type": "string",
      "description": "The raw data of extra path for default upload destination. If extra path is not configured, this value is a blank string."
    },
    "fileExtension": {
      "type": "string",
      "description": "The file extension for this site."
    },
    "followAuthLinks": {
      "type": "boolean",
      "description": "`true`: Do not add the 'nofollow' attribute when a comment is submitted by a trusted commenter. / `false`: Add the 'nofollow' attribute ."
    },
    "host": {
      "type": "string",
      "description": "The host name of this site."
    },
    "id": {
      "type": "number",
      "description": "The ID of this site."
    },
    "includeCache": {
      "type": "boolean",
      "description": "`true`: Module cache is enabled. / `false`: Module cache is disabled."
    },
    "includeSystem": {
      "type": "string",
      "description": "`'' (empty string)`: Server Side Includes is disabled. / `php`: Server Side Include is enabled with PHP. / `shtml`: Server Side Include is enabled with Apache SSI. / `asp`: Server Side Include is enabled with ASP. / `jsp`: Server Side Include is enabled with JSP."
    },
    "language": {
      "type": "string",
      "description": "The language for this site. Available value is follows. `de`: German / `en`: English / `es`: Spanish / `fl`: French / `nl`: Dutch / `ja`: Japanese"
    },
    "internalAutodiscovery": {
      "type": "boolean",
      "description": "`true`: Enable Internal TrackBack Auto-Discovery. / `false`: Disable."
    },
    "junkFolderExpiry": {
      "type": "number",
      "description": "The period for deleting spam comments and trackbacks."
    },
    "junkScoreThreshold": {
      "type": "number",
      "description": "The spam score threshold of this site."
    },
    "listOnIndex": {
      "type": "number",
      "description": "The number of entries shown in the list by default."
    },
    "maxRevisionsEntry": {
      "type": "number",
      "description": "The number of revisions per entries and pages in this site."
    },
    "maxRevisionsTemplate": {
      "type": "number",
      "description": "The number of revisions per templates in this site."
    },
    "moderateComments": {
      "type": "number",
      "description": "`0`: Anyone. / `1`: No one. / `2`: Trusted commenters only. / `3`: Any authenticated commenters.\n\nmoderatePings (boolean) - `true`: Hold all TrackBacks for approval before they are published. / `false`: Do not hold."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of last modified user."
        },
        "id": {
          "type": "number",
          "description": "The ID of last modified user."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of last modified user's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      }
    },
    "modifiedDate": {
      "type": "string",
      "description": "The last modified time for this website. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this site. [Update in v2] This property was changed to updatable."
    },
    "newCreatedUserRoles": {
      "type": "array",
      "description": "Assigned to users that are created in the future on this site."
    },
    "nofollowUrls": {
      "type": "boolean",
      "description": "`true`: All URLs in comments and TrackBacks will be assigned a 'nofollow' link relation. / `false`: Not assigned."
    },
    "normalizeOrientation": {
      "type": "boolean",
      "description": "`true`: Image orientation is normalized automatically when the image file contains orientation information. / `false`: Image orientation is will never normalized."
    },
    "operationIfExists": {
      "type": "number",
      "description": "`1`: The upload file will be changed to random file name automatically. / `2`: The existing file will be overwritten. / `3`: Upload will be canceled."
    },
    "pageCustomPrefs": {
      "type": "array",
      "description": "Default displayed fields of this site's page. Available value is follows. `title`: Title field / `text`: Body and extended field / `category`: Category list / `excerpt`: Excerpt field / `keywords`: Keyword field / `tags`: Tags field / `feedback`: Comment and trackback setting field / `assets`: Page assets list / `customfield_basename`: Each custom Fields"
    },
    "parent": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of parent website."
        },
        "name": {
          "type": "string",
          "description": "The name of parent website."
        }
      },
      "description": "The parent website of this blog. If this object is top level sige, this field must be null."
    },
    "publishEmptyArchive": {
      "type": "boolean",
      "description": "`true`: Category archive without entries is published. / `false`: Category archive without entries is not published."
    },
    "pingGoogle": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to Google. / `false`: Disabled sending update ping to Google."
    },
    "pingWeblogs": {
      "type": "boolean",
      "description": "`true`: Enable sending update ping to weblogs.com. / `false`: Disabled sending update ping to weblogs.com."
    },
    "pingOthers": {
      "type": "array",
      "description": "Array of update ping services."
    },
    "relativeUrl": {
      "type": "string",
      "description": "The relative site url of this site."
    },
    "requireCommentEmails": {
      "type": "boolean",
      "description": "`true`: Require name and E-mail Address for Anonymous Comments. / `false`: Do not require."
    },
    "sanitizeSpec": {
      "type": "string",
      "description": "The limit html tags of this site's comment. \"0\" is default."
    },
    "serverOffset": {
      "type": "number",
      "description": "The server offset for this site."
    },
    "sitePath": {
      "type": "string",
      "description": "The site path for this site. This property only accepts absolute path."
    },
    "smartReplace": {
      "type": "number",
      "description": "The punctuation replacement of this site. `0`: No substitution.  / `1`: Character entities. / `2`: ASCII equivalents."
    },
    "sortOrderPosts": {
      "type": "string",
      "description": "The default sorting direction for the entry listing. Available value is follows. `ascend`: Ascengin order. / `descend`: Descending order."
    },
    "sortOrderComments": {
      "type": "string",
      "description": "The comment order of this site. Available value is follows. `ascend`: Ascending order. / `descend`: Descending order"
    },
    "smartReplaceFields": {
      "type": "array",
      "description": "Replace fields of this site."
    },
    "statusDefault": {
      "type": "string",
      "description": "The default entry status in this site. Available value is follows. `Pubish`: The default status is 'Published' / `Draft`: The default status is 'Unpublished'"
    },
    "themeId": {
      "type": "string",
      "description": "The theme ID for this site."
    },
    "timezone": {
      "type": "number",
      "description": "The timezone of this site."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: Current user can update this website. / `false`: Current user cannot update this website."
    },
    "uploadDestination": {
      "type": "string",
      "description": "The default configuration for upload destination of this site.\n\npath (string) - The full path for default upload destination. The value begin with site path and contains extra path if extra_path configured. If default upload destination is not configured, this value is just a same as site_path.\nraw (string) - The raw data of default upload destination. If default upload destination is not configured, this value is a blank string."
    },
    "url": {
      "type": "string",
      "description": "The site url of this site.  [Update in v2] This property was changed to updatable."
    },
    "useCommentConfirmation": {
      "type": "boolean",
      "description": "`true`: Each commenter's browser will be redirected to a comment confirmation page after their comment is accepted. / `false`: Will not."
    },
    "useRevision": {
      "type": "boolean",
      "description": "`true`: Revision history is enabled. / `false`: Revision history is disabled."
    },
    "wordsInExcerpt": {
      "type": "number",
      "description": "The default length for excerpt."
    }
  }
}
Response  403
HideShow

Do not have permission to delete site.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json

Stats

This is the PageStats(byPath) resource.

Property Name Type Data Type Database Column Private Read Only Description Version
path value String Y The relative path of the target. v1
pageviews value Number Y The number of pageviews for the path. This property exists only if request endpoint is “pageviewsForPath”. v1
visits value Number Y The number of visits for the path. This property exists only if request endpoint is “visitsForPath”. v1
archiveType value String mt_fileinfo.fileinfo_archive_type Y The archive type of the path. This property is null if the path is not managed by MT. v1
entry Object - Y This property is null if “archiveType” is not “Individual”. v1
entry.id value Number mt_entry.entry_id Y The ID of entry. v1
author Object - Y This property is null if “archiveType” is neither “Author” nor “Author-∗”. v1
author.id value Number mt_author.author_id Y The ID of author. v1
category Object - Y This property is null if “archiveType” is neither “Category” nor “Category-∗”. v1
category.id value Number mt_category.category_id Y The ID of category. v1

{ “totalResults”: 2, “items”: [ { “entry”: null, “pageviews”: “56”, “author”: null, “path”: “/”, “title”: “Your site”, “archiveType”: “index”, “category”: null, “startDate”: null }, { “entry”: { “id”: “1198” }, “pageviews”: “44”, “author”: null, “path”: “/2015/03/exapmle.html”, “title”: “Entry title is here”, “archiveType”: “Individual”, “category”: null, “startDate”: null }, ], “totals”: { “pageviews”: “329” } }

Also, This is the PageStats(byDate) resource.

Property Name Type Data Type Database Column Private Read Only Description Version
date value iso 8601 date Y The date of the target. The format is “YYYY-MM-DD”. v1
pageviews value Number Y The pageviews for the path. This property exists only if request endpoint is “pageviewsForDate”. v1
visits value Number Y The visits for the path. This property exists only if request endpoint is “visitsForDate”. v1

{ “totalResults”: 6, “items”: [ { “visits”: “1”, “date”: “2015-05-20” }, { “visits”: “1”, “date”: “2015-05-21” }, { “visits”: “2”, “date”: “2015-05-22” }, { “visits”: “1”, “date”: “2015-05-23” }, { “visits”: “1”, “date”: “2015-05-24” }, { “visits”: “4”, “date”: “2015-05-25” } ], “totals”: { “visits”: “10” } }

PageStats

Retrieve a list of visits data for each path
GET/sites/{site_id}/stats/path/visits{?startDate,endDate,limit,offset,path}

Retrieve a list of visits data for each path from the provider.

Authentication required.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/stats/path/visits?startDate=&endDate=&limit=&offset=&path=
URI Parameters
HideShow
site_id
Number (required) 

The site ID.

startDate
String (required) 

This is an required parameter. Start date of data. The format is “YYYY-MM-DD”.

endDate
String (required) 

This is an required parameter. End date of data. The format is “YYYY-MM-DD”.

limit
Number (optional) 

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
Number (optional) 

This is an optional parameter. 0-indexed offset. Default is 0.

path
String (optional) 

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 2,
  "items": [
    {
      "entry": null,
      "pageviews": "56",
      "author": null,
      "path": "/",
      "title": "Your site",
      "archiveType": "index",
      "category": null,
      "startDate": null
    },
    {
      "entry": {
        "id": "1198"
      },
      "pageviews": "44",
      "author": null,
      "path": "/2015/03/exapmle.html",
      "title": "Entry title is here",
      "archiveType": "Individual",
      "category": null,
      "startDate": null
    },
  ],
  "totals": {
    "pageviews": "329"
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Readied provider is not found",
    "code": "404"
  }
}

Retrieve a list of visits data for each date
GET/sites/{site_id}/stats/date/visits{?startDate,endDate,limit,offset,path}

Retrieve a list of visits data for each date from the provider.

Authentication required.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/stats/date/visits?startDate=&endDate=&limit=&offset=&path=
URI Parameters
HideShow
site_id
Number (required) 

The site ID.

startDate
String (required) 

This is an required parameter. Start date of data. The format is “YYYY-MM-DD”.

endDate
String (required) 

This is an required parameter. End date of data. The format is “YYYY-MM-DD”.

limit
Number (optional) 

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
Number (optional) 

This is an optional parameter. 0-indexed offset. Default is 0.

path
String (optional) 

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 6,
  "items": [
    {
      "visits": "1",
      "date": "2015-05-20"
    },
    {
      "visits": "1",
      "date": "2015-05-21"
    },
    {
      "visits": "2",
      "date": "2015-05-22"
    },
    {
      "visits": "1",
      "date": "2015-05-23"
    },
    {
      "visits": "1",
      "date": "2015-05-24"
    },
    {
      "visits": "4",
      "date": "2015-05-25"
    }
  ],
  "totals": {
    "visits": "10"
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Readied provider is not found",
    "code": "404"
  }
}

Retrieve a list of page view data for each path
GET/sites/{site_id}/stats/path/pageviews{?startDate,endDate,limit,offset,path,uniquePath}

Retrieve a list of page view data for each path from the provider.

Authentication required.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/stats/path/pageviews?startDate=&endDate=&limit=&offset=&path=&uniquePath=
URI Parameters
HideShow
site_id
Number (required) 

The site ID.

startDate
String (required) 

This is an required parameter. Start date of data. The format is “YYYY-MM-DD”.

endDate
String (required) 

This is an required parameter. End date of data. The format is “YYYY-MM-DD”.

limit
Number (optional) 

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
Number (optional) 

This is an optional parameter. 0-indexed offset. Default is 0.

path
String (optional) 

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

uniquePath
Boolean (optional) 

This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contains page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 2,
  "items": [
    {
      "entry": null,
      "pageviews": "56",
      "author": null,
      "path": "/",
      "title": "Your site",
      "archiveType": "index",
      "category": null,
      "startDate": null
    },
    {
      "entry": {
        "id": "1198"
      },
      "pageviews": "44",
      "author": null,
      "path": "/2015/03/exapmle.html",
      "title": "Entry title is here",
      "archiveType": "Individual",
      "category": null,
      "startDate": null
    },
  ],
  "totals": {
    "pageviews": "329"
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Readied provider is not found",
    "code": "404"
  }
}

Retrieve a list of page view data for each date
GET/sites/{site_id}/stats/date/pageviews{?startDate,endDate,limit,offset,path}

Retrieve a list of page view data for each date from the provider.

Authentication required.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/stats/date/pageviews?startDate=&endDate=&limit=&offset=&path=
URI Parameters
HideShow
site_id
Number (required) 

The site ID.

startDate
String (required) 

This is an required parameter. Start date of data. The format is “YYYY-MM-DD”.

endDate
String (required) 

This is an required parameter. End date of data. The format is “YYYY-MM-DD”.

limit
Number (optional) 

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
Number (optional) 

This is an optional parameter. 0-indexed offset. Default is 0.

path
String (optional) 

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

uniquePath
Boolean (optional) 

This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contains page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 6,
  "items": [
    {
      "visits": "1",
      "date": "2015-05-20"
    },
    {
      "visits": "1",
      "date": "2015-05-21"
    },
    {
      "visits": "2",
      "date": "2015-05-22"
    },
    {
      "visits": "1",
      "date": "2015-05-23"
    },
    {
      "visits": "1",
      "date": "2015-05-24"
    },
    {
      "visits": "4",
      "date": "2015-05-25"
    }
  ],
  "totals": {
    "visits": "10"
  }
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}
Response  404
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Readied provider is not found",
    "code": "404"
  }
}

Provider

Retrieve current provider
GET/sites/{site_id}/stats/provider

Authentication required.

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/stats/provider
URI Parameters
HideShow
site_id
Number (required) 

The site ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "id": "GoogleAnalytics"
}
Response  401
HideShow
Headers
Content-Type: application/json
Body
{
  "error": {
    "message": "Unauthorized",
    "code": 401
  }
}

Templates

Template Collection

Template Collection
GET/sites/{site_id}/templates{?site_id,limit,offset,sortBy,sortOrder,fields,searchFields,search,includeIds,excludeIds,type}

Authentication required.

Retrieve a list of templates. This endpoint requires following permissions.

  • edit_templates (site level or system lebel)

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates?site_id=&limit=10&offset=0&sortBy=name&sortOrder=descend&fields=&searchFields=label&search=&includeIds=&excludeIds=&type=
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, that means global template in the system.

search
string (optional) 

Search query.

searchFields
string (optional) Example: label

The comma separated list of field names to search.

limit
number (optional) Example: 10

Maximum number of templates to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: name

  • id: Sort by the ID of each template.

  • name: Sort by the name of each template.

  • created_on: Sort by the created time of each template.

  • modified_on: Sort by the modified time of each template.

  • created_by: Sort by the ID of user who created each template.

  • modified_by: Sort by the ID of user who modified each template.

  • type: Sort by the type of each template.

sortOrder
string (optional) Example: descend

  • descend: Return templates in descending order. For sorting by date, it means from newest to oldest.

  • ascend: Return templates in ascending order. For sorting by date, it means from oldest to newest.

fields
string (optional) 

The field list to retrieve as part of the Templates resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

includeIds
string (optional) 

The comma separated list of template IDs to include in result.

excludeIds
string (optional) 

The comma separated list of template IDSs to exclude from result.

type
string (optional) 

Filter by template type. The list should be separated by commas. (e.g. archive, custom, index, individual, page etc-)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "archiveTypes": [
        {
          "id": 1,
          "isPreferred": true,
          "fileTemplate": "Hello, world!",
          "archiveType": "Hello, world!",
          "buildType": "Hello, world!",
          "updatable": true
        }
      ],
      "updatable": true,
      "blog": {
        "id": 1
      },
      "buildType": "Hello, world!",
      "createdBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "createdDate": "Hello, world!",
      "customFields": [
        {
          "basename": "Hello, world!",
          "value": "Hello, world!"
        }
      ],
      "id": 1,
      "linkToFie": "Hello, world!",
      "modifiedBy": {
        "id": 1,
        "displayName": "Hello, world!",
        "userpicUrl": "Hello, world!"
      },
      "modifiedDate": "Hello, world!",
      "name": "Hello, world!",
      "outputFile": "Hello, world!",
      "text": "Hello, world!",
      "type": "Hello, world!",
      "templateType": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "archiveTypes": {
            "type": "array",
            "description": "This archive types for this template."
          },
          "updatable": {
            "type": "boolean",
            "description": "`true`: The user who accessed can update this template. / `false`: The user who accessed cannot update this template."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this template."
              }
            },
            "description": "The site of this template."
          },
          "buildType": {
            "type": "string",
            "description": "The build type for this template. Available value is follows. `0`: never publish this template. / `1`: publish this template whenever its contents are updated or affected by a change. / `2`: publish this template when a publish request received. / `3`: publish this template on demand, but do not publish a file to the file system. / `4`: publish this template in the background. / `5`: currently not in use."
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of this template creator."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of this template creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this template creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            },
            "description": "Created user of this template."
          },
          "createdDate": {
            "type": "string",
            "description": "Created date of this template. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array",
            "description": "The list of customfields data of this template."
          },
          "id": {
            "type": "number",
            "description": "The ID for this template."
          },
          "linkToFie": {
            "type": "string",
            "description": "The linked output filename for this template."
          },
          "modifiedBy": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of this template modifier."
              },
              "displayName": {
                "type": "string",
                "description": "The display name of this template modifier."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this template modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            },
            "description": "Last modified user of this template."
          },
          "modifiedDate": {
            "type": "string",
            "description": "Last modified date of this template. (format is iso 8601 datetime)"
          },
          "name": {
            "type": "string",
            "description": "The name for this template."
          },
          "outputFile": {
            "type": "string",
            "description": "The output filename for this template."
          },
          "text": {
            "type": "string",
            "description": "The text for this template."
          },
          "type": {
            "type": "string",
            "description": "The type for this template."
          },
          "templateType": {
            "type": "string",
            "description": "The identifier for this template."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve the list of templates.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Create a new template
POST/sites/{site_id}/templates{?site_id}

Authentication required. Create a new template. This endpoint requires following permissions.

  • edit_templates (site level or system lebel)

Post form data is following.

  • template (Templatem, required) - Single template resource

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates?site_id=
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, that means global template in the system.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
template={ "name": "New Template", "text": "some template code here", "linkToFile": "", "type": "custom" }
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveTypes": [
    {
      "id": 1,
      "isPreferred": true,
      "fileTemplate": "Hello, world!",
      "archiveType": "Hello, world!",
      "buildType": "Hello, world!",
      "updatable": true
    }
  ],
  "updatable": true,
  "blog": {
    "id": 1
  },
  "buildType": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "id": 1,
  "linkToFie": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "outputFile": "Hello, world!",
  "text": "Hello, world!",
  "type": "Hello, world!",
  "templateType": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveTypes": {
      "type": "array",
      "description": "This archive types for this template."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this template. / `false`: The user who accessed cannot update this template."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this template."
        }
      },
      "description": "The site of this template."
    },
    "buildType": {
      "type": "string",
      "description": "The build type for this template. Available value is follows. `0`: never publish this template. / `1`: publish this template whenever its contents are updated or affected by a change. / `2`: publish this template when a publish request received. / `3`: publish this template on demand, but do not publish a file to the file system. / `4`: publish this template in the background. / `5`: currently not in use."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template creator."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Created user of this template."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this template. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this template."
    },
    "id": {
      "type": "number",
      "description": "The ID for this template."
    },
    "linkToFie": {
      "type": "string",
      "description": "The linked output filename for this template."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template modifier."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this template."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this template. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this template."
    },
    "outputFile": {
      "type": "string",
      "description": "The output filename for this template."
    },
    "text": {
      "type": "string",
      "description": "The text for this template."
    },
    "type": {
      "type": "string",
      "description": "The type for this template."
    },
    "templateType": {
      "type": "string",
      "description": "The identifier for this template."
    }
  }
}
Response  403
HideShow

Do not have permission to create a new templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Template

Fetch single template
GET/sites/{site_id}/templates/{template_id}{?fields}

Authentication required.

Retrieve a single template by its ID. This endpoint requires following permissions.

  • edit_templates (site level or system lebel)

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/template_id?fields=
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, that means a global template in the system.

template_id
number (required) 

The template ID.

fields
string (optional) 

The field list to retrieve as part of the Templates resource. The list of field names should be separated by commas. If this parameter is not specified, all fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveTypes": [
    {
      "id": 1,
      "isPreferred": true,
      "fileTemplate": "Hello, world!",
      "archiveType": "Hello, world!",
      "buildType": "Hello, world!",
      "updatable": true
    }
  ],
  "updatable": true,
  "blog": {
    "id": 1
  },
  "buildType": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "id": 1,
  "linkToFie": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "outputFile": "Hello, world!",
  "text": "Hello, world!",
  "type": "Hello, world!",
  "templateType": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveTypes": {
      "type": "array",
      "description": "This archive types for this template."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this template. / `false`: The user who accessed cannot update this template."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this template."
        }
      },
      "description": "The site of this template."
    },
    "buildType": {
      "type": "string",
      "description": "The build type for this template. Available value is follows. `0`: never publish this template. / `1`: publish this template whenever its contents are updated or affected by a change. / `2`: publish this template when a publish request received. / `3`: publish this template on demand, but do not publish a file to the file system. / `4`: publish this template in the background. / `5`: currently not in use."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template creator."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Created user of this template."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this template. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this template."
    },
    "id": {
      "type": "number",
      "description": "The ID for this template."
    },
    "linkToFie": {
      "type": "string",
      "description": "The linked output filename for this template."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template modifier."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this template."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this template. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this template."
    },
    "outputFile": {
      "type": "string",
      "description": "The output filename for this template."
    },
    "text": {
      "type": "string",
      "description": "The text for this template."
    },
    "type": {
      "type": "string",
      "description": "The type for this template."
    },
    "templateType": {
      "type": "string",
      "description": "The identifier for this template."
    }
  }
}
Response  403
HideShow

Do not have permission to fetch templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Update a template
PUT/sites/{site_id}/templates/{template_id}

Authentication required.

Update a template. This endpoint requires following permissions.

  • edit_templates (site level or system lebel)

Post form data is following.

  • template (Templatem, required) - Single template resource

This method accepts PUT or POST with __method=PUT.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/template_id
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, that means a global template in the system.

template_id
number (required) 

The template ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
template={ "name": "New Template" }
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveTypes": [
    {
      "id": 1,
      "isPreferred": true,
      "fileTemplate": "Hello, world!",
      "archiveType": "Hello, world!",
      "buildType": "Hello, world!",
      "updatable": true
    }
  ],
  "updatable": true,
  "blog": {
    "id": 1
  },
  "buildType": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "id": 1,
  "linkToFie": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "outputFile": "Hello, world!",
  "text": "Hello, world!",
  "type": "Hello, world!",
  "templateType": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveTypes": {
      "type": "array",
      "description": "This archive types for this template."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this template. / `false`: The user who accessed cannot update this template."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this template."
        }
      },
      "description": "The site of this template."
    },
    "buildType": {
      "type": "string",
      "description": "The build type for this template. Available value is follows. `0`: never publish this template. / `1`: publish this template whenever its contents are updated or affected by a change. / `2`: publish this template when a publish request received. / `3`: publish this template on demand, but do not publish a file to the file system. / `4`: publish this template in the background. / `5`: currently not in use."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template creator."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Created user of this template."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this template. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this template."
    },
    "id": {
      "type": "number",
      "description": "The ID for this template."
    },
    "linkToFie": {
      "type": "string",
      "description": "The linked output filename for this template."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template modifier."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this template."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this template. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this template."
    },
    "outputFile": {
      "type": "string",
      "description": "The output filename for this template."
    },
    "text": {
      "type": "string",
      "description": "The text for this template."
    },
    "type": {
      "type": "string",
      "description": "The type for this template."
    },
    "templateType": {
      "type": "string",
      "description": "The identifier for this template."
    }
  }
}
Response  403
HideShow

Do not have permission to update a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Delete a template
DELETE/sites/{site_id}/templates/{template_id}

Authentication required. Delete a template. This endpoint requires following permissions.

  • edit_templates (site level or system lebel)

This method accepts DELETE or POST with __method=DELETE.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/template_id
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, that means a global template in the system.

template_id
number (required) 

The template ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "archiveTypes": [
    {
      "id": 1,
      "isPreferred": true,
      "fileTemplate": "Hello, world!",
      "archiveType": "Hello, world!",
      "buildType": "Hello, world!",
      "updatable": true
    }
  ],
  "updatable": true,
  "blog": {
    "id": 1
  },
  "buildType": "Hello, world!",
  "createdBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "id": 1,
  "linkToFie": "Hello, world!",
  "modifiedBy": {
    "id": 1,
    "displayName": "Hello, world!",
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "outputFile": "Hello, world!",
  "text": "Hello, world!",
  "type": "Hello, world!",
  "templateType": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "archiveTypes": {
      "type": "array",
      "description": "This archive types for this template."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this template. / `false`: The user who accessed cannot update this template."
    },
    "blog": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of the site that contains this template."
        }
      },
      "description": "The site of this template."
    },
    "buildType": {
      "type": "string",
      "description": "The build type for this template. Available value is follows. `0`: never publish this template. / `1`: publish this template whenever its contents are updated or affected by a change. / `2`: publish this template when a publish request received. / `3`: publish this template on demand, but do not publish a file to the file system. / `4`: publish this template in the background. / `5`: currently not in use."
    },
    "createdBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template creator."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template creator."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Created user of this template."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this template. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this template."
    },
    "id": {
      "type": "number",
      "description": "The ID for this template."
    },
    "linkToFie": {
      "type": "string",
      "description": "The linked output filename for this template."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "id": {
          "type": "number",
          "description": "The ID of this template modifier."
        },
        "displayName": {
          "type": "string",
          "description": "The display name of this template modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this template modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this template."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this template. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The name for this template."
    },
    "outputFile": {
      "type": "string",
      "description": "The output filename for this template."
    },
    "text": {
      "type": "string",
      "description": "The text for this template."
    },
    "type": {
      "type": "string",
      "description": "The type for this template."
    },
    "templateType": {
      "type": "string",
      "description": "The identifier for this template."
    }
  }
}
Response  403
HideShow

Do not have permission to delete a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Publish template

Publish template
POST/sites/{site_id}/templates/{template_id}/publish

Authentication required. Publish (in other words rebuild) a template. This endpoint requires following permissions.

  • rebuild

Only available for following templates

  • index

  • archive

  • individual

  • page

  • category

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/template_id/publish
URI Parameters
HideShow
site_id
number (required) 

The site ID.

template_id
number (required) 

The template ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Result"
    }
  }
}
Response  400
HideShow

Cannot publish required template.

Headers
Content-Type: application/json
Response  403
HideShow

Do not have permission to publish a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Clone template

Clone template
POST/sites/{site_id}/templates/{template_id}/clone

Authentication required. Make a clone of a template. This endpoint requires following permissions.

  • edit_templates

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/template_id/clone
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, that means a global template in the system.

template_id
number (required) 

The template ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Result"
    }
  }
}
Response  403
HideShow

Do not have permission to publish a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Refresh template

Refresh template
POST/sites/{site_id}/templates/{template_id}/refresh

Authentication required. Reset template text to theme default or tempalte_set default. This endpoint requires following permissions.

  • edit_templates

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/template_id/refresh
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, refresh a global template in the system.

template_id
number (required) 

The template ID.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "messages": "Hello, world!",
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "messages": {
      "type": "string",
      "description": "Result message"
    },
    "status": {
      "type": "string",
      "description": "Result"
    }
  }
}
Response  403
HideShow

Do not have permission to publish a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Reset all template

Reset all template
POST/sites/{site_id}/refresh_templates{?refresh_type}

Authentication required. Reset all templates to default. This endpoint requires following permissions.

  • edit_templates

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/refresh_templates?refresh_type=refresh
URI Parameters
HideShow
site_id
number (required) 

The site ID. If 0 specified, refresh a global template in the system.

refresh_type
string (optional) Example: refresh

The type of refresh mode.

  • refresh: Refresh all templates. However, A template that created by user will never refreshed and never removed from a site.

  • clean: Refresh all templates. In this mode, A template that created by user will removed from a site.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Result"
    }
  }
}
Response  403
HideShow

Do not have permission to publish a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Make a preview by data

Make a preview by data
POST/sites/{site_id}/templates/preview{?raw}

Authentication required.

Make a template preview by specified data. This endpoint requires following permissions.

  • edit_templates

Post form data is following

  • template (Template, required) - The single template resource.

type parameter in the Templates resource is required.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/preview?raw=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
template={ "name": "New Template", "text": "some template code here", "type": "custom" }
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The result status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file."
    }
  }
}
Response  403
HideShow

Do not have permission to publish a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Make a preview by ID

Make a preview by ID
POST/sites/{site_id}/templates/{template_id}/preview{?raw}

Authentication required.

Make a template preview by ID. This endpoint requires following permissions.

  • edit_templates

Only available for following templates

  • index

  • archive

  • individual

  • page

  • category

  • template parameter is required. If you just want to get preview template from existing data, you should provide template parameter with empty json.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/templates/template_id/preview?raw=
URI Parameters
HideShow
site_id
number (required) 

The site ID.

template_id
number (required) 

The template ID.

raw
number (optional) 

If specify “1”, will be returned preview contents.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
Body
template=
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "Hello, world!",
  "preview": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "The resukt status of this call."
    },
    "preview": {
      "type": "string",
      "description": "The url of preview file."
    }
  }
}
Response  403
HideShow

Do not have permission to publish a templte.

Headers
Content-Type: application/json
Response  404
HideShow

Site or template not found.

Headers
Content-Type: application/json
Response  500
HideShow

Application runtime error.

Headers
Content-Type: application/json

Themes

Theme Collecion

Retrieve a list of themes
GET/themes

Authentication required Retrieve a list of all of the installed theme. This endpoint requires following permissions.

  • Manage Themes

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/themes
Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "authorLink": "Hello, world!",
      "authorName": "Hello, world!",
      "current": true,
      "description": "Hello, world!",
      "id": "Hello, world!",
      "inUse": true,
      "label": "Hello, world!",
      "uninstallable": true,
      "version": "Hello, world!"
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "authorLink": {
            "type": "string",
            "description": "The author link of this theme."
          },
          "authorName": {
            "type": "string",
            "description": "The author name of this theme."
          },
          "current": {
            "type": "boolean",
            "description": "***DEPRECATAD***"
          },
          "description": {
            "type": "string",
            "description": "The description for this theme."
          },
          "id": {
            "type": "string",
            "description": "The ID for this theme."
          },
          "inUse": {
            "type": "boolean",
            "description": "This property is displayed only in system scope.  `true`: This theme is in used by any site. / `false`: This theme is not in use."
          },
          "label": {
            "type": "string",
            "description": "The label for this theme."
          },
          "uninstallable": {
            "type": "boolean",
            "description": "`true`: This theme is able to uninstall. / `false`: This theme is not able to uninstall."
          },
          "version": {
            "type": "string",
            "description": "The version number for this theme."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve themes.

Headers
Content-Type: application/json

Theme

Fetch single theme.
GET/themes/{theme_id}

Authentication required

Retrieve a single theme by its ID. This endpoint requires following permissions.

  • Manage Themes

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/themes/jungfrau
URI Parameters
HideShow
theme_id
string (required) Example: jungfrau

The theme ID.

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "authorLink": "Hello, world!",
  "authorName": "Hello, world!",
  "current": true,
  "description": "Hello, world!",
  "id": "Hello, world!",
  "inUse": true,
  "label": "Hello, world!",
  "uninstallable": true,
  "version": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "authorLink": {
      "type": "string",
      "description": "The author link of this theme."
    },
    "authorName": {
      "type": "string",
      "description": "The author name of this theme."
    },
    "current": {
      "type": "boolean",
      "description": "***DEPRECATAD***"
    },
    "description": {
      "type": "string",
      "description": "The description for this theme."
    },
    "id": {
      "type": "string",
      "description": "The ID for this theme."
    },
    "inUse": {
      "type": "boolean",
      "description": "This property is displayed only in system scope.  `true`: This theme is in used by any site. / `false`: This theme is not in use."
    },
    "label": {
      "type": "string",
      "description": "The label for this theme."
    },
    "uninstallable": {
      "type": "boolean",
      "description": "`true`: This theme is able to uninstall. / `false`: This theme is not able to uninstall."
    },
    "version": {
      "type": "string",
      "description": "The version number for this theme."
    }
  }
}
Response  404
HideShow

Theme not found.

Headers
Content-Type: application/json

Uninstall theme
DELETE/themes/{theme_id}

Authentication required

Uninstall theme from MT.
When successful, you can take Theme Resource that was deleted. However, this theme is already removed from the Movable Type. You cannot apply this theme to.

This endpoint requires following permissions.

  • Manage Themes

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/themes/jungfrau
URI Parameters
HideShow
theme_id
string (required) Example: jungfrau

The theme ID.

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: appication/json
Body
{
  "authorLink": "Hello, world!",
  "authorName": "Hello, world!",
  "current": true,
  "description": "Hello, world!",
  "id": "Hello, world!",
  "inUse": true,
  "label": "Hello, world!",
  "uninstallable": true,
  "version": "Hello, world!"
}
Schema
{
  "type": "object",
  "properties": {
    "authorLink": {
      "type": "string",
      "description": "The author link of this theme."
    },
    "authorName": {
      "type": "string",
      "description": "The author name of this theme."
    },
    "current": {
      "type": "boolean",
      "description": "***DEPRECATAD***"
    },
    "description": {
      "type": "string",
      "description": "The description for this theme."
    },
    "id": {
      "type": "string",
      "description": "The ID for this theme."
    },
    "inUse": {
      "type": "boolean",
      "description": "This property is displayed only in system scope.  `true`: This theme is in used by any site. / `false`: This theme is not in use."
    },
    "label": {
      "type": "string",
      "description": "The label for this theme."
    },
    "uninstallable": {
      "type": "boolean",
      "description": "`true`: This theme is able to uninstall. / `false`: This theme is not able to uninstall."
    },
    "version": {
      "type": "string",
      "description": "The version number for this theme."
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow

Theme not found.

Headers
Content-Type: application/json

Apply theme

Apply theme
POST/sites/{site_id}/themes/{theme_id}/apply

Authentication required

Apply theme to site. This endpoint requires following permission.

  • Manage Themes

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/themes/theme_id/apply
URI Parameters
HideShow
site_id
number (required) 

The site ID.

theme_id
string (required) 

The theme ID.

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: appication/json
Body
{
  "status": "success"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Result"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow

Site or theme not found.

Headers
Content-Type: application/json

Export theme

Export theme
POST/sites/{site_id}/export_theme

Authentication required

Exporting current theme element as a new theme. This endpoint requires following permissions.

  • Manage Themes

This endpoint will export current theme elements of specified site into theme directory.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/sites/site_id/export_theme
URI Parameters
HideShow
site_id
number (required) 

The site ID.

Request
HideShow
Headers
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: appication/json
Body
{
  "status": "success"
}
Schema
{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Result"
    }
  },
  "$schema": "http://json-schema.org/draft-04/schema#"
}
Response  404
HideShow

Theme not found.

Headers
Content-Type: application/json

Users

User Collection

User Collection
GET/users{?search,searchFields,limit,offset,sortBy,sortOrder,fields,includeIds,excludeIds,status,lockout,dateField,dateFrom,dateTo}

Retrieve a list of users. This list does not include commenters.

Authentication required if you want to include inactive users or to get the private properties. Required permissions is follows.

  • System Administrator

  • Manage Users

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/users?search=&searchFields=name,displayName,email,url&limit=10&offset=0&sortBy=name&sortOrder=descend&fields=&includeIds=&excludeIds=&status=&lockout=&dateField=created_on&dateFrom=&dateTo=
URI Parameters
HideShow
search
string (optional) 

Search query.

searchFields
string (optional) Example: name,displayName,email,url

The comma separated field name list to search.

limit
number (optional) Example: 10

Maximum number of users to retrieve.

offset
number (optional) Example: 0

0-indexed offset.

sortBy
string (optional) Example: name

The field name for sort. You can specify one of following values

  • id

  • name

sortOrder
string (optional) Example: descend

  • descend (default): Return users in descending order.

  • ascend: Return users in ascending order.

fields
string (optional) 

The field list to retrieve as part of the Users resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

includeIds
string (optional) 

The comma separated ID list of users to include to result.

excludeIds
string (optional) 

The comma separated ID list of users to exclude from result.

status
string (optional) 

Filter by users’s status.

  • active: status is Active

  • disabled: status is Disabled.

  • pending: status is Pending

lockout
string (required) 

Filter by user’s lockout status.

  • locked_out: Locked out user only

  • not_locked_out: Not locked out user only

dateField
string (optional) Example: created_on

Specifies the field name to be used as a date field for filtering. (new in v3)

dateFrom
string (optional) 

The start date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

dateTo
string (optional) 

The end date to filtering. Specify in “YYYY-MM-DD” format. (new in v3)

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "totalResults": 1,
  "items": [
    {
      "allowComments": false,
      "allowTrackbacks": false,
      "assets": [
        {
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "fileExt": "",
          "filename": "",
          "id": 0,
          "label": "",
          "meta": {
            "fileSize": 0,
            "height": 0,
            "width": 0
          },
          "mimeType": "",
          "modifiedBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": {
            "id": 0
          },
          "tags": [],
          "updatable": false,
          "url": ""
        }
      ],
      "author": {
        "displayName": "",
        "id": 0,
        "userpicUrl": ""
      },
      "basename": "",
      "blog": {
        "id": 0
      },
      "body": "",
      "categories": [
        {
          "archiveLink": "",
          "basename": "",
          "blog": {
            "id": 0
          },
          "class": "",
          "createdBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "description": "",
          "id": 0,
          "label": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "updatable": false
        }
      ],
      "class": "",
      "commentCount": 0,
      "comments": [
        {
          "author": "",
          "blog": {
            "id": 0
          },
          "body": "",
          "createdBy": {
            "id": 0,
            "displayName": "",
            "userpicUrl": ""
          },
          "createdDate": "",
          "customFields": [
            {
              "basename": "",
              "value": ""
            }
          ],
          "date": "",
          "entry": {
            "id": 0
          },
          "id": 0,
          "link": "",
          "modifiedBy": {
            "displayName": "",
            "id": 0,
            "userpicUrl": ""
          },
          "modifiedDate": "",
          "parent": 0,
          "status": "",
          "updatable": false
        }
      ],
      "createdDate": "",
      "customFields": [
        {
          "basename": "",
          "value": ""
        },
        "basename",
        "value"
      ],
      "date": "",
      "excerpt": "",
      "format": "",
      "id": 0,
      "keywords": "",
      "modifiedDate": "",
      "more": "",
      "permalink": "",
      "pingsSentUrl": "",
      "status": "",
      "tags": [],
      "title": "",
      "trackbackCount": 0,
      "trackbacks": [],
      "unpublishedDate": ""
    }
  ]
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "totalResults": {
      "type": "number",
      "description": "Total record count of this request."
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "allowComments": {
            "type": "boolean",
            "description": "true: This entry accepts comments. In the database, this value is 1. false: This entry does not accepts comments. In the database, this value is 0."
          },
          "allowTrackbacks": {
            "type": "boolean",
            "description": "true: This entry accepts trackbacks. In the database, this value is 1. false: This entry does not accepts trackbacks. In the database, this value is 0."
          },
          "assets": {
            "type": "array",
            "description": "A list of asses that related with the enry."
          },
          "author": {
            "type": "object",
            "properties": {
              "displayName": {
                "type": "string",
                "description": "The display name of this entry creator."
              },
              "id": {
                "type": "number",
                "description": "The ID of this entry creator."
              },
              "userpicUrl": {
                "type": "string",
                "description": "The URL of this entry creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
              }
            }
          },
          "basename": {
            "type": "string",
            "description": "The basename for this entry."
          },
          "blog": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "description": "The ID of the site that contains this entry."
              }
            }
          },
          "body": {
            "type": "string",
            "description": "The contents of this entry that the text format is applied. [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "categories": {
            "type": "array",
            "description": "A list of categories associated with the entry. The first element of the array is the primary category. OTHER categories are sorted by label."
          },
          "class": {
            "type": "string",
            "description": "The object class for this entry."
          },
          "commentCount": {
            "type": "number",
            "description": "The number of comments for this entry."
          },
          "comments": {
            "type": "array",
            "description": "A list of comments for this entry. The list is sorted by ID of the comment and The parent ID of the comment."
          },
          "createdDate": {
            "type": "string",
            "description": "The created time for this entry. (format is iso 8601 datetime)"
          },
          "customFields": {
            "type": "array"
          },
          "date": {
            "type": "string",
            "description": "The published time for this entry. (format is iso 8601 datetime)"
          },
          "excerpt": {
            "type": "string",
            "description": "The excerpt value of this entry if one is specified or, if not, an auto-generated excerpt from the Entry Body field followed by an ellipsis (“…”). If an excerpt is auto-generated also note that any HTML is stripped. The length of the auto-generated output of this tag can be set in the site’s Entry Settings."
          },
          "format": {
            "type": "string",
            "description": "The text format of this entry."
          },
          "id": {
            "type": "number",
            "description": "The ID of this entry."
          },
          "keywords": {
            "type": "string",
            "description": "The keywords text for this entry."
          },
          "modifiedDate": {
            "type": "string",
            "description": "The last modified time for this entry. (format is iso 8601 datetime)"
          },
          "more": {
            "type": "string",
            "description": "The extended contents for this entry.  [update in v2] if you want to get the raw contents, you should sent a \"no_text_filter=1\" parameter with authenticated request."
          },
          "permalink": {
            "type": "string",
            "description": "The parmalink URL for this entry."
          },
          "pingsSentUrl": {
            "type": "string",
            "description": "A list of TrackBack pings sent from this entry."
          },
          "status": {
            "type": "string",
            "description": "Draft: This entry is saved as draft. entry_status is 1. Publish: This entry is published. entry_status is 2. Review: This entry is waiting for approval. entry_status is 3. Future: This entry is scheduled for future publishing. entry_status is 4. Spam: This entry is marked as Spam. entry_status is 5."
          },
          "tags": {
            "type": "array",
            "description": "A list of entry tags for this entry."
          },
          "title": {
            "type": "string",
            "description": "The title of this entry."
          },
          "trackbackCount": {
            "type": "number",
            "description": "The number of received trackbacks for this entry."
          },
          "trackbacks": {
            "type": "array",
            "description": "A list of received trackbacks for this entry. The list is sorted by the ID of trackback."
          },
          "unpublishedDate": {
            "type": "string",
            "description": "The unpublished time for this entry. (format is iso 8601 datetime)\n\nupdatable (boolean) - true: The user who accessed can update this entry. false: The user who accessed cannot update this entry."
          }
        }
      },
      "description": "The array of result content."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve users.

Headers
Content-Type: application/json

Create a new user
POST/users

Authentication required.

Create a new user. This endpoint requires following permissions.

  • System Administrtor

  • Manage Users

Post form data is follows.

  • user (User, required) - The single user resource.

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/users
Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
user={"email" : "aikawa@example.com","displayName" : "Ichiro Aikawa","name" : "aikawa","password":"password"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "apiPassword": "Hello, world!",
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "dateFormat": "Hello, world!",
  "displayName": "Hello, world!",
  "email": "Hello, world!",
  "id": 1,
  "isSuperuser": true,
  "language": "Hello, world!",
  "lockedOut": true,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "password": "Hello, world!",
  "updatable": true,
  "url": "Hello, world!",
  "userpicUrl": "Hello, world!",
  "status": "Hello, world!",
  "systemPermissions": [
    "Hello, world!"
  ],
  "tagDelimiter": "Hello, world!",
  "textFormat": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "apiPassword": {
      "type": "string",
      "description": "The web services password of this user.\n\ncreatedBy - Created user of this user.\n\n+ displayName (string) - The display name of this user creator.\n\n+ id (number) - The ID of this user creator.\n\n+ userpicUrl (string) - The URL of this user creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this user. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this user."
    },
    "dateFormat": {
      "type": "string",
      "description": "The date formatting for this user."
    },
    "displayName": {
      "type": "string",
      "description": "The public display name for this user."
    },
    "email": {
      "type": "string",
      "description": "The email address for this user."
    },
    "id": {
      "type": "number",
      "description": "The unique ID for this user."
    },
    "isSuperuser": {
      "type": "boolean",
      "description": "`true`: This user have permission for system administration. / `false`: This user does not have permission for system administration."
    },
    "language": {
      "type": "string",
      "description": "The preferred language for this user. Available values is follows. `de`, `en-us`, `es`, `fr`, `nl`, `ja`"
    },
    "lockedOut": {
      "type": "boolean",
      "description": "`true`: This user is currently locked out. / `false`: This user is not locked out."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this user modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this user modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this user modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this user."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this user. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The account name for this user. [update in v2] This column was changed to updatable from v2."
    },
    "password": {
      "type": "string",
      "description": "The password for this user. This property is write only."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this user. / `false`: The user who accessed cannot update this user."
    },
    "url": {
      "type": "string",
      "description": "The web site URL for this user."
    },
    "userpicUrl": {
      "type": "string",
      "description": "The profile photo URL for this user. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "status": {
      "type": "string",
      "description": "The status for this user. Available value is follows. `Active`: The status is active. The user can do anything within his/her permissions. / `Disabled`: The status is disabled. The user cannot do anything. / `Pending`: The status is pending. The user is waiting for approval by the administrator. Therefore, this user cannot do anything."
    },
    "systemPermissions": {
      "type": "array",
      "description": "The list of system permissions which this user have. Only system administrator can get this property"
    },
    "tagDelimiter": {
      "type": "string",
      "description": "The tag delimiter character for this user. Available value is follow. `comma`: Separator character is single comma. / `space`: Separator character is single space."
    },
    "textFormat": {
      "type": "string",
      "description": "The text formatting for this user."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve users.

Headers
Content-Type: application/json

User

Fetch single user
GET/users/{user_id}{?fields}

Fetch single user by its ID.

Authentication required if want to get inactive user or want to get the private properties. Required permissions is follows.

  • System Administrator

  • Manage Users

Example URI

GET http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id?fields=
URI Parameters
HideShow
user_id
string (required) 

The user ID or the word ‘me’.

fields
string (optional) 

The field list to retrieve as part of the Users resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "apiPassword": "Hello, world!",
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "dateFormat": "Hello, world!",
  "displayName": "Hello, world!",
  "email": "Hello, world!",
  "id": 1,
  "isSuperuser": true,
  "language": "Hello, world!",
  "lockedOut": true,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "password": "Hello, world!",
  "updatable": true,
  "url": "Hello, world!",
  "userpicUrl": "Hello, world!",
  "status": "Hello, world!",
  "systemPermissions": [
    "Hello, world!"
  ],
  "tagDelimiter": "Hello, world!",
  "textFormat": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "apiPassword": {
      "type": "string",
      "description": "The web services password of this user.\n\ncreatedBy - Created user of this user.\n\n+ displayName (string) - The display name of this user creator.\n\n+ id (number) - The ID of this user creator.\n\n+ userpicUrl (string) - The URL of this user creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this user. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this user."
    },
    "dateFormat": {
      "type": "string",
      "description": "The date formatting for this user."
    },
    "displayName": {
      "type": "string",
      "description": "The public display name for this user."
    },
    "email": {
      "type": "string",
      "description": "The email address for this user."
    },
    "id": {
      "type": "number",
      "description": "The unique ID for this user."
    },
    "isSuperuser": {
      "type": "boolean",
      "description": "`true`: This user have permission for system administration. / `false`: This user does not have permission for system administration."
    },
    "language": {
      "type": "string",
      "description": "The preferred language for this user. Available values is follows. `de`, `en-us`, `es`, `fr`, `nl`, `ja`"
    },
    "lockedOut": {
      "type": "boolean",
      "description": "`true`: This user is currently locked out. / `false`: This user is not locked out."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this user modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this user modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this user modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this user."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this user. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The account name for this user. [update in v2] This column was changed to updatable from v2."
    },
    "password": {
      "type": "string",
      "description": "The password for this user. This property is write only."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this user. / `false`: The user who accessed cannot update this user."
    },
    "url": {
      "type": "string",
      "description": "The web site URL for this user."
    },
    "userpicUrl": {
      "type": "string",
      "description": "The profile photo URL for this user. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "status": {
      "type": "string",
      "description": "The status for this user. Available value is follows. `Active`: The status is active. The user can do anything within his/her permissions. / `Disabled`: The status is disabled. The user cannot do anything. / `Pending`: The status is pending. The user is waiting for approval by the administrator. Therefore, this user cannot do anything."
    },
    "systemPermissions": {
      "type": "array",
      "description": "The list of system permissions which this user have. Only system administrator can get this property"
    },
    "tagDelimiter": {
      "type": "string",
      "description": "The tag delimiter character for this user. Available value is follow. `comma`: Separator character is single comma. / `space`: Separator character is single space."
    },
    "textFormat": {
      "type": "string",
      "description": "The text formatting for this user."
    }
  }
}
Response  403
HideShow

Do not have permission to retrieve users.

Headers
Content-Type: application/json
Response  404
HideShow

User not found.

Headers
Content-Type: application/json

Update user
PUT/users/{user_id}

Authentication required.

Update user. This endpoint requires following permissions if target user is not themselves.

  • System Administrator
  • Manage User

This method accepts PUT or POST with parameter ‘__method=PUT’.

Example URI

PUT http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id
URI Parameters
HideShow
user_id
string (required) 

The user ID or the word ‘me’.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Body
user={"displayName": "New Name"}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "apiPassword": "Hello, world!",
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "dateFormat": "Hello, world!",
  "displayName": "Hello, world!",
  "email": "Hello, world!",
  "id": 1,
  "isSuperuser": true,
  "language": "Hello, world!",
  "lockedOut": true,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "password": "Hello, world!",
  "updatable": true,
  "url": "Hello, world!",
  "userpicUrl": "Hello, world!",
  "status": "Hello, world!",
  "systemPermissions": [
    "Hello, world!"
  ],
  "tagDelimiter": "Hello, world!",
  "textFormat": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "apiPassword": {
      "type": "string",
      "description": "The web services password of this user.\n\ncreatedBy - Created user of this user.\n\n+ displayName (string) - The display name of this user creator.\n\n+ id (number) - The ID of this user creator.\n\n+ userpicUrl (string) - The URL of this user creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this user. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this user."
    },
    "dateFormat": {
      "type": "string",
      "description": "The date formatting for this user."
    },
    "displayName": {
      "type": "string",
      "description": "The public display name for this user."
    },
    "email": {
      "type": "string",
      "description": "The email address for this user."
    },
    "id": {
      "type": "number",
      "description": "The unique ID for this user."
    },
    "isSuperuser": {
      "type": "boolean",
      "description": "`true`: This user have permission for system administration. / `false`: This user does not have permission for system administration."
    },
    "language": {
      "type": "string",
      "description": "The preferred language for this user. Available values is follows. `de`, `en-us`, `es`, `fr`, `nl`, `ja`"
    },
    "lockedOut": {
      "type": "boolean",
      "description": "`true`: This user is currently locked out. / `false`: This user is not locked out."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this user modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this user modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this user modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this user."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this user. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The account name for this user. [update in v2] This column was changed to updatable from v2."
    },
    "password": {
      "type": "string",
      "description": "The password for this user. This property is write only."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this user. / `false`: The user who accessed cannot update this user."
    },
    "url": {
      "type": "string",
      "description": "The web site URL for this user."
    },
    "userpicUrl": {
      "type": "string",
      "description": "The profile photo URL for this user. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "status": {
      "type": "string",
      "description": "The status for this user. Available value is follows. `Active`: The status is active. The user can do anything within his/her permissions. / `Disabled`: The status is disabled. The user cannot do anything. / `Pending`: The status is pending. The user is waiting for approval by the administrator. Therefore, this user cannot do anything."
    },
    "systemPermissions": {
      "type": "array",
      "description": "The list of system permissions which this user have. Only system administrator can get this property"
    },
    "tagDelimiter": {
      "type": "string",
      "description": "The tag delimiter character for this user. Available value is follow. `comma`: Separator character is single comma. / `space`: Separator character is single space."
    },
    "textFormat": {
      "type": "string",
      "description": "The text formatting for this user."
    }
  }
}
Response  403
HideShow

Do not have permission to update user.

Headers
Content-Type: application/json
Response  404
HideShow

User not found.

Headers
Content-Type: application/json
Response  405
HideShow

Request method is not ‘PUT’ or ‘POST’ with ‘__method=PUT’

Headers
Content-Type: application/json

Delete user.
DELETE/users/{user_id}

Authentication required.

Delete user. This endpoint requires following permissions.

  • System Administrator
  • Manage User
  • This method accepts DELETE and POST with __method=DELETE.
  • Cannot delete themselves. Also, cannot delete system administrator.

Example URI

DELETE http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id
URI Parameters
HideShow
user_id
string (required) 

The user ID or the word ‘me’.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "apiPassword": "Hello, world!",
  "createdDate": "Hello, world!",
  "customFields": [
    {
      "basename": "Hello, world!",
      "value": "Hello, world!"
    }
  ],
  "dateFormat": "Hello, world!",
  "displayName": "Hello, world!",
  "email": "Hello, world!",
  "id": 1,
  "isSuperuser": true,
  "language": "Hello, world!",
  "lockedOut": true,
  "modifiedBy": {
    "displayName": "Hello, world!",
    "id": 1,
    "userpicUrl": "Hello, world!"
  },
  "modifiedDate": "Hello, world!",
  "name": "Hello, world!",
  "password": "Hello, world!",
  "updatable": true,
  "url": "Hello, world!",
  "userpicUrl": "Hello, world!",
  "status": "Hello, world!",
  "systemPermissions": [
    "Hello, world!"
  ],
  "tagDelimiter": "Hello, world!",
  "textFormat": "Hello, world!"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "apiPassword": {
      "type": "string",
      "description": "The web services password of this user.\n\ncreatedBy - Created user of this user.\n\n+ displayName (string) - The display name of this user creator.\n\n+ id (number) - The ID of this user creator.\n\n+ userpicUrl (string) - The URL of this user creator's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "createdDate": {
      "type": "string",
      "description": "Created date of this user. (format is iso 8601 datetime)"
    },
    "customFields": {
      "type": "array",
      "description": "The list of customfields data of this user."
    },
    "dateFormat": {
      "type": "string",
      "description": "The date formatting for this user."
    },
    "displayName": {
      "type": "string",
      "description": "The public display name for this user."
    },
    "email": {
      "type": "string",
      "description": "The email address for this user."
    },
    "id": {
      "type": "number",
      "description": "The unique ID for this user."
    },
    "isSuperuser": {
      "type": "boolean",
      "description": "`true`: This user have permission for system administration. / `false`: This user does not have permission for system administration."
    },
    "language": {
      "type": "string",
      "description": "The preferred language for this user. Available values is follows. `de`, `en-us`, `es`, `fr`, `nl`, `ja`"
    },
    "lockedOut": {
      "type": "boolean",
      "description": "`true`: This user is currently locked out. / `false`: This user is not locked out."
    },
    "modifiedBy": {
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "The display name of this user modifier."
        },
        "id": {
          "type": "number",
          "description": "The ID of this user modifier."
        },
        "userpicUrl": {
          "type": "string",
          "description": "The URL of this user modifier's userpic. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
        }
      },
      "description": "Last modified user of this user."
    },
    "modifiedDate": {
      "type": "string",
      "description": "Last modified date of this user. (format is iso 8601 datetime)"
    },
    "name": {
      "type": "string",
      "description": "The account name for this user. [update in v2] This column was changed to updatable from v2."
    },
    "password": {
      "type": "string",
      "description": "The password for this user. This property is write only."
    },
    "updatable": {
      "type": "boolean",
      "description": "`true`: The user who accessed can update this user. / `false`: The user who accessed cannot update this user."
    },
    "url": {
      "type": "string",
      "description": "The web site URL for this user."
    },
    "userpicUrl": {
      "type": "string",
      "description": "The profile photo URL for this user. The userpic will be made by UserpicThumbnailSize and UserpicAllowRect settings. If user does not set own userpic, will be returned empty string."
    },
    "status": {
      "type": "string",
      "description": "The status for this user. Available value is follows. `Active`: The status is active. The user can do anything within his/her permissions. / `Disabled`: The status is disabled. The user cannot do anything. / `Pending`: The status is pending. The user is waiting for approval by the administrator. Therefore, this user cannot do anything."
    },
    "systemPermissions": {
      "type": "array",
      "description": "The list of system permissions which this user have. Only system administrator can get this property"
    },
    "tagDelimiter": {
      "type": "string",
      "description": "The tag delimiter character for this user. Available value is follow. `comma`: Separator character is single comma. / `space`: Separator character is single space."
    },
    "textFormat": {
      "type": "string",
      "description": "The text formatting for this user."
    }
  }
}
Response  403
HideShow

Do not have permission to delete user.

Headers
Content-Type: application/json
Response  404
HideShow

User not found.

Headers
Content-Type: application/json
Response  405
HideShow

Request method is not ‘DELETE’ or ‘POST’ with ‘__method=DELETE’

Headers
Content-Type: application/json

Unlock user

Unlock user
POST/users/{user_id}/unlock

Authentication required. Unlock user account. This endppoint requires followint permission.

  • System Administrator

Example URI

POST http://your-host/path-to-mt/mt-data-api.cgi/v4/users/user_id/unlock
URI Parameters
HideShow
user_id
number (required) 

The user ID.

Request
HideShow
Headers
Content-Type: application/x-www-form-urlencoded
X-MT-Authorization: MTAuth accessToken=<Token>
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "success"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Result"
    }
  }
}
Response  403
HideShow

Do not have permission to unlock user.

Headers
Content-Type: application/json
Response  404
HideShow

User not found.

Headers
Content-Type: application/json

Generated by aglio on 10 Feb 2022