Get procedure

Retrieve a single procedure by its ID. Returns comprehensive procedure data including recent runs and linked stations.

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 get procedures
Station	Limited	Stations can access procedures they are linked to

Endpoint

GET/v2/procedures/{id}

Authorization

AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

idstring

Unique identifier of the procedure to retrieve.

Formatuuid

Response Body

from tofupilot.v2 import TofuPilot

# Initialize the TofuPilot client
client = TofuPilot()

# Execute the operation
result = client.procedures.get(
    id="550e8400-e29b-41d4-a716-446655440000"
)

# Handle response
print(result)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "identifier": "PROC-001",
  "name": "PCB Functional Test",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by_user": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "image": "https://example.com/user-avatar.jpg"
  },
  "runs_count": 42,
  "recent_runs": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "started_at": "2024-01-15T10:35:00Z",
      "outcome": "PASS",
      "unit": {
        "serial_number": "SN-001234"
      }
    }
  ],
  "stations": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440004",
      "name": "Test Station 01",
      "identifier": "STA-01"
    }
  ]
}

{
  "code": "NOT_FOUND",
  "message": "Procedure not found: {id}",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?