TofuPilotTofuPilot
API Reference (v2)Parts

Get part

Retrieve a single part by its number, including all revisions, metadata, and linked units. Part numbers are matched case-insensitively.

Access

API KeyAccess LevelDescription
UserFullUsers can read parts
StationFullStations can read parts

Endpoint

GET/v2/parts/{number}
AuthorizationBearer <token>

API key for authentication. Use format: Bearer YOUR_API_KEY

In: header

Path Parameters

numberstring

Part number of the part to retrieve.

Response Body

from tofupilot.v2 import TofuPilot

# Initialize the TofuPilot client
client = TofuPilot()

# Execute the operation
result = client.parts.get(
    number="string"
)

# Handle response
print(result)
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "number": "PCB-MAIN-001",
  "name": "Main Control Board",
  "created_at": "2024-01-15T10:30:00Z",
  "created_by_user": {
    "id": "550e8400-e29b-41d4-a716-446655440001",
    "name": "John Doe"
  },
  "created_by_station": {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "name": "Assembly Station 01"
  },
  "revisions": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "number": "REV-A",
      "created_at": "2024-01-15T10:30:00Z"
    }
  ]
}
{
  "message": "Unauthorized",
  "code": "UNAUTHORIZED",
  "issues": []
}
{
  "message": "Not found",
  "code": "NOT_FOUND",
  "issues": []
}
{
  "message": "Internal server error",
  "code": "INTERNAL_SERVER_ERROR",
  "issues": []
}

How is this guide?