List and filter parts
/v2/partsAuthorization
api_key API key for authentication. Use format: Bearer YOUR_API_KEY
In: header
Query Parameters
Maximum number of parts to return in a single page.
501 <= value <= 100Offset position for pagination. Use the next_cursor from the previous response to get the next page.
-9007199254740991 <= value <= 9007199254740991Search text to filter parts by name, part number, or revision number.
length <= 100Filter parts by procedures (parts that have runs with these procedures).
items <= 10Field to sort results by.
"created_at""name" | "number" | "created_at"Sort order direction.
"desc""asc" | "desc"When true, includes the custom metadata object on each part in the response. Defaults to false to keep payloads small.
falseResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/parts"{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"number": "PCB-V2.0",
"name": "Main PCB Board",
"created_at": "2019-08-24T14:15:22Z",
"revisions": [
{
"id": "550e8400-e29b-41d4-a716-446655440001",
"number": "REV-A"
}
],
"metadata": {
"vendor": "Acme",
"lot_size": 500,
"qualified": true
}
}
],
"meta": {
"has_more": true,
"next_cursor": 50
}
}{
"message": "Unauthorized",
"code": "UNAUTHORIZED",
"issues": []
}{
"message": "Request timeout",
"code": "TIMEOUT",
"issues": []
}{
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"issues": []
}How is this guide?
Get part GET
Get a part by number, with its revisions, metadata, and linked units. Numbers match case-insensitively. See its parameters, response schema, and status codes.
Update part PATCH
Update a part's number or name. Numbers match case-insensitively. TofuPilot REST API reference with its parameters, response schema, and status codes.