Skip to main content
GET
/
v1
/
scouting
/
tasks
curl --request GET \
  --url https://api.yutori.com/v1/scouting/tasks \
  --header 'X-API-Key: YOUR_API_KEY'

{
  "scouts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "query": "<string>",
      "display_name": "<string>",
      "status": "active",
      "created_at": "2023-11-07T05:31:56Z",
      "next_output_timestamp": "2023-11-07T05:31:56Z",
      "output_interval": 123,
      "rejection_reason": "insufficient_prepaid_balance"
    }
  ],
  "total": 0,
  "filtered_total": 0,
  "summary": {
    "active": 123,
    "paused": 123,
    "done": 123
  },
  "page_size": 123,
  "has_more": false,
  "prev_cursor": "<string>",
  "next_cursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.yutori.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns all scouts for the authenticated user. Each scout includes lightweight metadata including status (active, paused, or done). Supports optional cursor-based pagination and status filtering. If page_size is not provided, returns all scouts. 
curl --request GET \
  --url https://api.yutori.com/v1/scouting/tasks \
  --header 'X-API-Key: YOUR_API_KEY'

​
Advanced Example

Use cursor-based pagination to efficiently fetch scouts in batches, with optional filtering by status.
# First page with status filter
curl --request GET \
  --url 'https://api.yutori.com/v1/scouting/tasks?page_size=20&status=active' \
  --header 'X-API-Key: YOUR_API_KEY'

# Next page using cursor from previous response
curl --request GET \
  --url 'https://api.yutori.com/v1/scouting/tasks?page_size=20&cursor=eyJjcmVhdGVkX2F0Ijo...' \
  --header 'X-API-Key: YOUR_API_KEY'

​
Response Format

The response includes pagination metadata and summary statistics:
{
  "scouts": [...],
  "total": 125,
  "summary": {
    "active": 80,
    "paused": 30,
    "done": 15
  },
  "page_size": 20,
  "has_more": true,
  "prev_cursor": null,
  "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNS0wMS0xNVQxMDozMDowMFoiLCJpZCI6IjEyMzQ1In0="
}

​
Query Parameters

ParameterTypeDescription
page_sizeintegerNumber of scouts per page. If omitted, returns all scouts.
cursorstringCursor from a previous response for pagination.
statusstringFilter by status: active, paused, or done.

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
status
enum<string> | null

Filter by scout status

Available options:
active,
paused,
done
​
include_all_sources
boolean
default:false

Include scouts created from all sources, not just the API

​
page_size
integer | null
​
cursor
string | null

Response

Successful Response

​
scouts
ScoutListItem · object[]
required
​
total
integer
default:0

Total count of all scouts (active + paused + done)

​
filtered_total
integer
default:0

Count of scouts matching the current filter

​
summary
ScoutsSummary · object

Counts by status

​
page_size
integer | null

Requested page size (null if returning all)

​
has_more
boolean
default:false

Whether more results exist after this page

​
prev_cursor
string | null

Cursor for previous page

​
next_cursor
string | null

Cursor for next page