API ReferenceParts

List Parts (POST)

Lists a collection of parts.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
typelist of enumsOptional

Filters for parts of the provided type(s).

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.
custom_fieldsobjectOptional
Filters for custom fields.
enhancementobjectOptional
limitintegerOptional
The maximum number of parts to return. The default is '50'.
modeenumOptional

The iteration mode to use. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

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_partobjectOptional
The filter for specifying parent part.
sort_bylist of stringsOptional
Fields to sort the parts by and the direction to sort them.
subtypelist of stringsOptional
Filters for subtypes.
tagslist of stringsOptional
Filters for part with any of the provided tags.

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