## List bots

`client.radar.bots.list(BotListParamsquery?, RequestOptionsoptions?): BotListResponse`

**get** `/radar/bots`

Retrieves a list of bots.

### Parameters

- `query: BotListParams`

  - `botCategory?: "SEARCH_ENGINE_CRAWLER" | "SEARCH_ENGINE_OPTIMIZATION" | "MONITORING_AND_ANALYTICS" | 13 more`

    Filters results by bot category.

    - `"SEARCH_ENGINE_CRAWLER"`

    - `"SEARCH_ENGINE_OPTIMIZATION"`

    - `"MONITORING_AND_ANALYTICS"`

    - `"ADVERTISING_AND_MARKETING"`

    - `"SOCIAL_MEDIA_MARKETING"`

    - `"PAGE_PREVIEW"`

    - `"ACADEMIC_RESEARCH"`

    - `"SECURITY"`

    - `"ACCESSIBILITY"`

    - `"WEBHOOKS"`

    - `"FEED_FETCHER"`

    - `"AI_CRAWLER"`

    - `"AGGREGATOR"`

    - `"AI_ASSISTANT"`

    - `"AI_SEARCH"`

    - `"ARCHIVER"`

  - `botOperator?: string`

    Filters results by bot operator.

  - `botVerificationStatus?: "VERIFIED"`

    Filters results by bot verification status.

    - `"VERIFIED"`

  - `format?: "JSON" | "CSV"`

    Format in which results will be returned.

    - `"JSON"`

    - `"CSV"`

  - `kind?: "AGENT" | "BOT"`

    Filters results by bot kind.

    - `"AGENT"`

    - `"BOT"`

  - `limit?: number`

    Limits the number of objects returned in the response.

  - `offset?: number`

    Skips the specified number of objects before fetching the results.

### Returns

- `BotListResponse`

  - `bots: Array<Bot>`

    - `category: string`

      The category of the bot.

    - `description: string`

      A summary for the bot (e.g., purpose).

    - `kind: string`

      The kind of the bot.

    - `name: string`

      The name of the bot.

    - `operator: string`

      The organization that owns and operates the bot.

    - `slug: string`

      A kebab-case identifier derived from the bot name.

    - `userAgentPatterns: Array<string>`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const bots = await client.radar.bots.list();

console.log(bots.bots);
```

#### Response

```json
{
  "result": {
    "bots": [
      {
        "category": "AI_CRAWLER",
        "description": "OpenAI/ChatGPT's web crawler",
        "kind": "AGENT",
        "name": "GPTBot",
        "operator": "OpenAI",
        "slug": "gptbot",
        "userAgentPatterns": [
          "GPTBot"
        ]
      }
    ]
  },
  "success": true
}
```