List Workers

Method: GET

Endpoint: /api/v2/workers

Authentication: Supports Authorization: Bearer <YOUR_API_KEY>, api-key: <YOUR_API_KEY>, and ?token=<YOUR_API_KEY>. Prefer Bearer token.

Try it

GET/api/v2/workersList current user workers

AuthenticationRequired

Auth mode

Authorization: Bearerapi-key headerQuery token

API token

Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.

Parameters

offsetquery · integer · default `1`; minimum 0Optional

Page number, 1-based. `offset=1` is page 1, `offset=2` is page 2; `offset=0` is accepted as page 1. Out-of-range pages return an empty list. Constraints: default `1`; minimum 0.

limitquery · integer · default `20`; range 1-100Optional

Page size. Constraints: default `20`; range 1-100.

keywordquery · stringOptional

Keyword for title, slug, or path.

Request BodyNot applicable

No JSON request body. Fill the path or query parameters above.

Send Request Clear all

When to use this endpoint

Use this endpoint to list Workers available to the authenticated user.

Query Parameters

Parameter	Required	Type	Description
offset	No	integer	Page number, 1-based. offset=1 is page 1, offset=2 is page 2; offset=0 is accepted as page 1. Out-of-range pages return an empty list. Constraints: default 1; minimum 0.
limit	No	integer	Page size. limit is capped at 100 on list and result endpoints. Constraints: default 20; range 1-100.
keyword	No	string	Keyword for title, slug, or path

Request Example

curl -X GET "https://openapi.coreclaw.com/api/v2/workers?offset=1&limit=20&keyword=coffee" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

{
  "code": 0,
  "data": {
    "scraper": [
      {
        "description": "Demo worker description",
        "name": "demo-worker",
        "path": "owner~demo-worker",
        "slug": "demo-worker",
        "title": "Demo Worker",
        "username": "owner"
      }
    ]
  },
  "message": "success",
  "request_id": "req-123"
}

Notes

• API v2 supports Bearer token, the legacy api-key header, and query token. Prefer Bearer token for new integrations.

HTTP Responses

HTTP Status	Application Code	Meaning
200	0	OK
400	11000	Bad Request
401	12001	Unauthorized
404	11004	Not Found
422	11000	Unprocessable Entity
429	13000	Too Many Requests
500	10000	Internal Server Error