API docs by Redocly

Movable Type Data API (r.5404)

Download OpenAPI specification:Download

Find out more about Movable Type Data API

Assets

Upload a file

Permissions

  • upload
Authorizations:
mtauth
query Parameters
overwrite_once
integer
Enum: 0 1

If specify "1", the API always overwrites an existing file with the uploaded file. This parameter has been available since Movable Type 6.1.2

Request Body schema: multipart/form-data
autoRenameIfExists
integer
Default: 0
Enum: 0 1

If this value is "1" and a file with the same filename exists, the uploaded file is automatically renamed to a random generated name. Default is "0".

autoRenameNonAscii
integer
Enum: 0 1

If this value is "1", the filename is renamed non-ascii filename automatically

file
string <binary>

Actual file data

normalizeOrientation
integer
Default: 1
Enum: 0 1

If this value is "1" and the uploaded file has orientation information in Exif data, this file's orientation is automatically normalized. Default is "1".

path
string

The upload destination. You can specify the path to the under the site path.

site_id
integer

The site ID.

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "fileExtension": "string",
  • "filePath": "string",
  • "filename": "string",
  • "id": 0,
  • "label": "string",
  • "meta": {
    },
  • "mimeType": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": {
    },
  • "tags": [
    ],
  • "type": "string",
  • "updatable": true,
  • "url": "string"
}

Retrieve assets in the specified site

path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label"

The comma separated field name list to search.

Default: label

limit
integer
Default: "10"

Maximum number of assets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

class
string

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
Default: "created_on"
Enum: "file_name" "created_by" "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.

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return assets in descending order.

ascend

Return assets in ascending order.

Default: descend

fields
string

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

relatedAssets
integer
Enum: 0 1

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
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Upload a file Deprecated

This endpoint is marked as deprecated in v2.0.

Upload single file to specific site.

Permissions

  • upload
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: multipart/form-data
autoRenameIfExists
integer
Enum: 0 1

If this value is "1" and the file with the same filename exists, the uploaded file is automatically renamed to the random generated name. Default is "0".

file
string <binary>

The actual file data

normalizeOrientation
integer
Enum: 0 1

If this value is "1" and the uploaded file has a orientation information in Exif, this file's orientation is automatically normalized. Default is "1".

path
string

The upload destination. You can specify the path to the under the site path.

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "fileExtension": "string",
  • "filePath": "string",
  • "filename": "string",
  • "id": 0,
  • "label": "string",
  • "meta": {
    },
  • "mimeType": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": {
    },
  • "tags": [
    ],
  • "type": "string",
  • "updatable": true,
  • "url": "string"
}

Delete an asset

  • Authorization is required.

Permissions

  • Manage Assets

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
asset_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "fileExtension": "string",
  • "filePath": "string",
  • "filename": "string",
  • "id": 0,
  • "label": "string",
  • "meta": {
    },
  • "mimeType": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": {
    },
  • "tags": [
    ],
  • "type": "string",
  • "updatable": true,
  • "url": "string"
}

Retrieve single asset by its ID

path Parameters
site_id
required
integer
asset_id
required
integer
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "fileExtension": "string",
  • "filePath": "string",
  • "filename": "string",
  • "id": 0,
  • "label": "string",
  • "meta": {
    },
  • "mimeType": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": {
    },
  • "tags": [
    ],
  • "type": "string",
  • "updatable": true,
  • "url": "string"
}

Update an asset

  • Authorization is required.

Permissions

  • Manage Assets

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
asset_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (asset_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "fileExtension": "string",
  • "filePath": "string",
  • "filename": "string",
  • "id": 0,
  • "label": "string",
  • "meta": {
    },
  • "mimeType": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": {
    },
  • "tags": [
    ],
  • "type": "string",
  • "updatable": true,
  • "url": "string"
}

Retrieve a list of entries that related with specific asset

  • Authorization is required to include unpublished entries.

Permissions

  • edit_entry
    • to retrieve unpublished entry
path Parameters
site_id
required
integer
asset_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of entries to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "authored_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: authored_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return entries in descending order.

ascend

Return entries in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

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.

Unpublish

entry_status is 6.

maxComments
integer

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
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of pages that related with specific asset

  • Authorization is required to include unpublished pages.

Permissions

  • manage_pages
    • to retrieve unpublished page
path Parameters
site_id
required
integer
asset_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of pages to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "modified_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: modified_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return pages in descending order.

ascend

Return pages in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

Filter by container page'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.

Unpublish

entry_status is 6.

maxComments
integer

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

maxTrackbacks
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Get thumbnail of an asset

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

path Parameters
site_id
required
integer
asset_id
required
integer
query Parameters
width
integer

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
integer

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
string

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

square
integer
Enum: 0 1

If set to "1" 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.

Responses

Response samples

Content type
application/json
{
  • "height": 0,
  • "url": "string",
  • "width": 0
}

Retrieve assets that related with specified entry

path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of assets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

class
string

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
Default: "created_on"
Enum: "file_name" "created_by" "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.

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return assets in descending order.

ascend

Return assets in ascending order.

Default: descend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve assets that related with specified page

path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of assets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

class
string

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
Default: "created_on"
Enum: "file_name" "created_by" "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.

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return assets in descending order.

ascend

Return assets in ascending order.

Default: descend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve assets that related with specified tag

path Parameters
site_id
required
integer
tag_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of assets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

class
string

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
Default: "created_on"
Enum: "file_name" "created_by" "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.

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return assets in descending order.

ascend

Return assets in ascending order.

Default: descend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Authentication

Invalidate current access token. This is not logout

Invalidate current session. This is like logout. All access tokens related to that session are invalidated too.

Authorization is required. but if there is an effective session, user can revoke by the following methods.

In the case of a web browser, can be authorized by httponly-cookie.

In the case of other than a browser, can be authorized by sending a sessionId that is retrieved via authentication endpoints in MTAuth request header.

MTAuth sessionId={retrieved sessionId}

Notes

  • This method accepts DELETE and POST with __method=DELETE.
header Parameters
X-MT-Authorization
string

Input MTAuth sessionId={sessionId}

Request Body schema: application/x-www-form-urlencoded
clientId
string

This is not required if you specify session id via "X-MT-Authorization" request header. You can create new access token if you have a session id related to this clientId, although you do not have an access token.

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

User authentication by username and password

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

Request Body schema: application/x-www-form-urlencoded
clientId
string

This is not required if you specify session id via "X-MT-Authorization" request header. You can create new access token if you have a session id related to this clientId, although you do not have an access token.

mtDataApiLoginMagicToken
string

This is not required if you authenticate except via browser. If this parameter is passed and valid the MT will set cookie in order to start a session.

password
string <password>

Your Web Service Password

remember
integer
Enum: 0 1

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.

username
string

Your Sign-in Name

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresIn": 0,
  • "remember": true,
  • "sessionId": "string"
}

Return authorization(login) form as HTML

Return authorization(login) form as HTML.

query Parameters
redirectUrl
required
string

This is required. When you succeed in login, you are redirected to the redirectUrl with "#_login".

clientId
required
string

This is required. the client ID of the application.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Invalidate current session. This is like logout

Invalidate current access token. This is not logout. If the browser has active session id, new access token can be obtained easily.

Authorization is required.

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Create new access token related to current session

Create new access token related to current session.

In order to create new access token, in the case of a web browser, it is necessary to create session via authentication endpoints beforehand.

In the case of other than a browser, it is necessary to send a sessionId that is retrieved via authentication endpoints in MTAuth request header.

MTAuth sessionId={retrieved sessionId}

header Parameters
X-MT-Authorization
string

Input MTAuth sessionId={sessionId}

Request Body schema: application/x-www-form-urlencoded
clientId
string

This is not required if you specify session id via "X-MT-Authorization" request header. You can create new access token if you have a session id related to this clientId, although you do not have an access token.

Responses

Response samples

Content type
application/json
{
  • "accessToken": "string",
  • "expiresIn": 0
}

BackupRestore

Backup specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "backupFiles": [
    ],
  • "status": "string"
}

Categories

Retrieve categories in the specified site

path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,basename"

The comma separated field name list to search.

Default: label,basename

limit
integer
Default: "10"

Maximum number of categories to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "user_custom"
Enum: "user_custom" "created_by" "id" "basename" "label"

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.

Default: user_custom

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return categories in descending order.

ascend

Return categories in ascending order.

Default: descend

fields
string

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

top
integer
Default: 0
Enum: 0 1

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

Default: 0

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new category

Authorization is required.

Permission

  • Manage Categories
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Rearrange existing categories in a new order

  • Authorization is required.
  • This method returns rearranged Categories resource.

Permission

  • Manage Categories
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
categories
string

Array of category resource that were rearranged.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete an existing category

  • Authorization is required.
  • This method returns deleted Category resource.

Permission

  • Manage Categories

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Retrieve single category by its ID

path Parameters
site_id
required
integer
category_id
required
integer
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Update an existing category

  • Authorization is required.

Permission

  • Manage Categories

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Retrieve child categories from the specified category

path Parameters
site_id
required
integer
category_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

Default: 0

includeCurrent
integer
Default: 0
Enum: 0 1

1

The list does not include current category.

0

The list includes current category.

Default: 0

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of entries by specific category

  • Authorization is required to include unpublished entries.

Permissions

  • edit_entry
    • to retrieve unpublished entry
path Parameters
site_id
required
integer
category_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of entries to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "authored_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: authored_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return entries in descending order.

ascend

Return entries in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

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.

Unpublish

entry_status is 6.

maxComments
integer

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
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve parent categories from the specified category

path Parameters
site_id
required
integer
category_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

Default: 0

includeCurrent
integer
Default: 0
Enum: 0 1

1

The list does not include current category.

0

The list includes current category.

Default: 0

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve siblings categories from the specified category

path Parameters
site_id
required
integer
category_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,basename"

The comma separated field name list to search.

Default: label,basename

limit
integer
Default: "10"

Maximum number of categories to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "user_custom"
Enum: "user_custom" "created_by" "id" "basename" "label"

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.

Default: user_custom

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return categories in descending order.

ascend

Return categories in ascending order.

Default: descend

fields
string

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

top
integer
Default: 0
Enum: 0 1

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

Default: 0

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Category Collection for category set

Retrieve list of categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

includeCurrent
integer
Default: 0
Enum: 0 1
  • 1: The list does not include current category.
  • 0: The list includes current category.
dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new category for category set

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
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Save hierarchical categories order in category set

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.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
Request Body schema: application/x-www-form-urlencoded
categories
string

Array of category resource that were rearranged.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete single category in category set

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Category Set

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Fetch single category in category set

Retrieve a single category by its ID.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Update single category in category set

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Categoy Set

Post form data is following:

  • category (Category) - Category resource

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Category Collection of child categories for category set

Retrieve list of child categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

includeCurrent
integer
Default: 0
Enum: 0 1
  • 1: The list does not include current category.
  • 0: The list includes current category.
header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Category Collection of parent categories for category set

Retrieve list of parent categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

includeCurrent
integer
Default: 0
Enum: 0 1
  • 1: The list does not include current category.
  • 0: The list includes current category.
header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Category Collection of sibling categories for category set

Retrieve list of sibling categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,basename"

The comma separated field name list to search.

Default: label,basename

limit
integer
Default: "10"

Maximum number of categories to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "user_custom"
Enum: "user_custom" "created_by" "id" "basename" "label"
  • 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
Default: "descend"
Enum: "descend" "ascend"

descend

Return categories in descending order.

ascend

Return categories in ascending order.

Default: descend

fields
string

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

top
integer
Default: 0
Enum: 0 1

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve categories in the specified entry

Permissions

  • edit_entry
    • If you want to retrieve the non-published entry's categories.
path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,basename"

The comma separated field name list to search.

Default: label,basename

limit
integer
Default: "10"

Maximum number of categories to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "user_custom"
Enum: "user_custom" "created_by" "id" "basename" "label"

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.

Default: user_custom

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return categories in descending order.

ascend

Return categories in ascending order.

Default: descend

fields
string

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

top
integer
Default: 0
Enum: 0 1

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

Default: 0

includeIds
string

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

excludeIds
string

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

type
string
Enum: "primary" "secondary"

primary

Retrieve primary category only

secondary

Retrieve secondary categories only

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Category Sets

Category Set Collection

Retrieve list of category set in the specified site. Authentication required if you want retrieve private field in categorySet resource. Required permissions are as 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.)
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name"

The comma separated field name list to search.

Default: name

limit
integer
Default: "25"

Maximum number of category_sets to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"
Enum: "id" "name" "created_on" "modified_on" "content_type_count"

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

  • id
  • name
  • created_on
  • modified_on
  • content_type_count
sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return category_sets in descending order.

ascend

Return category_sets in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new category set

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
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_set_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "categories": [
    ],
  • "contentTypeCount": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updatable": true
}

Delete category set

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

  • Manage Category Set

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "categories": [
    ],
  • "contentTypeCount": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updatable": true
}

Fetch single category set

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

  • Manage Category Set
path Parameters
site_id
required
integer
category_set_id
required
integer
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "categories": [
    ],
  • "contentTypeCount": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updatable": true
}

Update category set

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.

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_set_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "categories": [
    ],
  • "contentTypeCount": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "updatable": true
}

Category Collection for category set

Retrieve list of categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

includeCurrent
integer
Default: 0
Enum: 0 1
  • 1: The list does not include current category.
  • 0: The list includes current category.
dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new category for category set

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
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Save hierarchical categories order in category set

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.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
Request Body schema: application/x-www-form-urlencoded
categories
string

Array of category resource that were rearranged.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete single category in category set

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Category Set

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Fetch single category in category set

Retrieve a single category by its ID.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Update single category in category set

Authentication required.

Update an existing category. This endpoint need folllowing permissions.

  • Manage Categoy Set

Post form data is following:

  • category (Category) - Category resource

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (category_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "updatable": true
}

Category Collection of child categories for category set

Retrieve list of child categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

includeCurrent
integer
Default: 0
Enum: 0 1
  • 1: The list does not include current category.
  • 0: The list includes current category.
header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Category Collection of parent categories for category set

Retrieve list of parent categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent categories.

includeCurrent
integer
Default: 0
Enum: 0 1
  • 1: The list does not include current category.
  • 0: The list includes current category.
header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Category Collection of sibling categories for category set

Retrieve list of sibling categories of the specified category set.

path Parameters
site_id
required
integer
category_set_id
required
integer
category_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,basename"

The comma separated field name list to search.

Default: label,basename

limit
integer
Default: "10"

Maximum number of categories to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "user_custom"
Enum: "user_custom" "created_by" "id" "basename" "label"
  • 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
Default: "descend"
Enum: "descend" "ascend"

descend

Return categories in descending order.

ascend

Return categories in ascending order.

Default: descend

fields
string

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

top
integer
Default: 0
Enum: 0 1

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Comments

Retrieve a list of comments

Retrieve a list of comments.

Authorization is required to include unpublished comments

path Parameters
site_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of comments to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

includeIds
string

This is an optional parameter. The comma separated ID list of comments to include to result.

excludeIds
string

This is an optional parameter. The comma separated ID list of comments to exclude from result.

status
string
Enum: "Approved" "Pending" "Spam"

This is an optional parameter. 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
Enum: "Draft" "Publish" "Review" "Future" "Spam"

This is an optional parameter. Filter by parent 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
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Delete a comment

Delete a comment.

Authorization is required.

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
comment_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Retrieve a single comment by its ID

Retrieve a single comment by its ID.

Authorization is required if the comment status is "unpublished". If the comment status is "published", then this method can be called without authorization.

path Parameters
site_id
required
integer
comment_id
required
integer
header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Update a comment

Update a comment.

Authorization is required.

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
comment_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Retrieve a list of comments for an entry

Retrieve a list of comments for an entry.

Authorization is required to include unpublished comments

path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of comments to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new comment on an entry

Create a new comment on an entry.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
entry_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Reply to specified comment

Reply to specified comment.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Retrieve a list of comments for the specified page

Retrieve a list of comments for a page.

Authorization is required to include unpublished comments

path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of comments to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new comment on a page

Create a new comment on a page.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
page_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Reply to specified comment

Reply to specified comment.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
page_id
required
integer
comment_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Common API

Retrieve OpenAPI schema

Responses

Response samples

Content type
application/json
{ }

Get server API version

Retrieves Data API version of the server.

This endpoint has been available since Movable Type 6.2.4.

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

Responses

Response samples

Content type
application/json
{
  • "apiVersion": 0,
  • "endpointVersion": "string"
}

Content Data

Publish Content Data

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

  • Manage Content Data (site, sistem, each content type)
  • Edit All Content Data (each content type)
Authorizations:
mtauth
query Parameters
blogId
integer

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

blogIds
string

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

ids
string

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

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.

Responses

Response samples

Content type
application/json
{
  • "restIds": "string",
  • "startTime": "string",
  • "status": "string"
}

Content Data Collection

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

Authentication required if you want to retrieve unpublished content data. Required pemissions are as follows.

  • Manage Content Data (site, system, each content type)
  • Publish Content Data (each content type)
  • Edit All Content Data (each content type)
path Parameters
site_id
required
integer
content_type_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of content_data to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "id"
Enum: "id" "uniqueID" "authored_on" "created_on" "modified_on"

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

  • id
  • uniqueID
  • authored_on
  • created_on
  • modified_on
sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return content_data in descending order.

ascend

Return content_data in ascending order.

Default: descend

fields
string

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

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

excludeIds
string

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

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create Content Data

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

  • Manage Content Data (site, system, 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 contain its data.
  • If content type contains non required Date and Time field, request will failed when post data does not contain its data.
  • Date and Time field must be specified by YYYYMMDDHHmmSS format.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cd_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Make a preview by data

Authentication required.

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

  • Manage Content Data (site, system, 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 contain its data.
  • If content type contains non required Date and Time field, request will failed when post data does not contain its data.
  • Date and Time field must be specified by YYYYMMDDHHmmSS format.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (cd)

Updatable fields are basename, data, date, status, unpublishedDate, label

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Delete single content data

Authentication required.

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

  • Manage Content Data (site, system, each content type)
  • Edit All Content Data (each content type)
  • Publish Content Data (each content type)

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Fetch single Content Data

Fetch single content data.

Authentication required if you want fetch unpublished content data. Required permissions are as follows.

  • Manage Content Data (site, system, each content type)
  • Edit All Content Data (each content type)
  • Publish Content Data (each content type)
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer
query Parameters
fields
string

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.

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Update Content Data

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

  • Manage Content Data (site, system, 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.

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cd_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Make a preview by id

Authentication required.

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

  • Content Data (site, system, each content type)
  • Create Content Data (each content type)

Post form data is as 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 contain its data.
  • If content type contains non required Date and Time field, request will failed when post data does not contain its data.
  • Date and Time field must be specified by YYYYMMDDHHmmSS format.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (cd)

Updatable fields are basename, data, date, status, unpublishedDate, label

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Content Fields

Content Field Collection

Authentication required

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

  • Manage Content Types
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of content_fields to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Enum: "name" "dataLabel" "uniqueID" "modified_on"

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

  • name
  • dataLabel
  • uniqueID
  • modified_on
sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return content_fields in descending order.

ascend

Return content_fields in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create Content Field

Authentication required

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

  • Manage Content Types

Post form data is as follows.

  • content_field (required, ContentField) - Single Content Field resource
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cf_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

Save hierarchical content field order

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.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
Request Body schema: application/x-www-form-urlencoded
content_fields
string

Array of content fields resource that were rearranged.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Content Field

Authentication required

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

  • Manage Content Types

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_field_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

Fetch single Content Field

Authentication required

Fetch single content field. This endpoint requires following permission.

  • Manage Content Types
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_field_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

Update Content Field

Authentication required

Update content field. This endpoint requires following permission.

  • Manage Content Types

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

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_field_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cf_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

Content Types

Content Type Collection

Authentication required

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

  • Manage Content Types
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of content_types to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Enum: "name" "dataLabel" "uniqueID" "modified_on"

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

  • name
  • dataLabel
  • uniqueID
  • modified_on
sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return content_types in descending order.

ascend

Return content_types in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create Content Type

Authentication required

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

  • Manage Content Types

Post form data is as follows.

  • content_type (required, ContentType) - Single Content Type resource
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (content_type_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "contentFields": [
    ],
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "dataLabel": "string",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "uniqueID": "string",
  • "updatable": true,
  • "userDisplayOption": true
}

Delete Content Type

Authentication required

Delete content type. This endpoint requires following permission.

  • Manage Content Types

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "contentFields": [
    ],
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "dataLabel": "string",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "uniqueID": "string",
  • "updatable": true,
  • "userDisplayOption": true
}

Fetch single Content Type

Authentication required

Fetch single content type. This endpoint requires following permission.

  • Manage Content Types
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "contentFields": [
    ],
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "dataLabel": "string",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "uniqueID": "string",
  • "updatable": true,
  • "userDisplayOption": true
}

Update Content Type

Authentication required

Update content type. This endpoint requires following permission.

  • Manage Content Types

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (content_type_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "contentFields": [
    ],
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "dataLabel": "string",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "uniqueID": "string",
  • "updatable": true,
  • "userDisplayOption": true
}

Content Data Collection

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

Authentication required if you want to retrieve unpublished content data. Required pemissions are as follows.

  • Manage Content Data (site, system, each content type)
  • Publish Content Data (each content type)
  • Edit All Content Data (each content type)
path Parameters
site_id
required
integer
content_type_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of content_data to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "id"
Enum: "id" "uniqueID" "authored_on" "created_on" "modified_on"

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

  • id
  • uniqueID
  • authored_on
  • created_on
  • modified_on
sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return content_data in descending order.

ascend

Return content_data in ascending order.

Default: descend

fields
string

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

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

excludeIds
string

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

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create Content Data

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

  • Manage Content Data (site, system, 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 contain its data.
  • If content type contains non required Date and Time field, request will failed when post data does not contain its data.
  • Date and Time field must be specified by YYYYMMDDHHmmSS format.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cd_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Make a preview by data

Authentication required.

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

  • Manage Content Data (site, system, 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 contain its data.
  • If content type contains non required Date and Time field, request will failed when post data does not contain its data.
  • Date and Time field must be specified by YYYYMMDDHHmmSS format.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (cd)

Updatable fields are basename, data, date, status, unpublishedDate, label

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Delete single content data

Authentication required.

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

  • Manage Content Data (site, system, each content type)
  • Edit All Content Data (each content type)
  • Publish Content Data (each content type)

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Fetch single Content Data

Fetch single content data.

Authentication required if you want fetch unpublished content data. Required permissions are as follows.

  • Manage Content Data (site, system, each content type)
  • Edit All Content Data (each content type)
  • Publish Content Data (each content type)
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer
query Parameters
fields
string

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.

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Update Content Data

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

  • Manage Content Data (site, system, 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.

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cd_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "data": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "label": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "permalink": "string",
  • "status": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Make a preview by id

Authentication required.

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

  • Content Data (site, system, each content type)
  • Create Content Data (each content type)

Post form data is as 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 contain its data.
  • If content type contains non required Date and Time field, request will failed when post data does not contain its data.
  • Date and Time field must be specified by YYYYMMDDHHmmSS format.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_data_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (cd)

Updatable fields are basename, data, date, status, unpublishedDate, label

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Content Field Collection

Authentication required

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

  • Manage Content Types
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of content_fields to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Enum: "name" "dataLabel" "uniqueID" "modified_on"

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

  • name
  • dataLabel
  • uniqueID
  • modified_on
sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return content_fields in descending order.

ascend

Return content_fields in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create Content Field

Authentication required

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

  • Manage Content Types

Post form data is as follows.

  • content_field (required, ContentField) - Single Content Field resource
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cf_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

Save hierarchical content field order

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.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
Request Body schema: application/x-www-form-urlencoded
content_fields
string

Array of content fields resource that were rearranged.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete Content Field

Authentication required

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

  • Manage Content Types

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_field_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

Fetch single Content Field

Authentication required

Fetch single content field. This endpoint requires following permission.

  • Manage Content Types
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_field_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

Update Content Field

Authentication required

Update content field. This endpoint requires following permission.

  • Manage Content Types

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

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
content_type_id
required
integer
content_field_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (cf_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "options": {
    },
  • "type": "string",
  • "uniqueID": "string",
  • "updatable": true
}

CustomFields

Retrieve a list of fields in the specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name,basename,description,tag"

The comma separated field name list to search.

Default: name,basename,description,tag

limit
integer
Default: "25"

Maximum number of fields to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return fields in descending order.

ascend

Return fields in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new field

Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (field_updatable)

Responses

Response samples

Content type
application/json
{
  • "basename": "string",
  • "blog": {
    },
  • "default": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "options": "string",
  • "required": true,
  • "showInTheseCategories": [
    ],
  • "systemObject": "string",
  • "tag": "string",
  • "type": "string",
  • "updatable": true
}

Delete a field

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
field_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "basename": "string",
  • "blog": {
    },
  • "default": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "options": "string",
  • "required": true,
  • "showInTheseCategories": [
    ],
  • "systemObject": "string",
  • "tag": "string",
  • "type": "string",
  • "updatable": true
}

Retrieve single field by its ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
field_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "basename": "string",
  • "blog": {
    },
  • "default": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "options": "string",
  • "required": true,
  • "showInTheseCategories": [
    ],
  • "systemObject": "string",
  • "tag": "string",
  • "type": "string",
  • "updatable": true
}

Update a field

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
field_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (field_updatable)

Responses

Response samples

Content type
application/json
{
  • "basename": "string",
  • "blog": {
    },
  • "default": "string",
  • "description": "string",
  • "id": 0,
  • "name": "string",
  • "options": "string",
  • "required": true,
  • "showInTheseCategories": [
    ],
  • "systemObject": "string",
  • "tag": "string",
  • "type": "string",
  • "updatable": true
}

Endpoints

Retrieve a list of endpoints

Retrieve a list of endpoints.

query Parameters
includeComponents
string

This is an optional parameter. The comma separated ID list of components (a.k.a plugin) to include to result.

excludeComponents
string

This is an optional parameter. The comma separated ID list of components (a.k.a plugin) to exclude from result.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Entries

Rebuild the static archives in relation to specified entries

Rebuild the static archives in relation to specified entries.

Authorization is required.

Authorizations:
mtauth
query Parameters
ids
string

This is an required parameter. The comma separated ID list of entries to rebuild.

blogId
integer

This is an optional parameter.

startTime
string

This is an optional parameter.

Responses

Response samples

Content type
application/json
{
  • "restIds": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "Rebuilding"
}

Retrieve a list of entries that related with specific asset

  • Authorization is required to include unpublished entries.

Permissions

  • edit_entry
    • to retrieve unpublished entry
path Parameters
site_id
required
integer
asset_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of entries to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "authored_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: authored_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return entries in descending order.

ascend

Return entries in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

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.

Unpublish

entry_status is 6.

maxComments
integer

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
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of entries by specific category

  • Authorization is required to include unpublished entries.

Permissions

  • edit_entry
    • to retrieve unpublished entry
path Parameters
site_id
required
integer
category_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of entries to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "authored_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: authored_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return entries in descending order.

ascend

Return entries in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

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.

Unpublish

entry_status is 6.

maxComments
integer

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
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of entries

Retrieve a list of entries.

Authorization is required to include unpublished entries.

path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

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.

Unpublish

entry_status is 6.

limit
integer
Default: "10"

Maximum number of entries to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

includeIds
string

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

excludeIds
string

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

sortBy
string
Default: "authored_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: authored_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return entries in descending order.

ascend

Return entries in ascending order.

Default: descend

maxComments
integer

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
integer

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.

fields
string

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

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new entry

  • Authorization is required.

Update in v2.0

  • You can attach categories and assets in one request.

Permissions

  • create_post
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (entry_updatable)
publish
integer
Enum: 0 1

If this value is "0", the entry is not published

Responses

Response samples

Content type
application/json
{
  • "allowComments": true,
  • "allowTrackbacks": true,
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "commentCount": 0,
  • "comments": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "pingsSentUrl": [
    ],
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "trackbackCount": 0,
  • "trackbacks": [
    ],
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Export entries

Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Import entries

Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: multipart/form-data
convert_breaks
string
default_cat_id
integer
default_status
string

If you set import_type is "import_mt_format", also you can set default entry status.

encoding
string
file
string <binary>
import_as_me
integer
Default: 1
Enum: 0 1

0

Preserve original user

1

Import as me

Default: 1

import_type
string
password
string

If you choose import_as_me is 0, you must define a default password for those new accounts.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Make a preview for a entry

  • Authorization is required.
  • This endpoint has been available since Movable Type 6.1.2.

Permissions

  • create_post
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (entry)

Updatable fields are status, title, body, more, excerpt, keywords, tags, date, basename, customFields, allowComments, allowTrackbacks, format, unpublishedDate, categories, assets

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Delete an entry

Delete an entry.

Authorization is required.

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
entry_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "allowComments": true,
  • "allowTrackbacks": true,
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "commentCount": 0,
  • "comments": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "pingsSentUrl": [
    ],
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "trackbackCount": 0,
  • "trackbacks": [
    ],
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Retrieve a single entry by its ID

Retrieve a single entry by its ID.

Authorization is required if the entry status is "unpublished". If the entry status is "published", then this method can be called without authorization.

path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
maxComments
integer

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
integer

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.

fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "allowComments": true,
  • "allowTrackbacks": true,
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "commentCount": 0,
  • "comments": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "pingsSentUrl": [
    ],
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "trackbackCount": 0,
  • "trackbacks": [
    ],
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Update an entry

  • Authorization is required.

Update in v2.0

  • You can attach/detach categories and assets in one request.

Permissions

  • edit_entry
    • to retrieve unpublished entry

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
entry_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (entry_updatable)
publish
integer
Enum: 0 1

If this value is "0", the entry is not published

Responses

Response samples

Content type
application/json
{
  • "allowComments": true,
  • "allowTrackbacks": true,
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "commentCount": 0,
  • "comments": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "pingsSentUrl": [
    ],
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "trackbackCount": 0,
  • "trackbacks": [
    ],
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Retrieve assets that related with specified entry

path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of assets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

class
string

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
Default: "created_on"
Enum: "file_name" "created_by" "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.

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return assets in descending order.

ascend

Return assets in ascending order.

Default: descend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of comments for an entry

Retrieve a list of comments for an entry.

Authorization is required to include unpublished comments

path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of comments to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new comment on an entry

Create a new comment on an entry.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
entry_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Reply to specified comment

Reply to specified comment.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
entry_id
required
integer
comment_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Make a preview for a entry with existing data

  • Authorization is required.
  • This endpoint has been available since Movable Type 6.1.2.
  • entry parameter is required. If you just want to get preview entry from existing data, you should provide entry parameter with empty json.

Permissions

  • create_post
Authorizations:
mtauth
path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (entry)

Updatable fields are status, title, body, more, excerpt, keywords, tags, date, basename, customFields, allowComments, allowTrackbacks, format, unpublishedDate, categories, assets

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Retrieve a list of trackbacks for an entry

Retrieve a list of trackbacks for an entry.

Authorization is required to include unpublished trackbacks

path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of trackbacks to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of entries that related with specific tag

  • Authorization is required to include unpublished entries.

Permissions

  • edit_entry
    • to retrieve unpublished entry
path Parameters
site_id
required
integer
tag_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of entries to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "authored_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: authored_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return entries in descending order.

ascend

Return entries in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

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.

Unpublish

entry_status is 6.

maxComments
integer

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
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Folders

Retrieve a list of folders

Authentication required if you want to get private properties.

path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,basename"

The comma separated field name list to search.

Default: label,basename

limit
integer
Default: "10"

Maximum number of folders to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "user_custom"
Enum: "user_custom" "created_by" "id" "basename" "label"

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.

Default: user_custom

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return folders in descending order.

ascend

Return folders in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

top
integer
Default: 0
Enum: 0 1

If set to 1, retrieves only top level folders.

Default: 0

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new folder.

Authorization is required.

Permission

  • Manage Pages
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (folder_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "path": "string",
  • "updatable": true
}

Rearrange existing folders in a new order

  • Authorization is required.
  • This method returns rearranged Folders resource.

Permission

  • Manage Pages
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
folders
string

Array of folder resource that were rearranged.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete an existing folder

  • Authorization is required.
  • This method returns deleted Folder resource.

Permission

  • Manage Pages

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
folder_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "path": "string",
  • "updatable": true
}

Retrieve single folder by its ID

path Parameters
site_id
required
integer
folder_id
required
integer
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "path": "string",
  • "updatable": true
}

Update an existing folder

  • Authorization is required.

Permission

  • Manage Pages

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
folder_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (folder_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveLink": "string",
  • "basename": "string",
  • "blog": {
    },
  • "class": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "path": "string",
  • "updatable": true
}

Retrieve a list of child folders of the requested folder

Authentication required if you want to get private properties.

path Parameters
site_id
required
integer
folder_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving child folders.

Default: 0

includeCurrent
integer
Default: 0
Enum: 0 1

1

The results includes current folder.

0

The results do not include current folder.

Default: 0

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of pages by specific folder

  • Authorization is required to include unpublished pages.

Permissions

  • manage_pages
    • to retrieve unpublished page
path Parameters
site_id
required
integer
folder_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of pages to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "modified_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: modified_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return pages in descending order.

ascend

Return pages in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

Filter by container page'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.

Unpublish

entry_status is 6.

maxComments
integer

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

maxTrackbacks
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of parent folders of the requested folder

Authentication required if you want to get private properties.

path Parameters
site_id
required
integer
folder_id
required
integer
query Parameters
maxDepth
integer

The depth of retrieving parent folders.

Default: 0

includeCurrent
integer
Default: 0
Enum: 0 1

1

The results includes current folder.

0

The results do not include current folder.

Default: 0

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of sibling folders of the requested folder

Authentication required if you want to get private properties.

path Parameters
site_id
required
integer
folder_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,basename"

The comma separated field name list to search.

Default: label,basename

limit
integer
Default: "10"

Maximum number of folders to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "user_custom"
Enum: "user_custom" "created_by" "id" "basename" "label"

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.

Default: user_custom

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return folders in descending order.

ascend

Return folders in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

top
integer
Default: 0
Enum: 0 1

Default: 0

If set to 1, retrieves only top level folders.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

FormattedText

Retrieve a list of formatted_texts in the specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "label,text,description"

The comma separated field name list to search.

Default: label,text,description

limit
integer
Default: "10"

Maximum number of formatted_texts to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "created_on"

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return formatted_texts in descending order.

ascend

Return formatted_texts in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new formatted_text

Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (formatted_text_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "text": "string",
  • "updatable": true
}

Delete a formatted_text

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
formatted_text_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "text": "string",
  • "updatable": true
}

Retrieve single formatted_text by its ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
formatted_text_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "text": "string",
  • "updatable": true
}

Update a formatted_text

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
formatted_text_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (formatted_text_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "label": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "text": "string",
  • "updatable": true
}

Groups

Retrieve a list of groups

Authorizations:
mtauth
query Parameters
search
string

Search query.

searchFields
string
Default: "name,displayName,description"

The comma separated field name list to search.

Default: name,displayName,description

limit
integer
Default: "25"

Maximum number of groups to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return groups in descending order.

ascend

Return groups in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new group

Authorizations:
mtauth
Request Body schema: application/x-www-form-urlencoded
object (group_updatable)

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "externalId": "string",
  • "id": 0,
  • "memberCount": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissionCount": 0,
  • "status": "string",
  • "updatable": true
}

Synchronize groups

Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Delete a group

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
group_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "externalId": "string",
  • "id": 0,
  • "memberCount": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissionCount": 0,
  • "status": "string",
  • "updatable": true
}

Retrieve single group by its ID

Authorizations:
mtauth
path Parameters
group_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "externalId": "string",
  • "id": 0,
  • "memberCount": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissionCount": 0,
  • "status": "string",
  • "updatable": true
}

Update a group

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
group_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (group_updatable)

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "displayName": "string",
  • "externalId": "string",
  • "id": 0,
  • "memberCount": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissionCount": 0,
  • "status": "string",
  • "updatable": true
}

Retrieve a list of members for specified group

Authorizations:
mtauth
path Parameters
group_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name,displayName,description"

The comma separated field name list to search.

Default: name,displayName,description

limit
integer
Default: "25"

Maximum number of groups to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return groups in descending order.

ascend

Return groups in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

/groups/{group_id}/members

Authorizations:
mtauth
path Parameters
group_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object

Responses

Response samples

Content type
application/json
{
  • "apiPassword": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "dateFormat": "string",
  • "displayName": "string",
  • "email": "string",
  • "id": 0,
  • "isSuperuser": true,
  • "language": "string",
  • "lockedOut": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "password": "string",
  • "status": "string",
  • "systemPermissions": [
    ],
  • "tagDelimiter": "string",
  • "textFormat": "string",
  • "updatable": true,
  • "url": "string",
  • "userpicUrl": "string"
}

#### Notes - This method accepts DELETE and POST

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
group_id
required
integer
member_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "apiPassword": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "dateFormat": "string",
  • "displayName": "string",
  • "email": "string",
  • "id": 0,
  • "isSuperuser": true,
  • "language": "string",
  • "lockedOut": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "password": "string",
  • "status": "string",
  • "systemPermissions": [
    ],
  • "tagDelimiter": "string",
  • "textFormat": "string",
  • "updatable": true,
  • "url": "string",
  • "userpicUrl": "string"
}

Retrieve single member by its ID for specified group

Authorizations:
mtauth
path Parameters
group_id
required
integer
member_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "apiPassword": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "dateFormat": "string",
  • "displayName": "string",
  • "email": "string",
  • "id": 0,
  • "isSuperuser": true,
  • "language": "string",
  • "lockedOut": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "password": "string",
  • "status": "string",
  • "systemPermissions": [
    ],
  • "tagDelimiter": "string",
  • "textFormat": "string",
  • "updatable": true,
  • "url": "string",
  • "userpicUrl": "string"
}

Retrieve a list of permissions for group

  • Authentication is required
  • If you want to get others list, you should have Administer privilege.
Authorizations:
mtauth
path Parameters
group_id
required
integer
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

blogIds
string

The comma-separated blog id list that to be included in the result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Grant permissions to group

  • Authentication is required
  • You should have grant_administer_role or grant_role_for_blog (Need grant_administer_role when granting role having administer_blog)
Authorizations:
mtauth
path Parameters
group_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Revoke permissions from group

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
group_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of groups

Authorizations:
mtauth
path Parameters
user_id
required
string
query Parameters
search
string

Search query.

searchFields
string
Default: "name,displayName,description"

The comma separated field name list to search.

Default: name,displayName,description

limit
integer
Default: "25"

Maximum number of groups to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return groups in descending order.

ascend

Return groups in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Logs

Reset logs

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of logs in the specified site

  • Authorization is required.

Permissions

  • view_blog_log for website and blog.
  • view_log for the system.
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "message,ip"

The comma separated field name list to search.

Default: message,ip

limit
integer
Default: "25"

Maximum number of logs to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "created_on"
Enum: "id" "created_on" "blog_id" "author_id" "level" "class"
  • id
  • created_on
  • blog_id
  • author_id
  • level
  • class

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return logs in descending order.

ascend

Return logs in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

level
string
Enum: "security" "error" "warning" "info" "debug" "security_or_error" "security_or_error_or_warning" "not_debug" "debug_or_error"

The comma separated list of level name to filter logs. Available value is foolows.

  • security
  • error
  • warning
  • info
  • debug
  • security_or_error
  • security_or_error_or_warning
  • not_debug
  • debug_or_error
dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new log

Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (log_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "by": {
    },
  • "category": "string",
  • "class": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "ip": "string",
  • "level": "string",
  • "message": "string",
  • "metadata": "string",
  • "updatable": true
}

Export logs

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
encoding
string

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete an existing log

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
log_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "by": {
    },
  • "category": "string",
  • "class": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "ip": "string",
  • "level": "string",
  • "message": "string",
  • "metadata": "string",
  • "updatable": true
}

Retrieve a single log by its ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
log_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "by": {
    },
  • "category": "string",
  • "class": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "ip": "string",
  • "level": "string",
  • "message": "string",
  • "metadata": "string",
  • "updatable": true
}

Update an existing log

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
log_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (log_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "by": {
    },
  • "category": "string",
  • "class": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "ip": "string",
  • "level": "string",
  • "message": "string",
  • "metadata": "string",
  • "updatable": true
}

Pages

Retrieve a list of pages that related with specific asset

  • Authorization is required to include unpublished pages.

Permissions

  • manage_pages
    • to retrieve unpublished page
path Parameters
site_id
required
integer
asset_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of pages to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "modified_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: modified_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return pages in descending order.

ascend

Return pages in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

Filter by container page'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.

Unpublish

entry_status is 6.

maxComments
integer

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

maxTrackbacks
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of pages by specific folder

  • Authorization is required to include unpublished pages.

Permissions

  • manage_pages
    • to retrieve unpublished page
path Parameters
site_id
required
integer
folder_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of pages to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "modified_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: modified_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return pages in descending order.

ascend

Return pages in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

Filter by container page'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.

Unpublish

entry_status is 6.

maxComments
integer

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

maxTrackbacks
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of pages in the specified site

  • Authorization is required to include unpublished pages.

Permissions

  • manage_pages
    • to retrieve unpublished page
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of pages to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "modified_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: modified_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return pages in descending order.

ascend

Return pages in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

Filter by container page'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.

Unpublish

entry_status is 6.

maxComments
integer

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

maxTrackbacks
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new page

  • Authorization is required.

Update in v2.0

  • You can attach folder and assets in one request.

Permissions

  • manage_post
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (page_updatable)
publish
integer
Enum: 0 1

If this value is "0", the entry is not published

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "folder": {
    },
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Make a preview for a page

  • Authorization is required.
  • This endpoint has been available since Movable Type 6.1.2.

Permissions

  • manage_pages
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (page)

Updatable fields are status, title, body, more, excerpt, keywords, tags, date, basename, format, unpublishedDate, customFields

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Delete an existing page

  • Authorization is required.

Permissions

  • edit_entry

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
page_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "folder": {
    },
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Retrieve a single page by its ID

  • Authorization is required if the page status is "unpublished". If the page status is "published", then this method can be called without authorization.
path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "folder": {
    },
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Update an existing page

  • Authorization is required.

Update in v2.0

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

Permissions

  • manage_pages

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
page_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (page_updatable)
publish
integer
Enum: 0 1

If this value is "0", the entry is not published

Responses

Response samples

Content type
application/json
{
  • "assets": [
    ],
  • "author": {
    },
  • "basename": "string",
  • "blog": {
    },
  • "body": "string",
  • "categories": [
    ],
  • "class": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "excerpt": "string",
  • "folder": {
    },
  • "format": "string",
  • "id": 0,
  • "keywords": "string",
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "more": "string",
  • "permalink": "string",
  • "status": "string",
  • "tags": [
    ],
  • "title": "string",
  • "unpublishedDate": "2019-08-24T14:15:22Z",
  • "updatable": true
}

Retrieve assets that related with specified page

path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of assets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

class
string

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
Default: "created_on"
Enum: "file_name" "created_by" "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.

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return assets in descending order.

ascend

Return assets in ascending order.

Default: descend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of comments for the specified page

Retrieve a list of comments for a page.

Authorization is required to include unpublished comments

path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of comments to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new comment on a page

Create a new comment on a page.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
page_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Reply to specified comment

Reply to specified comment.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
page_id
required
integer
comment_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (comment_updatable)

Responses

Response samples

Content type
application/json
{
  • "author": {
    },
  • "blog": {
    },
  • "body": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": {
    },
  • "id": 0,
  • "link": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "parent": 0,
  • "status": "string",
  • "updatable": true
}

Make a preview for a page with existing data

  • Authorization is required.
  • This endpoint has been available since Movable Type 6.1.2.
  • page parameter is required. If you just want to get preview page from existing data, you should provide page parameter with empty json.

Permissions

  • manage_post
Authorizations:
mtauth
path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (page)

Updatable fields are status, title, body, more, excerpt, keywords, tags, date, basename, format, unpublishedDate, customFields

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Retrieve a list of trackbacks for a page

Retrieve a list of trackbacks for an page.

Authorization is required to include unpublished trackbacks

path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of trackbacks to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of pages that related with specific tag.

  • Authorization is required to include unpublished pages.

Permissions

  • manage_pages
    • to retrieve unpublished page
path Parameters
site_id
required
integer
tag_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of pages to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "modified_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: modified_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return pages in descending order.

ascend

Return pages in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

Filter by container page'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.

Unpublish

entry_status is 6.

maxComments
integer

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

maxTrackbacks
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Permissions

Retrieve a list of permissions for group

  • Authentication is required
  • If you want to get others list, you should have Administer privilege.
Authorizations:
mtauth
path Parameters
group_id
required
integer
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

blogIds
string

The comma-separated blog id list that to be included in the result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Grant permissions to group

  • Authentication is required
  • You should have grant_administer_role or grant_role_for_blog (Need grant_administer_role when granting role having administer_blog)
Authorizations:
mtauth
path Parameters
group_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Revoke permissions from group

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
group_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of permissions

  • Authentication is required
  • Need Administer privilege.
Authorizations:
mtauth
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

blogIds
string

The comma-separated blog id list that to be included in the result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of permissions by role

  • Authentication is required

Permissions

  • Administer
Authorizations:
mtauth
path Parameters
role_id
required
integer
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

blogIds
string

The comma-separated blog id list that to be included in the result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of permissions for site

  • Authentication is required

Permissions

  • Administer
  • Website Administrator for websites
  • Blog Administrator for blog
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Grant permissions to site

  • Authentication is required
  • You should have grant_administer_role or grant_role_for_blog (Need grant_administer_role when granting role having administer_blog)
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

user_id
integer

The user ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Revoke permissions from site

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

user_id
integer

The user ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of permissions for user

  • Authentication is required
  • If you want to get others list, you should have Administer privilege.
Authorizations:
mtauth
path Parameters
user_id
required
string
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

blogIds
string

The comma-separated blog id list that to be included in the result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Grant permissions to user

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
user_id
required
string
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Revoke permissions from user

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
user_id
required
string
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Plugins

Retrieve a list of plugins in the specified site

Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Disable all plugins

Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Enable all plugins

Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve single plugin by its ID

Authorizations:
mtauth
path Parameters
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "attributes": [
    ],
  • "authorLink": "string",
  • "authorName": "string",
  • "configLink": "string",
  • "description": "string",
  • "documentLink": "string",
  • "icon": "string",
  • "id": "string",
  • "junkFilters": [
    ],
  • "name": "string",
  • "pluginLink": "string",
  • "pluginSet": "string",
  • "signature": "string",
  • "status": "string",
  • "tags": [
    ],
  • "textFilters": [
    ],
  • "version": "string"
}

Disable a plugin

Authorizations:
mtauth
path Parameters
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Enable a plugin

Authorizations:
mtauth
path Parameters
plugin_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Publish

Publish Content Data

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

  • Manage Content Data (site, sistem, each content type)
  • Edit All Content Data (each content type)
Authorizations:
mtauth
query Parameters
blogId
integer

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

blogIds
string

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

ids
string

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

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.

Responses

Response samples

Content type
application/json
{
  • "restIds": "string",
  • "startTime": "string",
  • "status": "string"
}

Rebuild the static archives in relation to specified entries

Rebuild the static archives in relation to specified entries.

Authorization is required.

Authorizations:
mtauth
query Parameters
ids
string

This is an required parameter. The comma separated ID list of entries to rebuild.

blogId
integer

This is an optional parameter.

startTime
string

This is an optional parameter.

Responses

Response samples

Content type
application/json
{
  • "restIds": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "Rebuilding"
}

Roles

Retrieve a list of roles

Authorizations:
mtauth
query Parameters
search
string

Search query.

searchFields
string
Default: "name,description"

The comma separated field name list to search.

Default: name,description

limit
integer
Default: "25"

Maximum number of roles to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"
Enum: "name" "created_by" "modified_by" "created_on" "modified_on"

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

  • created_by
  • modified_by
  • created_on
  • modified_on

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return roles in descending order.

ascend

Return roles in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new role

Authorizations:
mtauth
Request Body schema: application/x-www-form-urlencoded
object (role_updatable)

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissions": [
    ],
  • "updatable": true
}

Delete an existing role

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
role_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissions": [
    ],
  • "updatable": true
}

Retrieve a single role by its ID

Authorizations:
mtauth
path Parameters
role_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissions": [
    ],
  • "updatable": true
}

Update an existing role

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
role_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (role_updatable)

Responses

Response samples

Content type
application/json
{
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": 0,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "permissions": [
    ],
  • "updatable": true
}

Retrieve a list of permissions by role

  • Authentication is required

Permissions

  • Administer
Authorizations:
mtauth
path Parameters
role_id
required
integer
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

blogIds
string

The comma-separated blog id list that to be included in the result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Search

Searching entries

query Parameters
search
required
string

The search term.

You can specify search term, like [foo], [foo AND bar], 'foo NOT bar'.

Also, you can specify category filter, like [category:foo], [category:"hoge OR 'foo bar'"]

Also, you can specify author filter, like [author:Melody]

Also, you can specify Custom Fields filter, like [field:address:akasaka] in this case, address is basename of Custom Fields. akasaka is filter value.

blog_id
integer

The site ID for search. If you want to specify multiple site ID, you must use IncludeBlogs.

IncludeBlogs
string

The list of the site ID that will be included in the search it should be separated by comma.

ExcludeBlogs
string

The list of the site ID will be excluded from the search it should be separated by comma.

limit
integer

Maximum number of entries to retrieve.

Default: 20

offset
integer

0-indexed offset.

Default: 0

SearchSortBy
string
Enum: "created_on" "title"

The sort column for the search results. Available values are as follows.

created_on

Will sort the entries by the authored on date.

title

Will sort the entries by title.

SearchResultDisplay
string
Default: "ascend"
Enum: "ascend" "descend"

Defines the sort order search results. Available values are as follows.

ascend

will list the entries in chronological order (oldest entry at the top)

descend

will list the entries in reverse chronological order (newest entry at the top).

Default: ascend

SearchMaxResults
integer

Maximum number of entries to retrieve.

NOTE: By default, "SearchMaxResults" override is disabled.

Default: 20

class
string

Class name of the object to be searched. Available values are as follows.

  • entry: Search results will only contain entries.
  • page: Search results will only contain pages.
cdSearch
integer

If 1 specified, searching content data only.

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Sites

Retrieve sites

query Parameters
search
string

Search query.

searchFields
string
Default: "name"

The comma separated field name list to search.

Default: name

limit
integer
Default: "25"

Maximum number of sites to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"
Value: "name"

Only 'name' is available

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return sites in descending order.

ascend

Return sites in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new website

  • Authorization is required.

Permissions

  • create_website
Authorizations:
mtauth
Request Body schema: application/x-www-form-urlencoded
object (blog_updatable)

Responses

Response samples

Content type
application/json
{
  • "allowCommentHtml": true,
  • "allowCommenterRegist": true,
  • "allowComments": true,
  • "allowCommentsDefault": true,
  • "allowPings": true,
  • "allowPingsDefault": true,
  • "allowToChangeAtUpload": true,
  • "allowUnregComments": true,
  • "archivePath": "string",
  • "archiveTypePreferred": "string",
  • "archiveUrl": "string",
  • "autoRenameNonAscii": true,
  • "autodiscoverLinks": true,
  • "autolinkUrls": true,
  • "basenameLimit": 0,
  • "ccLicenseImage": "string",
  • "ccLicenseUrl": "string",
  • "class": "string",
  • "commenterAuthenticators": [
    ],
  • "contentCss": "string",
  • "convertParas": "string",
  • "convertParasComments": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customDynamicTemplates": "string",
  • "customFields": [
    ],
  • "dateLanguage": "string",
  • "daysOrPosts": "string",
  • "description": "string",
  • "dynamicCache": true,
  • "dynamicConditional": true,
  • "emailNewComments": "string",
  • "emailNewPings": "string",
  • "entryCustomPrefs": [
    ],
  • "extraPath": "string",
  • "fileExtension": "string",
  • "followAuthLinks": true,
  • "host": "string",
  • "id": 0,
  • "includeCache": true,
  • "includeSystem": "string",
  • "internalAutodiscovery": true,
  • "junkFolderExpiry": 0,
  • "junkScoreThreshold": 0,
  • "language": "string",
  • "listOnIndex": 0,
  • "maxRevisionsContentData": 0,
  • "maxRevisionsEntry": 0,
  • "maxRevisionsTemplate": 0,
  • "moderateComments": 0,
  • "moderatePings": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "newCreatedUserRoles": [
    ],
  • "nofollowUrls": true,
  • "normalizeOrientation": true,
  • "operationIfExists": 0,
  • "pageCustomPrefs": [
    ],
  • "parent": {
    },
  • "pingGoogle": true,
  • "pingOthers": [
    ],
  • "pingWeblogs": true,
  • "publishEmptyArchive": true,
  • "relativeUrl": "string",
  • "requireCommentEmails": true,
  • "sanitizeSpec": "string",
  • "serverOffset": "string",
  • "sitePath": "string",
  • "smartReplace": 0,
  • "smartReplaceFields": [
    ],
  • "sortOrderComments": "string",
  • "sortOrderPosts": "string",
  • "statusDefault": "string",
  • "themeId": "string",
  • "timezone": "string",
  • "updatable": true,
  • "uploadDestination": {
    },
  • "url": "string",
  • "useCommentConfirmation": true,
  • "useRevision": true,
  • "wordsInExcerpt": 0
}

Delete an existing blog or website

  • Authorization is required.

Permissions

  • delete_website (for website)
  • delete_blog (for blog)

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "allowCommentHtml": true,
  • "allowCommenterRegist": true,
  • "allowComments": true,
  • "allowCommentsDefault": true,
  • "allowPings": true,
  • "allowPingsDefault": true,
  • "allowToChangeAtUpload": true,
  • "allowUnregComments": true,
  • "archivePath": "string",
  • "archiveTypePreferred": "string",
  • "archiveUrl": "string",
  • "autoRenameNonAscii": true,
  • "autodiscoverLinks": true,
  • "autolinkUrls": true,
  • "basenameLimit": 0,
  • "ccLicenseImage": "string",
  • "ccLicenseUrl": "string",
  • "class": "string",
  • "commenterAuthenticators": [
    ],
  • "contentCss": "string",
  • "convertParas": "string",
  • "convertParasComments": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customDynamicTemplates": "string",
  • "customFields": [
    ],
  • "dateLanguage": "string",
  • "daysOrPosts": "string",
  • "description": "string",
  • "dynamicCache": true,
  • "dynamicConditional": true,
  • "emailNewComments": "string",
  • "emailNewPings": "string",
  • "entryCustomPrefs": [
    ],
  • "extraPath": "string",
  • "fileExtension": "string",
  • "followAuthLinks": true,
  • "host": "string",
  • "id": 0,
  • "includeCache": true,
  • "includeSystem": "string",
  • "internalAutodiscovery": true,
  • "junkFolderExpiry": 0,
  • "junkScoreThreshold": 0,
  • "language": "string",
  • "listOnIndex": 0,
  • "maxRevisionsContentData": 0,
  • "maxRevisionsEntry": 0,
  • "maxRevisionsTemplate": 0,
  • "moderateComments": 0,
  • "moderatePings": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "newCreatedUserRoles": [
    ],
  • "nofollowUrls": true,
  • "normalizeOrientation": true,
  • "operationIfExists": 0,
  • "pageCustomPrefs": [
    ],
  • "parent": {
    },
  • "pingGoogle": true,
  • "pingOthers": [
    ],
  • "pingWeblogs": true,
  • "publishEmptyArchive": true,
  • "relativeUrl": "string",
  • "requireCommentEmails": true,
  • "sanitizeSpec": "string",
  • "serverOffset": "string",
  • "sitePath": "string",
  • "smartReplace": 0,
  • "smartReplaceFields": [
    ],
  • "sortOrderComments": "string",
  • "sortOrderPosts": "string",
  • "statusDefault": "string",
  • "themeId": "string",
  • "timezone": "string",
  • "updatable": true,
  • "uploadDestination": {
    },
  • "url": "string",
  • "useCommentConfirmation": true,
  • "useRevision": true,
  • "wordsInExcerpt": 0
}

Retrieve a single blog by its ID

path Parameters
site_id
required
integer
query Parameters
fields
string

This is an optional parameter. The field list to retrieve as part of the Entries resource. If this parameter is not specified, All fields will be returned.

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "allowCommentHtml": true,
  • "allowCommenterRegist": true,
  • "allowComments": true,
  • "allowCommentsDefault": true,
  • "allowPings": true,
  • "allowPingsDefault": true,
  • "allowToChangeAtUpload": true,
  • "allowUnregComments": true,
  • "archivePath": "string",
  • "archiveTypePreferred": "string",
  • "archiveUrl": "string",
  • "autoRenameNonAscii": true,
  • "autodiscoverLinks": true,
  • "autolinkUrls": true,
  • "basenameLimit": 0,
  • "ccLicenseImage": "string",
  • "ccLicenseUrl": "string",
  • "class": "string",
  • "commenterAuthenticators": [
    ],
  • "contentCss": "string",
  • "convertParas": "string",
  • "convertParasComments": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customDynamicTemplates": "string",
  • "customFields": [
    ],
  • "dateLanguage": "string",
  • "daysOrPosts": "string",
  • "description": "string",
  • "dynamicCache": true,
  • "dynamicConditional": true,
  • "emailNewComments": "string",
  • "emailNewPings": "string",
  • "entryCustomPrefs": [
    ],
  • "extraPath": "string",
  • "fileExtension": "string",
  • "followAuthLinks": true,
  • "host": "string",
  • "id": 0,
  • "includeCache": true,
  • "includeSystem": "string",
  • "internalAutodiscovery": true,
  • "junkFolderExpiry": 0,
  • "junkScoreThreshold": 0,
  • "language": "string",
  • "listOnIndex": 0,
  • "maxRevisionsContentData": 0,
  • "maxRevisionsEntry": 0,
  • "maxRevisionsTemplate": 0,
  • "moderateComments": 0,
  • "moderatePings": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "newCreatedUserRoles": [
    ],
  • "nofollowUrls": true,
  • "normalizeOrientation": true,
  • "operationIfExists": 0,
  • "pageCustomPrefs": [
    ],
  • "parent": {
    },
  • "pingGoogle": true,
  • "pingOthers": [
    ],
  • "pingWeblogs": true,
  • "publishEmptyArchive": true,
  • "relativeUrl": "string",
  • "requireCommentEmails": true,
  • "sanitizeSpec": "string",
  • "serverOffset": "string",
  • "sitePath": "string",
  • "smartReplace": 0,
  • "smartReplaceFields": [
    ],
  • "sortOrderComments": "string",
  • "sortOrderPosts": "string",
  • "statusDefault": "string",
  • "themeId": "string",
  • "timezone": "string",
  • "updatable": true,
  • "uploadDestination": {
    },
  • "url": "string",
  • "useCommentConfirmation": true,
  • "useRevision": true,
  • "wordsInExcerpt": 0
}

Create a new blog

  • Authorization is required.

Permissions

  • create_blog
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (blog_updatable)

Responses

Response samples

Content type
application/json
{
  • "allowCommentHtml": true,
  • "allowCommenterRegist": true,
  • "allowComments": true,
  • "allowCommentsDefault": true,
  • "allowPings": true,
  • "allowPingsDefault": true,
  • "allowToChangeAtUpload": true,
  • "allowUnregComments": true,
  • "archivePath": "string",
  • "archiveTypePreferred": "string",
  • "archiveUrl": "string",
  • "autoRenameNonAscii": true,
  • "autodiscoverLinks": true,
  • "autolinkUrls": true,
  • "basenameLimit": 0,
  • "ccLicenseImage": "string",
  • "ccLicenseUrl": "string",
  • "class": "string",
  • "commenterAuthenticators": [
    ],
  • "contentCss": "string",
  • "convertParas": "string",
  • "convertParasComments": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customDynamicTemplates": "string",
  • "customFields": [
    ],
  • "dateLanguage": "string",
  • "daysOrPosts": "string",
  • "description": "string",
  • "dynamicCache": true,
  • "dynamicConditional": true,
  • "emailNewComments": "string",
  • "emailNewPings": "string",
  • "entryCustomPrefs": [
    ],
  • "extraPath": "string",
  • "fileExtension": "string",
  • "followAuthLinks": true,
  • "host": "string",
  • "id": 0,
  • "includeCache": true,
  • "includeSystem": "string",
  • "internalAutodiscovery": true,
  • "junkFolderExpiry": 0,
  • "junkScoreThreshold": 0,
  • "language": "string",
  • "listOnIndex": 0,
  • "maxRevisionsContentData": 0,
  • "maxRevisionsEntry": 0,
  • "maxRevisionsTemplate": 0,
  • "moderateComments": 0,
  • "moderatePings": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "newCreatedUserRoles": [
    ],
  • "nofollowUrls": true,
  • "normalizeOrientation": true,
  • "operationIfExists": 0,
  • "pageCustomPrefs": [
    ],
  • "parent": {
    },
  • "pingGoogle": true,
  • "pingOthers": [
    ],
  • "pingWeblogs": true,
  • "publishEmptyArchive": true,
  • "relativeUrl": "string",
  • "requireCommentEmails": true,
  • "sanitizeSpec": "string",
  • "serverOffset": "string",
  • "sitePath": "string",
  • "smartReplace": 0,
  • "smartReplaceFields": [
    ],
  • "sortOrderComments": "string",
  • "sortOrderPosts": "string",
  • "statusDefault": "string",
  • "themeId": "string",
  • "timezone": "string",
  • "updatable": true,
  • "uploadDestination": {
    },
  • "url": "string",
  • "useCommentConfirmation": true,
  • "useRevision": true,
  • "wordsInExcerpt": 0
}

Update an existing blog or website

  • Authorization is required.

Permissions

  • edit_blog_config

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (blog_updatable)

Responses

Response samples

Content type
application/json
{
  • "allowCommentHtml": true,
  • "allowCommenterRegist": true,
  • "allowComments": true,
  • "allowCommentsDefault": true,
  • "allowPings": true,
  • "allowPingsDefault": true,
  • "allowToChangeAtUpload": true,
  • "allowUnregComments": true,
  • "archivePath": "string",
  • "archiveTypePreferred": "string",
  • "archiveUrl": "string",
  • "autoRenameNonAscii": true,
  • "autodiscoverLinks": true,
  • "autolinkUrls": true,
  • "basenameLimit": 0,
  • "ccLicenseImage": "string",
  • "ccLicenseUrl": "string",
  • "class": "string",
  • "commenterAuthenticators": [
    ],
  • "contentCss": "string",
  • "convertParas": "string",
  • "convertParasComments": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customDynamicTemplates": "string",
  • "customFields": [
    ],
  • "dateLanguage": "string",
  • "daysOrPosts": "string",
  • "description": "string",
  • "dynamicCache": true,
  • "dynamicConditional": true,
  • "emailNewComments": "string",
  • "emailNewPings": "string",
  • "entryCustomPrefs": [
    ],
  • "extraPath": "string",
  • "fileExtension": "string",
  • "followAuthLinks": true,
  • "host": "string",
  • "id": 0,
  • "includeCache": true,
  • "includeSystem": "string",
  • "internalAutodiscovery": true,
  • "junkFolderExpiry": 0,
  • "junkScoreThreshold": 0,
  • "language": "string",
  • "listOnIndex": 0,
  • "maxRevisionsContentData": 0,
  • "maxRevisionsEntry": 0,
  • "maxRevisionsTemplate": 0,
  • "moderateComments": 0,
  • "moderatePings": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "newCreatedUserRoles": [
    ],
  • "nofollowUrls": true,
  • "normalizeOrientation": true,
  • "operationIfExists": 0,
  • "pageCustomPrefs": [
    ],
  • "parent": {
    },
  • "pingGoogle": true,
  • "pingOthers": [
    ],
  • "pingWeblogs": true,
  • "publishEmptyArchive": true,
  • "relativeUrl": "string",
  • "requireCommentEmails": true,
  • "sanitizeSpec": "string",
  • "serverOffset": "string",
  • "sitePath": "string",
  • "smartReplace": 0,
  • "smartReplaceFields": [
    ],
  • "sortOrderComments": "string",
  • "sortOrderPosts": "string",
  • "statusDefault": "string",
  • "themeId": "string",
  • "timezone": "string",
  • "updatable": true,
  • "uploadDestination": {
    },
  • "url": "string",
  • "useCommentConfirmation": true,
  • "useRevision": true,
  • "wordsInExcerpt": 0
}

Backup specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "backupFiles": [
    ],
  • "status": "string"
}

Retrieve sites by parent ID

path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name"

The comma separated field name list to search.

Default: name

limit
integer
Default: "25"

Maximum number of sites to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"
Value: "name"

Only 'name' is available

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return sites in descending order.

ascend

Return sites in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of permissions for site

  • Authentication is required

Permissions

  • Administer
  • Website Administrator for websites
  • Blog Administrator for blog
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Grant permissions to site

  • Authentication is required
  • You should have grant_administer_role or grant_role_for_blog (Need grant_administer_role when granting role having administer_blog)
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

user_id
integer

The user ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Revoke permissions from site

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

user_id
integer

The user ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of blogs by user

Retrieve a list of blogs by user.

path Parameters
user_id
required
string
query Parameters
limit
integer

This is an optional parameter. Maximum number of blogs to retrieve. Default is 25.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

sortBy
string
Enum: "name" "created_on"

This is an optional parameter.

name

(default) Sort by the name of each blogs.

created_on

Sort by the created time of each blogs.

sortOrder
string
Enum: "ascend" "descend"

This is an optional parameter.

ascend

(default) Return blogs in ascending order. For the date, it means from oldest to newset.

descend

Return blogs in descending order. For the date, it means from newest to oldest.

includeIds
string

This is an optional parameter. The comma separated ID list of blogs to include to result.

excludeIds
string

This is an optional parameter. The comma separated ID list of blogs to exclude from result.

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Statistics

Retrieve pageviews count for each date from provider (e.g. Google Analytics)

Retrieve pageviews count for each date from provider (e.g. Google Analytics).

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
startDate
required
string <date>

This is an required parameter. Start date of data. The format is "YYYY-MM-DD".

endDate
required
string <date>

This is an required parameter. End date of data. The format is "YYYY-MM-DD".

limit
integer

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
string

This is an optional parameter. 0-indexed offset. Default is 0.

path
string

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

uniquePath
integer
Enum: 0 1

This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0,
  • "totals": {
    }
}

Retrieve visits count for each date from provider (e.g. Google Analytics)

Retrieve visits count for each date from provider (e.g. Google Analytics).

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
startDate
required
string <date>

This is an required parameter. Start date of data. The format is "YYYY-MM-DD".

endDate
required
string <date>

This is an required parameter. End date of data. The format is "YYYY-MM-DD".

limit
integer

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
string

This is an optional parameter. 0-indexed offset. Default is 0.

path
string

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0,
  • "totals": {
    }
}

Retrieve pageviews count for each path from provider (e.g. Google Analytics)

Retrieve pageviews count for each path from provider (e.g. Google Analytics).

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
startDate
required
string <date>

This is an required parameter. Start date of data. The format is "YYYY-MM-DD".

endDate
required
string <date>

This is an required parameter. End date of data. The format is "YYYY-MM-DD".

limit
integer

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
string

This is an optional parameter. 0-indexed offset. Default is 0.

path
string

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

uniquePath
integer
Enum: 0 1

This is an optional parameter. If true is given, the MT can return total pageviews for each uniqueness paths. However, that data does not contain page title because its spec. (Sometimes, Google Analytics will return another pageviews by same path.)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0,
  • "totals": {
    }
}

Retrieve visits count for each path from provider (e.g. Google Analytics)

Retrieve visits count for each date from provider (e.g. Google Analytics).

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
startDate
required
string <date>

This is an required parameter. Start date of data. The format is "YYYY-MM-DD".

endDate
required
string <date>

This is an required parameter. End date of data. The format is "YYYY-MM-DD".

limit
integer

This is an optional parameter. Maximum number of paths to retrieve. Default is 10.

offset
string

This is an optional parameter. 0-indexed offset. Default is 0.

path
string

This is an optional parameter. The target path of data to retrieve. Default is the path of the current site.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0,
  • "totals": {
    }
}

Retrieve a current effective provider

Retrieve a current effective provider.

Authorization is required.

Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "id": "string"
}

System

Retrieve a list of text filters

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Tags

Retrieve a list of tags that related with specific site

path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name"

The comma separated field name list to search.

Default: name

limit
integer
Default: "25"

Maximum number of tags to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return tags in descending order.

ascend

Return tags in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Delete an existing tag

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
tag_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "assetCount": 0,
  • "entryCount": 0,
  • "id": 0,
  • "isPrivate": true,
  • "name": "string",
  • "normalizedName": "string",
  • "pageCount": 0,
  • "updatable": true
}

Retrieve a single tag by its ID

path Parameters
site_id
required
integer
tag_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "assetCount": 0,
  • "entryCount": 0,
  • "id": 0,
  • "isPrivate": true,
  • "name": "string",
  • "normalizedName": "string",
  • "pageCount": 0,
  • "updatable": true
}

Update an existing tag

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
tag_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (tag_updatable)

Responses

Response samples

Content type
application/json
{
  • "assetCount": 0,
  • "entryCount": 0,
  • "id": 0,
  • "isPrivate": true,
  • "name": "string",
  • "normalizedName": "string",
  • "pageCount": 0,
  • "updatable": true
}

Retrieve assets that related with specified tag

path Parameters
site_id
required
integer
tag_id
required
integer
query Parameters
limit
integer
Default: "10"

Maximum number of assets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

class
string

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
Default: "created_on"
Enum: "file_name" "created_by" "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.

Default: created_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return assets in descending order.

ascend

Return assets in ascending order.

Default: descend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of entries that related with specific tag

  • Authorization is required to include unpublished entries.

Permissions

  • edit_entry
    • to retrieve unpublished entry
path Parameters
site_id
required
integer
tag_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of entries to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "authored_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: authored_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return entries in descending order.

ascend

Return entries in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

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.

Unpublish

entry_status is 6.

maxComments
integer

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
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of pages that related with specific tag.

  • Authorization is required to include unpublished pages.

Permissions

  • manage_pages
    • to retrieve unpublished page
path Parameters
site_id
required
integer
tag_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "title,body,more,keywords,excerpt,basename"

The comma separated field name list to search.

Default: title,body,more,keywords,excerpt,basename

limit
integer
Default: "10"

Maximum number of pages to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "modified_on"
Enum: "authored_on" "title" "created_on" "modified_on"

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

  • authored_on
  • title
  • created_on
  • modified_on

Default: modified_on

sortOrder
string
Default: "descend"
Enum: "descend" "ascend"

descend

Return pages in descending order.

ascend

Return pages in ascending order.

Default: descend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "Draft" "Publish" "Review" "Future" "Spam" "Unpublish"

Filter by container page'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.

Unpublish

entry_status is 6.

maxComments
integer

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

maxTrackbacks
integer

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.

noTextFilter
integer
Enum: 0 1

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

TemplateMaps

Retrieve a list of templatemaps in the specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
query Parameters
search
string

Search query.

searchFields
string

The comma separated field name list to search.

limit
integer
Default: "10"

Maximum number of templatemaps to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "id"

Default: id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return templatemaps in descending order.

ascend

Return templatemaps in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new templatemap

Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (templatemap_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Delete an existing templatemap

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
templatemap_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Retrieve a single templatemap by its ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
templatemap_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Update an existing templatemap

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
templatemap_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (templatemap_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Templates

Reset all templates in the site

  • Authorization is required.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
refresh_type
string
Default: "refresh"
Enum: "refresh" "clean"

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.

Default: refresh

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of templates in the specified site

  • Authorization is required.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name,templateType,text"

The comma separated field name list to search.

Default: name,templateType,text

limit
integer
Default: "10"

Maximum number of templates to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"
Enum: "id" "name" "created_on" "modified_on" "created_by" "modified_by" "type"

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.

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return templates in descending order.

ascend

Return templates in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

type
string

Filter by template type. The list should be separated by commas. (e.g. archive, custom, index, individual, page etc...)

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new template

  • Authorization is required.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (template_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Make a preview for a template

  • Authorization is required.
  • This endpoint has been available since Movable Type 6.1.2.
  • type parameter in the Templates resource is required.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (template)

Updatable fields are name, type, text, outputFile, templateType, linkToFile, buildType, customFields, contentType

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Delete a template

  • Authorization is required.

Permissions

  • edit_templates

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Retrieve single template by its ID

  • Authorization is required.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Update a template

  • Authorization is required.

Permissions

  • edit_templates

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (template_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Make a clone of a template

  • Authorization is required.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Make a preview for a template with existing data

  • Authorization is required.
  • This endpoint has been available since Movable Type 6.1.2.
  • 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.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
query Parameters
raw
integer
Default: 0
Enum: 0 1

If specify "1", will be returned preview contents.

Request Body schema: application/x-www-form-urlencoded
object (template)

Updatable fields are name, type, text, outputFile, templateType, linkToFile, buildType, customFields, contentType

Responses

Response samples

Content type
application/json
{
  • "preview": "string",
  • "status": "string"
}

Publish a template

  • Authorization is required.
  • Only available for following templates
    • index
    • archive
    • individual
    • page
    • category

Permissions

  • rebuild
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Reset template text to theme default or tempalte_set default

  • Authorization is required.

Permissions

  • edit_templates
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "status": "string"
}

Retrieve a list of templatemaps in the specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
query Parameters
search
string

Search query.

searchFields
string

The comma separated field name list to search.

limit
integer
Default: "10"

Maximum number of templatemaps to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "id"

Default: id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return templatemaps in descending order.

ascend

Return templatemaps in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new templatemap

Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (templatemap_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Delete an existing templatemap

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
templatemap_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Retrieve a single templatemap by its ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
templatemap_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Update an existing templatemap

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
template_id
required
integer
templatemap_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (templatemap_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveType": "string",
  • "buildType": "string",
  • "fileTemplate": "string",
  • "id": 0,
  • "isPreferred": true,
  • "updatable": true
}

Themes

Export site's theme

  • Authentication is required
  • This endpoint will export current theme elements of specified site into theme directory.

Permissions

  • manage_themes
Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of themes for site

  • Authentication is required

Permissions

  • manage_themes
Authorizations:
mtauth
path Parameters
site_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a single theme by its ID for site

  • Authentication is required

Permissions

  • manage_themes
Authorizations:
mtauth
path Parameters
site_id
required
integer
theme_id
required
string

Responses

Response samples

Content type
application/json
{
  • "authorLink": "string",
  • "authorName": "string",
  • "description": "string",
  • "id": "string",
  • "inUse": true,
  • "label": "string",
  • "uninstallable": true,
  • "version": "string"
}

Apply a theme to site

  • Authentication is required

Permissions

  • manage_themes
Authorizations:
mtauth
path Parameters
site_id
required
integer
theme_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Retrieve a list of themes

  • Authentication is required

Permissions

  • manage_themes
Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Uninstall a specified theme from the MT

  • Authentication is required
  • When successful, you can take Themes Resource that was deleted. However, this theme is already removed from the Movable Type. You cannot apply this theme to.

Permissions

  • manage_themes

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
theme_id
required
string

Responses

Response samples

Content type
application/json
{
  • "authorLink": "string",
  • "authorName": "string",
  • "description": "string",
  • "id": "string",
  • "inUse": true,
  • "label": "string",
  • "uninstallable": true,
  • "version": "string"
}

Retrieve a single theme by its ID

  • Authentication is required

Permissions

  • manage_themes
Authorizations:
mtauth
path Parameters
theme_id
required
string

Responses

Response samples

Content type
application/json
{
  • "authorLink": "string",
  • "authorName": "string",
  • "description": "string",
  • "id": "string",
  • "inUse": true,
  • "label": "string",
  • "uninstallable": true,
  • "version": "string"
}

Trackbacks

Retrieve a list of trackbacks for an entry

Retrieve a list of trackbacks for an entry.

Authorization is required to include unpublished trackbacks

path Parameters
site_id
required
integer
entry_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of trackbacks to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of trackbacks for a page

Retrieve a list of trackbacks for an page.

Authorization is required to include unpublished trackbacks

path Parameters
site_id
required
integer
page_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of trackbacks to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of trackbacks

Retrieve a list of trackbacks.

Authorization is required to include unpublished trackbacks

path Parameters
site_id
required
integer
query Parameters
limit
integer

This is an optional parameter. Maximum number of trackbacks to retrieve. Default is 10.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

includeIds
string

This is an optional parameter. The comma separated ID list of trackbacks to include to result.

excludeIds
string

This is an optional parameter. The comma separated ID list of trackbacks to exclude from result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Delete a trackbacks

Delete a trackbacks.

Authorization is required.

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
ping_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "blogName": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": "string",
  • "excerpt": "string",
  • "id": 0,
  • "ip": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "title": "string",
  • "updatable": true,
  • "url": "string"
}

Retrieve a single trackback by its ID

Retrieve a single trackback by its ID.

Authorization is required if the trackback status is "unpublished". If the trackback status is "published", then this method can be called without authorization.

path Parameters
site_id
required
integer
ping_id
required
integer
header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "blogName": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": "string",
  • "excerpt": "string",
  • "id": 0,
  • "ip": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "title": "string",
  • "updatable": true,
  • "url": "string"
}

Update a trackbacks

Update a trackbacks.

Authorization is required.

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
ping_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (trackback_updatable)

Responses

Response samples

Content type
application/json
{
  • "blog": {
    },
  • "blogName": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "date": "2019-08-24T14:15:22Z",
  • "entry": "string",
  • "excerpt": "string",
  • "id": 0,
  • "ip": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "title": "string",
  • "updatable": true,
  • "url": "string"
}

Users

Send the link for password recovery to specified email

  • This method always returns successful code if it does not found a user, because security reason.
  • Authentication is not required.

Permissions

  • administer
Request Body schema: application/x-www-form-urlencoded
email
string

Email address for user

name
string

Name for user

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Retrieve a list of users in the specified site

  • Authentication is required to include non-active users or to get private properties.

Permissions

  • administer
    • to retrieve non-active users
    • to read private properties
query Parameters
search
string

Search query.

searchFields
string
Default: "name,displayName,email,url"

The comma separated field name list to search.

Default: name,displayName,email,url

limit
integer
Default: "10"

Maximum number of users to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"
Enum: "id" "name"

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

  • id
  • name

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return users in descending order.

ascend

Return users in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

status
string
Enum: "active" "disabled" "pending"

Filter by users's status.

active

status is Active

disabled

status is Disabled.

pending

status is Pending

lockout
string
Enum: "locked_out" "not_locked_out"

Filter by user's lockout status.

locked_out

Locked out user only

not_locked_out

Not locked out user only

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new user

  • Authentication is required.

Permissions

  • administer
Authorizations:
mtauth
Request Body schema: application/x-www-form-urlencoded
object (user_updatable)

Responses

Response samples

Content type
application/json
{
  • "apiPassword": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "dateFormat": "string",
  • "displayName": "string",
  • "email": "string",
  • "id": 0,
  • "isSuperuser": true,
  • "language": "string",
  • "lockedOut": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "password": "string",
  • "status": "string",
  • "systemPermissions": [
    ],
  • "tagDelimiter": "string",
  • "textFormat": "string",
  • "updatable": true,
  • "url": "string",
  • "userpicUrl": "string"
}

Export users

Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Import users

Authorizations:
mtauth
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "result": "string",
  • "status": "string"
}

Synchronize users

Authorizations:
mtauth

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Delete user

  • Authentication is required.
  • Cannot delete oneself. Also, cannot delete system administrator user.

Permissions

  • administer

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "apiPassword": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "dateFormat": "string",
  • "displayName": "string",
  • "email": "string",
  • "id": 0,
  • "isSuperuser": true,
  • "language": "string",
  • "lockedOut": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "password": "string",
  • "status": "string",
  • "systemPermissions": [
    ],
  • "tagDelimiter": "string",
  • "textFormat": "string",
  • "updatable": true,
  • "url": "string",
  • "userpicUrl": "string"
}

Retrieve a single user by its ID

Retrieve a single user by its ID.

Authorization is required if you want to retrieve private properties.

path Parameters
user_id
required
string
query Parameters
fields
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "apiPassword": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "dateFormat": "string",
  • "displayName": "string",
  • "email": "string",
  • "id": 0,
  • "isSuperuser": true,
  • "language": "string",
  • "lockedOut": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "password": "string",
  • "status": "string",
  • "systemPermissions": [
    ],
  • "tagDelimiter": "string",
  • "textFormat": "string",
  • "updatable": true,
  • "url": "string",
  • "userpicUrl": "string"
}

Update user data

Update user data.

Authorization is required.

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
user_id
required
string
Request Body schema: application/x-www-form-urlencoded
object (user_updatable)

Responses

Response samples

Content type
application/json
{
  • "apiPassword": "string",
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "dateFormat": "string",
  • "displayName": "string",
  • "email": "string",
  • "id": 0,
  • "isSuperuser": true,
  • "language": "string",
  • "lockedOut": true,
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "password": "string",
  • "status": "string",
  • "systemPermissions": [
    ],
  • "tagDelimiter": "string",
  • "textFormat": "string",
  • "updatable": true,
  • "url": "string",
  • "userpicUrl": "string"
}

Retrieve a list of groups

Authorizations:
mtauth
path Parameters
user_id
required
string
query Parameters
search
string

Search query.

searchFields
string
Default: "name,displayName,description"

The comma separated field name list to search.

Default: name,displayName,description

limit
integer
Default: "25"

Maximum number of groups to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return groups in descending order.

ascend

Return groups in ascending order.

Default: ascend

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a list of permissions for user

  • Authentication is required
  • If you want to get others list, you should have Administer privilege.
Authorizations:
mtauth
path Parameters
user_id
required
string
query Parameters
limit
integer
Default: "25"

Maximum number of permissions to retrieve.

Default: 25

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "blog_id"
Enum: "id" "blog_id" "author_id" "created_by" "created_on"

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

  • id
  • blog_id
  • author_id
  • created_by
  • created_on

Default: blog_id

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return permissions in descending order.

ascend

Return permissions in ascending order.

Default: ascend

fields
string

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

blogIds
string

The comma-separated blog id list that to be included in the result.

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Grant permissions to user

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
user_id
required
string
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Revoke permissions from user

  • Authentication is required
  • You should have revoke_role(Need revoke_administer_role when granting role having administer_blog )
Authorizations:
mtauth
path Parameters
user_id
required
string
Request Body schema: application/x-www-form-urlencoded
role_id
integer

The role ID

site_id
integer

The site ID

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Send the link for password recovery to specified user by email

  • Authentication is required.

Permissions

  • administer
Authorizations:
mtauth
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "string"
}

Retrieve a list of blogs by user

Retrieve a list of blogs by user.

path Parameters
user_id
required
string
query Parameters
limit
integer

This is an optional parameter. Maximum number of blogs to retrieve. Default is 25.

offset
integer

This is an optional parameter. 0-indexed offset. Default is 0.

sortBy
string
Enum: "name" "created_on"

This is an optional parameter.

name

(default) Sort by the name of each blogs.

created_on

Sort by the created time of each blogs.

sortOrder
string
Enum: "ascend" "descend"

This is an optional parameter.

ascend

(default) Return blogs in ascending order. For the date, it means from oldest to newset.

descend

Return blogs in descending order. For the date, it means from newest to oldest.

includeIds
string

This is an optional parameter. The comma separated ID list of blogs to include to result.

excludeIds
string

This is an optional parameter. The comma separated ID list of blogs to exclude from result.

fields
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

header Parameters
X-MT-Authorization
string

Input MTAuth accessToken={accessToken}

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Unlock user account

  • Authentication is required.

Permissions

  • administer
Authorizations:
mtauth
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Widgets

Retrieve a list of widgets in the specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name,text"

The comma separated field name list to search.

Default: name,text

limit
integer
Default: "10"

Maximum number of widgets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return widgets in descending order.

ascend

Return widgets in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new widget

Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (template_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Delete a widget

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
widget_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Retrieve a single widget by its ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
widget_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Update a widget

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
widget_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (template_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Make a clone of a widget

Authorizations:
mtauth
path Parameters
site_id
required
integer
widget_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Reset widget text to default

Authorizations:
mtauth
path Parameters
site_id
required
integer
widget_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "messages": [
    ],
  • "status": "string"
}

Retrieve a list of widgets in the specified widgetset

Authorizations:
mtauth
path Parameters
site_id
required
integer
widgetset_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name,text"

The comma separated field name list to search.

Default: name,text

limit
integer
Default: "10"

Maximum number of widgets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return widgets in descending order.

ascend

Return widgets in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a single widget by widgetset ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
widgetset_id
required
integer
widget_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

WidgetSets

Retrieve a list of widgetsets in the specified site

Authorizations:
mtauth
path Parameters
site_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name"

The comma separated field name list to search.

Default: name

limit
integer
Default: "10"

Maximum number of widgetsets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return widgetsets in descending order.

ascend

Return widgetsets in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Create a new widgetset

Authorizations:
mtauth
path Parameters
site_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (template_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Delete an existing widgetset

Notes

  • This method accepts DELETE and POST with __method=DELETE.
Authorizations:
mtauth
path Parameters
site_id
required
integer
widgetset_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Retrieve a single widgetset by its ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
widgetset_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Update an existing widgetset

Notes

  • This method accepts PUT and POST with __method=PUT.
Authorizations:
mtauth
path Parameters
site_id
required
integer
widgetset_id
required
integer
Request Body schema: application/x-www-form-urlencoded
object (template_updatable)

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}

Retrieve a list of widgets in the specified widgetset

Authorizations:
mtauth
path Parameters
site_id
required
integer
widgetset_id
required
integer
query Parameters
search
string

Search query.

searchFields
string
Default: "name,text"

The comma separated field name list to search.

Default: name,text

limit
integer
Default: "10"

Maximum number of widgets to retrieve.

Default: 10

offset
integer
Default: "0"

0-indexed offset.

Default: 0

sortBy
string
Default: "name"

Default: name

sortOrder
string
Default: "ascend"
Enum: "descend" "ascend"

descend

Return widgets in descending order.

ascend

Return widgets in ascending order.

Default: ascend

fields
string

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

includeIds
string

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

excludeIds
string

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

dateField
string
Default: "created_on"

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

dateFrom
string

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

dateTo
string

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

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "totalResults": 0
}

Retrieve a single widget by widgetset ID

Authorizations:
mtauth
path Parameters
site_id
required
integer
widgetset_id
required
integer
widget_id
required
integer
query Parameters
fields
string

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

Responses

Response samples

Content type
application/json
{
  • "archiveTypes": [
    ],
  • "blog": {
    },
  • "buildType": "string",
  • "contentType": {
    },
  • "createdBy": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "customFields": [
    ],
  • "id": 0,
  • "linkToFile": "string",
  • "modifiedBy": {
    },
  • "modifiedDate": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "outputFile": "string",
  • "templateType": "string",
  • "text": "string",
  • "type": "string",
  • "updatable": true,
  • "widgets": [
    ]
}