List Tasks

List Tasks

curl --request GET \
  --url https://api.anchorbrowser.io/v1/task \
  --header 'anchor-api-key: <api-key>'

{
  "data": {
    "tasks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "latestVersion": "<string>",
        "code": "<string>",
        "language": "typescript",
        "deleted": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "browserConfiguration": {
          "initial_url": "<string>",
          "recording": {
            "active": true
          },
          "proxy": {
            "active": true,
            "type": "anchor_proxy",
            "country_code": "us",
            "region": "<string>",
            "city": "<string>"
          },
          "timeout": {
            "max_duration": 123,
            "idle_timeout": 123
          },
          "live_view": {
            "read_only": true
          }
        }
      }
    ],
    "total": 1,
    "page": 2,
    "limit": 50
  }
}

GET

task

List Tasks

curl --request GET \
  --url https://api.anchorbrowser.io/v1/task \
  --header 'anchor-api-key: <api-key>'

{
  "data": {
    "tasks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "latestVersion": "<string>",
        "code": "<string>",
        "language": "typescript",
        "deleted": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "browserConfiguration": {
          "initial_url": "<string>",
          "recording": {
            "active": true
          },
          "proxy": {
            "active": true,
            "type": "anchor_proxy",
            "country_code": "us",
            "region": "<string>",
            "city": "<string>"
          },
          "timeout": {
            "max_duration": 123,
            "idle_timeout": 123
          },
          "live_view": {
            "read_only": true
          }
        }
      }
    ],
    "total": 1,
    "page": 2,
    "limit": 50
  }
}

Authorizations

anchor-api-key

string

header

required

API key passed in the header

Query Parameters

page

string

default:1

Page number

limit

string

default:10

Number of tasks per page

Response

List of tasks retrieved successfully

data

object

Show child attributes

data.tasks

object[]

required

Show child attributes

data.tasks.id

string<uuid>

required

Unique identifier for the task

data.tasks.name

string

required

Task name (letters, numbers, hyphens, and underscores only)

Required string length: 1 - 255

data.tasks.teamId

string<uuid>

required

Team identifier that owns this task

data.tasks.latestVersion

string

required

Latest version identifier (draft, latest, or version number)

data.tasks.code

string

required

Base64 encoded task code

data.tasks.language

enum<string>

required

Programming language for the task

Available options:

typescript

data.tasks.deleted

boolean

required

Whether the task is soft deleted

data.tasks.createdAt

string<date-time>

required

Task creation timestamp

data.tasks.updatedAt

string<date-time>

required

Task last update timestamp

data.tasks.description

string

Optional description of the task

Maximum string length: 1000

data.tasks.browserConfiguration

object

Browser configuration for task execution

Show child attributes

data.tasks.browserConfiguration.initial_url

string<uri>

The URL to navigate to when the browser session starts. If not provided, the browser will load an empty page.

data.tasks.browserConfiguration.recording

object

Configuration for session recording.

Show child attributes

data.tasks.browserConfiguration.recording.active

boolean

Enable or disable video recording of the browser session. Defaults to true.

data.tasks.browserConfiguration.proxy

Anchor Proxy · object

Proxy Documentation available at Proxy Documentation

Anchor Proxy
Custom Proxy

Show child attributes

data.tasks.browserConfiguration.proxy.active

boolean

required

data.tasks.browserConfiguration.proxy.type

On change make sure to update the country_code.

Create a session with a residential proxy to access websites as if you're browsing from a computer in that country.

Available options:

anchor_proxy,

anchor_residential,

anchor_mobile,

anchor_gov

data.tasks.browserConfiguration.proxy.country_code

default:us

Supported country codes ISO 2 lowercase

On change make sure to update the Proxy type.

Available options:

af,

al,

dz,

ad,

ao,

as,

ag,

ar,

am,

aw,

au,

at,

az,

bs,

bh,

bb,

by,

be,

bz,

bj,

bm,

bo,

ba,

br,

bg,

bf,

cm,

ca,

cv,

td,

cl,

co,

cg,

cr,

ci,

hr,

cu,

cy,

cz,

dk,

dm,

do,

ec,

eg,

sv,

ee,

et,

fo,

fi,

fr,

gf,

pf,

ga,

gm,

ge,

de,

gh,

gi,

gr,

gd,

gp,

gt,

gg,

gn,

gw,

gy,

ht,

hn,

hu,

is,

in,

ir,

iq,

ie,

il,

it,

jm,

jp,

jo,

kz,

kw,

kg,

lv,

lb,

ly,

li,

lt,

lu,

mk,

ml,

mt,

mq,

mr,

mx,

md,

mc,

me,

ma,

nl,

nz,

ni,

ng,

no,

pk,

pa,

py,

pe,

ph,

pl,

pt,

pr,

qa,

ro,

lc,

sm,

sa,

sn,

rs,

sc,

sl,

sk,

si,

so,

za,

kr,

es,

sr,

se,

ch,

sy,

st,

tw,

tj,

tg,

tt,

tn,

tr,

tc,

ua,

ae,

us,

uy,

uz,

ve,

ye

data.tasks.browserConfiguration.proxy.region

string

Region code for more specific geographic targeting. The city parameter can only be used when region is also provided.

data.tasks.browserConfiguration.proxy.city

string

City name for precise geographic targeting. Supported for anchor_proxy only. Can only be used when region is also provided.

data.tasks.browserConfiguration.timeout

object

Timeout configurations for the browser session.

Show child attributes

data.tasks.browserConfiguration.timeout.max_duration

integer

Maximum amount of time (in minutes) for the browser to run before terminating. Defaults to 20.

data.tasks.browserConfiguration.timeout.idle_timeout

integer

The amount of time (in minutes) the browser session waits for new connections after all others are closed before stopping. Defaults to 5.

data.tasks.browserConfiguration.live_view

object

Configuration for live viewing the browser session.

Show child attributes

data.tasks.browserConfiguration.live_view.read_only

boolean

Enable or disable read-only mode for live viewing. Defaults to false.

data.total

integer

required

Total number of tasks

Required range: x >= 0

data.page

integer

required

Current page number

Required range: x >= 1

data.limit

integer

required

Number of tasks per page

Required range: 1 <= x <= 100

Get Batch Session Status Create Task

⌘I

Browser Sessions

Session Recordings

Profiles

Tools

AI Tools

OS Level Control

Agentic capabilities

Extensions

Integrations

Event Coordination

Batch Sessions

Tasks

Authorizations

Query Parameters

Response