> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.botbye.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.botbye.com/_mcp/server.

# list

GET https://api.botbye.com/api/v1/{account_id}/projects/{project_id}/captcha-records

# Get Captcha Task Records

Retrieves a paginated list of captcha tasks issued for a project, one row per task, with what became of it.

## Endpoint

```
GET {base_url}/api/v1/{account_id}/projects/{project_id}/captcha-records
```

## Authentication

Requires API key authentication:

```
Authorization: Bearer {api_key}
```

## Path Parameters

| Parameter    | Type   | Required | Description                                      |
| ------------ | ------ | -------- | ------------------------------------------------ |
| `account_id` | string | Yes      | Your unique BotBye account identifier            |
| `project_id` | string | Yes      | The project to retrieve captcha task records for |

## Query Parameters

* **Pagination**: cursor-based (`cursor`). By default a page holds 20 records, max 100.
* **Filtering**: `where` accepts `task_id`, `created_at`, `updated_at`, `solved_at`, `status`, `visitor_id`, `account_id` and `custom_fields`. A `custom_fields` condition names its key. A `status` condition names the state (`SOLVED`), not a number, and `in` takes the list either as `['SOLVED','REDEEMED']` or as `SOLVED,REDEEMED`. Predicates `is_null`, `is_not_null`, `has_any` and `has_all` are not accepted.
* **Ordering**: `order_by` accepts `created_at` and `task_id`; records are returned newest first by default.
* **Total**: `total=true` adds the number of matching tasks to `pageInfo`.

## Response Structure

Cursor-based pagination. Each `node` is one captcha task:

| Field          | Type   | Description                                                                                                   |
| -------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| `taskId`       | string | The captcha task id, as handed to the browser and later presented with the protected request                  |
| `createdAt`    | string | Timestamp (epoch millis) the task was issued                                                                  |
| `status`       | string | `ISSUED`, `SOLVE_FAILED`, `SOLVED`, `EXPIRED`, `REDEEMED` or `REPLAYED` — the furthest state the task reached |
| `updatedAt`    | string | Timestamp (epoch millis) of the last state change; absent while the task is only issued                       |
| `solvedAt`     | string | Timestamp (epoch millis) the task was solved; absent while it is unsolved                                     |
| `visitorId`    | string | Visitor that redeemed the task; empty unless the task was redeemed with a verified token                      |
| `accountId`    | string | End-user account that redeemed the task; empty under the same condition                                       |
| `customFields` | object | The fields your integration passed when the task was issued                                                   |

**pageInfo** carries `hasPreviousPage`, `hasNextPage`, `startCursor`, `endCursor` and `total` (the number of matching tasks).

## Use Cases

* **Support**: show a user's captcha history when they report being unable to pass a challenge.
* **Integration debugging**: follow one of your own identifiers, passed as a custom field, from issue to redemption.
* **Abuse review**: see how a visitor or account has been solving captchas.

> **Accepted permissions**
> `Project → Events → View → Captcha`
>
> **Token scope**
> `Request View`

Reference: https://api-docs.botbye.com/bot-bye-api/protection/captcha-records/list

## Authentication

- `X-Api-Key` header (required) — Personal access token. Create it in your BotBye account under **Profile → Personal Access Tokens**, tick the scopes the endpoints you call require (see each endpoint's **Token scope**), and send the token in the `X-Api-Key` request header. A token works only for the account it was created in.

## Request

### Path parameters

- `account_id` (string, required)
- `project_id` (string, required)

### Query parameters

- `cursor` (string, optional) — (Optional): a cursor for pagination. - `after` (string): Pointer to the item after which the items are to be retrieved. - `before` (string): Pointer to the item before which the items are to be retrieved.
- `where` (string, optional) — (Optional): is used to create conditions for data filtering. It can be used to create simple conditions (leaf nodes) as well as compound logical expressions (branch nodes). - `predicate` (string): The filtering condition (e.g., `gte`, `lte`, `eq` for a leaf or `and`, `or` for a branch). Possible values [[#Predicate]] - `opearands` (string): A list of nested conditions (used only for branches, such as `and`, `or`). - `fieldPath` (string): The field to which the filtering condition is applied (used only for a leaf. Each entity has its own fieldPath list). - `value` (string): The value to compare against the field (used only for a leaf).
- `order_by` (string, optional) — (Optional): property by which to order by. - `fieldPath` (string): name of order field. - `direction` (string): `ASC` or `DESC`
- `total` (string, optional) — (Optional): when `true`, `pageInfo.total` carries the number of matching tasks.

## Response

### 200

success

- `edges` (list of object, required)
  - `cursor` (string, required)
  - `node` (object, required)
    - `taskId` (string, required)
    - `createdAt` (string, required)
    - `visitorId` (string, required)
    - `accountId` (string, required)
    - `customFields` (map from string to string, required)
    - `status` (enum, optional)
      - Allowed values: `ISSUED`, `SOLVE_FAILED`, `SOLVED`, `EXPIRED`, `REDEEMED`, `REPLAYED`
    - `updatedAt` (string, optional)
    - `solvedAt` (string, optional)
- `pageInfo` (object, required)
  - `hasPreviousPage` (boolean, required)
  - `hasNextPage` (boolean, required)
  - `total` (integer, required)
  - `startCursor` (string, optional)
  - `endCursor` (string, optional)
- `attributes` (object, required)

## Errors

### 400 Bad Request Error

fail

- `list of object`
  - `message` (string, required)
  - `code` (string, required)
  - `type` (string, required)
  - `context` (object, optional)
    - `param` (string, optional)
    - `type` (string, optional)

## Examples

**Response**

```json
{
  "edges": [
    {
      "cursor": "string",
      "node": {
        "taskId": "string",
        "createdAt": "string",
        "visitorId": "string",
        "accountId": "string",
        "customFields": {},
        "status": "ISSUED",
        "updatedAt": "string",
        "solvedAt": "string"
      }
    }
  ],
  "pageInfo": {
    "hasPreviousPage": true,
    "hasNextPage": true,
    "total": 1,
    "startCursor": "string",
    "endCursor": "string"
  },
  "attributes": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records"

querystring = {"cursor":"","where":"","order_by":"","total":""}

headers = {"X-Api-Key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records?cursor=&where=&order_by=&total=';
const options = {method: 'GET', headers: {'X-Api-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records?cursor=&where=&order_by=&total="

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records?cursor=&where=&order_by=&total=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records?cursor=&where=&order_by=&total=")
  .header("X-Api-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records?cursor=&where=&order_by=&total=', [
  'headers' => [
    'X-Api-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records?cursor=&where=&order_by=&total=");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Api-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-Api-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.botbye.com/api/v1/account_id/projects/project_id/captcha-records?cursor=&where=&order_by=&total=")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```