## List Turnstile Widgets

`client.Turnstile.Widgets.List(ctx, params) (*V4PagePaginationArray[WidgetListResponse], error)`

**get** `/accounts/{account_id}/challenges/widgets`

Lists all turnstile widgets of an account.

### Parameters

- `params WidgetListParams`

  - `AccountID param.Field[string]`

    Path param: Identifier

  - `Direction param.Field[WidgetListParamsDirection]`

    Query param: Direction to order widgets.

    - `const WidgetListParamsDirectionAsc WidgetListParamsDirection = "asc"`

    - `const WidgetListParamsDirectionDesc WidgetListParamsDirection = "desc"`

  - `Filter param.Field[string]`

    Query param: Filter widgets by field using case-insensitive substring matching.
    Format: `field:value`

    Supported fields:

    - `name` - Filter by widget name (e.g., `filter=name:login-form`)
    - `sitekey` - Filter by sitekey (e.g., `filter=sitekey:0x4AAA`)

    Returns 400 Bad Request if the field is unsupported or format is invalid.
    An empty filter value returns all results.

  - `Order param.Field[WidgetListParamsOrder]`

    Query param: Field to order widgets by.

    - `const WidgetListParamsOrderID WidgetListParamsOrder = "id"`

    - `const WidgetListParamsOrderSitekey WidgetListParamsOrder = "sitekey"`

    - `const WidgetListParamsOrderName WidgetListParamsOrder = "name"`

    - `const WidgetListParamsOrderCreatedOn WidgetListParamsOrder = "created_on"`

    - `const WidgetListParamsOrderModifiedOn WidgetListParamsOrder = "modified_on"`

  - `Page param.Field[float64]`

    Query param: Page number of paginated results.

  - `PerPage param.Field[float64]`

    Query param: Number of items per page.

### Returns

- `type WidgetListResponse struct{…}`

  A Turnstile Widgets configuration as it appears in listings

  - `BotFightMode bool`

    If bot_fight_mode is set to `true`, Cloudflare issues computationally
    expensive challenges in response to malicious bots (ENT only).

  - `ClearanceLevel WidgetListResponseClearanceLevel`

    If Turnstile is embedded on a Cloudflare site and the widget should grant challenge clearance,
    this setting can determine the clearance level to be set

    - `const WidgetListResponseClearanceLevelNoClearance WidgetListResponseClearanceLevel = "no_clearance"`

    - `const WidgetListResponseClearanceLevelJschallenge WidgetListResponseClearanceLevel = "jschallenge"`

    - `const WidgetListResponseClearanceLevelManaged WidgetListResponseClearanceLevel = "managed"`

    - `const WidgetListResponseClearanceLevelInteractive WidgetListResponseClearanceLevel = "interactive"`

  - `CreatedOn Time`

    When the widget was created.

  - `Domains []WidgetDomain`

  - `EphemeralID bool`

    Return the Ephemeral ID in /siteverify (ENT only).

  - `Mode WidgetListResponseMode`

    Widget Mode

    - `const WidgetListResponseModeNonInteractive WidgetListResponseMode = "non-interactive"`

    - `const WidgetListResponseModeInvisible WidgetListResponseMode = "invisible"`

    - `const WidgetListResponseModeManaged WidgetListResponseMode = "managed"`

  - `ModifiedOn Time`

    When the widget was modified.

  - `Name string`

    Human readable widget name. Not unique. Cloudflare suggests that you
    set this to a meaningful string to make it easier to identify your
    widget, and where it is used.

  - `Offlabel bool`

    Do not show any Cloudflare branding on the widget (ENT only).

  - `Region WidgetListResponseRegion`

    Region where this widget can be used. This cannot be changed after creation.

    - `const WidgetListResponseRegionWorld WidgetListResponseRegion = "world"`

    - `const WidgetListResponseRegionChina WidgetListResponseRegion = "china"`

  - `Sitekey string`

    Widget item identifier tag.

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/turnstile"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Turnstile.Widgets.List(context.TODO(), turnstile.WidgetListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}
```

#### 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": [
    {
      "bot_fight_mode": false,
      "clearance_level": "interactive",
      "created_on": "2014-01-01T05:20:00.123123Z",
      "domains": [
        "203.0.113.1",
        "cloudflare.com",
        "blog.example.com"
      ],
      "ephemeral_id": false,
      "mode": "invisible",
      "modified_on": "2014-01-01T05:20:00.123123Z",
      "name": "blog.cloudflare.com login form",
      "offlabel": false,
      "region": "world",
      "sitekey": "0x4AAF00AAAABn0R22HWm-YUc"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
```