## List custom pages

`client.customPages.list(CustomPageListParamsparams?, RequestOptionsoptions?): SinglePage<CustomPageListResponse>`

**get** `/{accounts_or_zones}/{account_or_zone_id}/custom_pages`

Fetches all the custom pages.

### Parameters

- `params: CustomPageListParams`

  - `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.

### Returns

- `CustomPageListResponse`

  - `id?: string`

  - `created_on?: string`

  - `description?: string`

  - `modified_on?: string`

  - `preview_target?: string`

  - `required_tokens?: Array<string>`

  - `state?: "default" | "customized"`

    The custom page state.

    - `"default"`

    - `"customized"`

  - `url?: string`

    The URL associated with the custom page.

### Example

```node
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
});

// Automatically fetches more pages as needed.
for await (const customPageListResponse of client.customPages.list({ account_id: 'account_id' })) {
  console.log(customPageListResponse.id);
}
```

#### Response

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