API ReferenceParts

List Parts

Lists a collection of parts.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

created_bylist of stringsOptional
Filters for parts created by any of these users.
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limitintegerOptional
The maximum number of parts to return. The default is '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
modified_bylist of stringsOptional
Filters for parts modified by any of these users.
namelist of stringsOptional

Filters for parts of the provided name(s).

owned_bylist of stringsOptional
Filters for parts owned by any of these users.
parent_part.levelintegerOptional>=1
Number of levels to fetch the part hierarchy up to.
parent_part.partslist of stringsOptional

Part IDs to fetch the hierarchy for. Required if any parent_part.* fields are provided.

sort_bylist of stringsOptional
Fields to sort the parts by and the direction to sort them.
tagslist of stringsOptional
Filters for part with any of the provided tags.
typelist of enumsOptional

Filters for parts of the provided type(s).

Allowed values:

Response

Success.
partslist of objects
The list of parts.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors