---
title: Get a custom page
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Custom Pages](https://developers.cloudflare.com/api/typescript/resources/custom%5Fpages)

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](https://developers.cloudflare.com/api/typescript/resources/custom%5Fpages#%28resource%29%20custom%5Fpages%20%3E%20%28model%29%20custom%5Fpage%5Fget%5Fresponse%20%3E%20%28schema%29) { id, created\_on, description, 5 more } 

GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/custom\_pages/{identifier}

Fetches the details of a custom page.

##### 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

Error Page Types

One of the following:

"1000\_errors"

"500\_errors"

"basic\_challenge"

"country\_challenge"

"ip\_block"

"managed\_challenge"

"ratelimit\_block"

"under\_attack"

"waf\_block"

"waf\_challenge"

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

account\_id?: string

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone\_id?: string

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

##### ReturnsExpand Collapse 

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

id?: string

created\_on?: string

formatdate-time

description?: string

modified\_on?: string

formatdate-time

preview\_target?: string

required\_tokens?: Array<string\>

state?: "default" | "customized"

The custom page state.

One of the following:

"default"

"customized"

url?: string

The URL associated with the custom page.

formaturi

### Get a custom page

TypeScript

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
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"
  }
}
```