--- title: Get a custom page --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Custom Pages](https://developers.cloudflare.com/api/typescript/resources/custom_pages) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Get a custom page client.customPages.get("1000\_errors"| "500\_errors"| "basic\_challenge"| 7 moreidentifier, CustomPageGetParams {account\_id, zone\_id } params?, RequestOptionsoptions?): [CustomPageGetResponse]() {id, created\_on, description, 5 more } GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/custom\_pages/{identifier} Returns the configuration for a custom page type. ##### 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` ##### ParametersExpand Collapse

identifier: "1000\_errors"| "500\_errors"| "basic\_challenge"| 7 more Custom page type.

One of the following: "1000\_errors" Link to this property "500\_errors" Link to this property "basic\_challenge" Link to this property "country\_challenge" Link to this property "ip\_block" Link to this property "managed\_challenge" Link to this property "ratelimit\_block" Link to this property "under\_attack" Link to this property "waf\_block" Link to this property "waf\_challenge" Link to this property

[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20identifier%20%3E%20(schema)>)

params: CustomPageGetParams {account\_id, zone\_id }

account\_id?: string The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property zone\_id?: string The Zone ID to use for this endpoint. Mutually exclusive with the Account ID. Link to this property

[Link to this property](<#(resource)%20custom_pages%20%3E%20(method)%20get%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

CustomPageGetResponse {id, created\_on, description, 5 more }

id?: string Link to this property created\_on?: string formatdate-time Link to this property description?: string Link to this property modified\_on?: string formatdate-time Link to this property preview\_target?: string Link to this property required\_tokens?: Array<string> Link to this property

state?: "default"| "customized" The custom page state.

One of the following: "default" Link to this property "customized" Link to this property

Link to this property url?: string The URL associated with the custom page. formaturi Link to this property

[Link to this property](<#(resource)%20custom_pages%20%3E%20(model)%20custom_page_get_response%20%3E%20(schema)>) ### Get a custom page TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const customPage = await client.customPages.get('ratelimit_block', { account_id: 'account_id' }); console.log(customPage.id); ``` 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" } } ``` ##### 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" } } ```