-
Notifications
You must be signed in to change notification settings - Fork 9
Data api entries list
masiuchi edited this page Sep 11, 2014
·
1 revision
Retrieve a list of entries.
Authorization is required if want to include unpublished entries.
This method accepts GET only.
GET https://your-host/your-mt-api.cgi/v1/sites/{blog_id}/entries
Parameter | Type | Description |
---|---|---|
blog_id | unsigned integer | The blog ID. |
Parameter | Type | Description |
---|---|---|
search | string | This is an optional parameter. Search query. |
searchFields | string | This is an optional parameter. The comma separated field name list to search. Default is 'title,body,more,keywords,excerpt,basename' |
status | string | This is an optional parameter. Filter by status.
|
limit | unsigned integer | This is an optional parameter. Maximum number of entries to retrieve. Default is 10. |
offset | unsigned 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 entries to include to result. |
excludeIds | string | This is an optional parameter. The comma separated ID list of entries to exclude from result. |
sortBy | string | This is an optional parameter.
|
sortOrder | string | This is an optional parameter.
|
maxComments | unsigned 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 | unsigned 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 Entries resource. That list should be separated by comma. If this parameter is not specified, All fields will be returned. |
Do not supply a request body.
Parameter | Type | Description |
---|---|---|
totalResults | unsigned integer | The total number of entries found that by the request. |
items | ARRAY | An array of Entries resource. |
Code | Description |
---|---|
200 | no error |
403 | Do not have permission to retrieve the list of entries. |
404 | Site not found |