--- title: Get a custom page --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Custom Pages](https://developers.cloudflare.com/api/go/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(ctx, identifier, query) (\*[CustomPageGetResponse](), error) 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 CustomPageGetParamsIdentifier Custom page type. One of the following: const CustomPageGetParamsIdentifier1000Errors CustomPageGetParamsIdentifier = "1000\_errors" Link to this property const CustomPageGetParamsIdentifier500Errors CustomPageGetParamsIdentifier = "500\_errors" Link to this property const CustomPageGetParamsIdentifierBasicChallenge CustomPageGetParamsIdentifier = "basic\_challenge" Link to this property const CustomPageGetParamsIdentifierCountryChallenge CustomPageGetParamsIdentifier = "country\_challenge" Link to this property const CustomPageGetParamsIdentifierIPBlock CustomPageGetParamsIdentifier = "ip\_block" Link to this property const CustomPageGetParamsIdentifierManagedChallenge CustomPageGetParamsIdentifier = "managed\_challenge" Link to this property const CustomPageGetParamsIdentifierRatelimitBlock CustomPageGetParamsIdentifier = "ratelimit\_block" Link to this property const CustomPageGetParamsIdentifierUnderAttack CustomPageGetParamsIdentifier = "under\_attack" Link to this property const CustomPageGetParamsIdentifierWAFBlock CustomPageGetParamsIdentifier = "waf\_block" Link to this property const CustomPageGetParamsIdentifierWAFChallenge CustomPageGetParamsIdentifier = "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)>)
query CustomPageGetParams AccountID param.Field\[string]Optional The Account ID to use for this endpoint. Mutually exclusive with the Zone ID. Link to this property ZoneID param.Field\[string]Optional 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
type CustomPageGetResponse struct{…} ID stringOptional Link to this property CreatedOn TimeOptional formatdate-time Link to this property Description stringOptional Link to this property ModifiedOn TimeOptional formatdate-time Link to this property PreviewTarget stringOptional Link to this property RequiredTokens \[]stringOptional Link to this property
State CustomPageGetResponseStateOptional The custom page state. One of the following: const CustomPageGetResponseStateDefault CustomPageGetResponseState = "default" Link to this property const CustomPageGetResponseStateCustomized CustomPageGetResponseState = "customized" Link to this property
Link to this property URL stringOptional The URL associated with the custom page. formaturi Link to this property
[Link to this property](<#(resource)%20custom_pages%20%3E%20(model)%20CustomPageGetResponse%20%3E%20(schema)>) ### Get a custom page Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/custom_pages" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), option.WithAPIEmail("user@example.com"), ) customPage, err := client.CustomPages.Get( context.TODO(), custom_pages.CustomPageGetParamsIdentifierRatelimitBlock, custom_pages.CustomPageGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", 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" } } ```