v2 Reference (Preview)/Stations
List and filter stations
Retrieve a paginated list of stations with search functionality.
API v2 Preview
The TofuPilot API v2.0 is currently in public preview and is subject to change as we stabilize until release (planned for Aug 2025).
Access
API Key | Access Level | Description |
---|---|---|
User | Full | Users can list stations |
Station | Unauthorized | Stations cannot list other stations |
Endpoint
GET
/v2/stations
AuthorizationBearer <token>
API key for authentication. Use format: Bearer YOUR_API_KEY
In: header
Query Parameters
limit?number
Number of stations to return per page
Default
50
Range
1 <= value <= 100
cursor?number
Cursor for pagination. Use the nextCursor from previous response
search_query?string
Search query to filter stations by name or identifier
Response Body
from tofupilot.v2 import TofuPilot
# Initialize the TofuPilot client
client = TofuPilot()
# Execute the operation
result = client.stations.list(
limit=20,
cursor=1,
search_query="assembly"
)
# Handle response
print(result)
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"identifier": "STA-A1B",
"name": "Assembly Station 1",
"image": "https://s3.amazonaws.com/bucket/station-image.jpg",
"procedures": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"identifier": "PROC-001",
"name": "Assembly Test"
}
],
"procedures_count": 5
}
],
"meta": {
"has_more": true,
"next_cursor": 2
}
}
{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}
How is this guide?