---
title: List custom pages
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Custom Pages](https://developers.cloudflare.com/api/resources/custom_pages)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# List custom pages
GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/custom\_pages
Lists all custom page configurations for an account or zone.
##### Security
API Email + API Key
The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
**Example:**`X-Auth-Email: user@example.com`
The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`
##### Accepted Permissions (at least one required)
`Zero Trust: PII Read``Account Custom Pages Write``Account Custom Pages Read``Account Settings Write``Account Settings Read`
##### P ath ParametersExpand Collapse
account\_id: optional string
The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
zone\_id: optional string
The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20list%20%3E%20(params)%20default%20%3E%20(param)%20zone_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
messages: array of object {code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20messages>)
success: true
Whether the API call was successful.
[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional array of object {id, created\_on, description, 5 more }
id: optional string
Link to this property
created\_on: optional string
formatdate-time
Link to this property
description: optional string
Link to this property
modified\_on: optional string
formatdate-time
Link to this property
preview\_target: optional string
Link to this property
required\_tokens: optional array of string
Link to this property
state: optional "default"or "customized"
The custom page state.
One of the following:
"default"
Link to this property
"customized"
Link to this property
Link to this property
url: optional string
The URL associated with the custom page.
formaturi
Link to this property
[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
result\_info: optional object {count, page, per\_page, 2 more }
count: optional number
Total number of results for the requested service.
Link to this property
page: optional number
Current page within paginated list of results.
Link to this property
per\_page: optional number
Number of results per page of results.
Link to this property
total\_count: optional number
Total results available without any search parameters.
Link to this property
total\_pages: optional number
The number of total pages in the entire result set.
Link to this property
[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20list%20%3E%20(network%20schema)%20%3E%20(property)%20result_info>)
### List custom pages
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/$ACCOUNTS_OR_ZONES/$ACCOUNT_OR_ZONE_ID/custom_pages \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY"
```
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"description": "Basic Challenge",
"modified_on": "2014-01-01T05:20:00.12345Z",
"preview_target": "block:basic-sec-captcha",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"state": "default",
"url": "http://www.example.com"
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}
```
##### Returns Examples
200 example
```
{
"errors": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"messages": [
{
"code": 1000,
"message": "message",
"documentation_url": "documentation_url",
"source": {
"pointer": "pointer"
}
}
],
"success": true,
"result": [
{
"id": "basic_challenge",
"created_on": "2014-01-01T05:20:00.12345Z",
"description": "Basic Challenge",
"modified_on": "2014-01-01T05:20:00.12345Z",
"preview_target": "block:basic-sec-captcha",
"required_tokens": [
"::CAPTCHA_BOX::"
],
"state": "default",
"url": "http://www.example.com"
}
],
"result_info": {
"count": 1,
"page": 1,
"per_page": 20,
"total_count": 2000,
"total_pages": 100
}
}
```