Built-in tool
List WordPress Posts and Pages
List or search the posts and pages of a connected WordPress website, with their status and addresses.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| pagenumber · optional | number | optional | The page of results, starting at 1; totalPages says how many there are. Default: |
| sitestring · optional | string | optional | Which connected WordPress site, when several are connected: its address (example.com), its name or its account id. Leave out when only one is connected. |
| slugstring · optional | string | optional | The exact slug: the last part of the address, for example "pricing". |
| typestring · optional | string | optional | post for blog posts and articles (default), page for standing pages such as Pricing or About. One of: Default: |
| limitnumber · optional | number | optional | How many to return, 1 to 50. Defaults to 20. Default: |
| searchstring · optional | string | optional | Words to look for in the title and text. |
| statusstring · optional | string | optional | publish is live, future is scheduled, draft and pending are not live. any (default) lists every status this WordPress user may see. One of: Default: |
| orderBystring · optional | string | optional | modified (default) and date list newest first; title is alphabetical. One of: Default: |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"site",
"items",
"total",
"totalPages",
"page"
],
"properties": {
"note": {
"type": "string"
},
"page": {
"type": "number"
},
"site": {
"type": "object",
"required": [
"name",
"url"
],
"properties": {
"url": {
"type": "string"
},
"name": {
"type": "string"
}
},
"additionalProperties": false
},
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"type",
"status",
"title",
"slug",
"url",
"editUrl",
"date",
"modified"
],
"properties": {
"id": {
"type": "number"
},
"url": {
"type": "string"
},
"date": {
"type": [
"string",
"null"
]
},
"slug": {
"type": "string"
},
"type": {
"enum": [
"post",
"page"
],
"type": "string"
},
"title": {
"type": "string"
},
"status": {
"type": "string"
},
"editUrl": {
"type": "string"
},
"modified": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
}
},
"total": {
"type": [
"number",
"null"
]
},
"totalPages": {
"type": [
"number",
"null"
]
}
},
"additionalProperties": false
}