List Scouts

GET

scouting

tasks

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

import requests

response = requests.get(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch("https://api.yutori.com/v1/scouting/tasks", {
  method: "GET",
  headers: { "X-API-Key": "YOUR_API_KEY" }
});
const data = await response.json();

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Returns scouting tasks created with the API 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 matching scouts.

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

import requests

response = requests.get(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch("https://api.yutori.com/v1/scouting/tasks", {
  method: "GET",
  headers: { "X-API-Key": "YOUR_API_KEY" }
});
const data = await response.json();

Advanced Example

Using Pagination and Status Filtering

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'

import requests

# First page with status filter
response = requests.get(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"page_size": 20, "status": "active"}
)
data = response.json()

# Paginate through all results
while data.get("has_more"):
    response = requests.get(
        "https://api.yutori.com/v1/scouting/tasks",
        headers={"X-API-Key": "YOUR_API_KEY"},
        params={"page_size": 20, "cursor": data["next_cursor"]}
    )
    data = response.json()

// First page with status filter
const response = await fetch(
  "https://api.yutori.com/v1/scouting/tasks?page_size=20&status=active",
  {
    method: "GET",
    headers: { "X-API-Key": "YOUR_API_KEY" }
  }
);
let data = await response.json();

// Paginate through all results
while (data.has_more) {
  const nextResponse = await fetch(
    `https://api.yutori.com/v1/scouting/tasks?page_size=20&cursor=${data.next_cursor}`,
    {
      method: "GET",
      headers: { "X-API-Key": "YOUR_API_KEY" }
    }
  );
  data = await nextResponse.json();
}

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

Parameter	Type	Description
`page_size`	integer	Number of scouts per page. If omitted, returns all matching scouts.
`cursor`	string	Cursor from a previous response for pagination.
`status`	string	Filter 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

page_size

integer | null

cursor

string | null

Response

Successful Response

scouts

ScoutListItem · object[]

required

Show child attributes

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 | null

Counts by status

Show child attributes

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

Get ScoutGet detailed information about a specific scout owned by this user.

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

import requests

response = requests.get(
    "https://api.yutori.com/v1/scouting/tasks",
    headers={"X-API-Key": "YOUR_API_KEY"}
)
print(response.json())

const response = await fetch("https://api.yutori.com/v1/scouting/tasks", {
  method: "GET",
  headers: { "X-API-Key": "YOUR_API_KEY" }
});
const data = await response.json();

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

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Getting Started

General

Navigator API

Browsing API

Research API

Scouting API

Webhooks

Advanced Example

Authorizations

Query Parameters

Response

​Advanced Example

​Response Format

​Query Parameters

Authorizations

Query Parameters

Response

Advanced Example

Response Format

Query Parameters