Browse documentation

Tool

List competitors

Use to see the workspace's competitor list: each competitor's platform, handle, display name, bio, avatar, check cadence, state and last check, plus what the list costs in credits per month and how many credits are left. Reads saved workspace data only.

POSTtools.readFree
POST/openapi/v1/tools/list_competitors

Call it

curl -X POST https://api.cuekoo.com/openapi/v1/tools/list_competitors \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

The MCP tool is named cuekoo_list_competitors. Arguments and results are identical to the REST call.

Arguments

Send a JSON object with these fields. Scope: tools.read.

NameTypeRequired
platformstringOptional

Response

NameTypeRequired
creditsobjectRequired
credits.first_checkintegerRequired
credits.monthly_estimateintegerRequired
credits.per_checkintegerRequired
credits.remainingintegerRequired
itemsobject[] | nullRequired
items[].added_atstringRequired
items[].avatar_urlstringOptional
items[].billedbooleanRequired
items[].biostringOptional
items[].cadencestringRequired
items[].display_namestringOptional
items[].followersinteger | nullRequired
items[].handlestringRequired
items[].idstringRequired
items[].last_checked_atstring | nullRequired
items[].platformstringRequired
items[].statestringRequired
max_competitorsintegerRequired

A call returns the Tool's output object at HTTP 200. Failures use the error envelope.

Credits

This Tool is free. It does not reserve or spend credits.