List Parts

GET

Lists a collection of parts.

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.

custom_fieldsobjectOptional

Filters for custom fields.

enhancement.accountslist of stringsOptional

Filters for enhancement by its accounts.

enhancement.actual_close_date.afterstringOptionalformat: "date-time"

Filters for objects created after the provided timestamp (inclusive).

enhancement.actual_close_date.beforestringOptionalformat: "date-time"

Filters for objects created before the provided timestamp (inclusive).

enhancement.actual_start_date.afterstringOptionalformat: "date-time"

Filters for objects created after the provided timestamp (inclusive).

enhancement.actual_start_date.beforestringOptionalformat: "date-time"

Filters for objects created before the provided timestamp (inclusive).

enhancement.opportunitieslist of stringsOptional

Filters for enhancement by its opportunities.

enhancement.rev_score_tierlist of enumsOptional

Filters for enhancement by its rev score tier.

Allowed values: highlowmedium

enhancement.stage_v2list of stringsOptional

List of IDs of the custom stages which will be used for filtering.

enhancement.state_v2list of stringsOptional

Filters for part with any of the provided custom states.

enhancement.target_close_date.afterstringOptionalformat: "date-time"

Filters for objects created after the provided timestamp (inclusive).

enhancement.target_close_date.beforestringOptionalformat: "date-time"

Filters for objects created before the provided timestamp (inclusive).

enhancement.target_start_date.afterstringOptionalformat: "date-time"

Filters for objects created after the provided timestamp (inclusive).

enhancement.target_start_date.beforestringOptionalformat: "date-time"

Filters for objects created before the provided timestamp (inclusive).

enhancement.ticketslist of stringsOptional

Filters for enhancement by its tickets.

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: afterbefore

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.

subtypelist of stringsOptional

Filters for subtypes.

tagslist of stringsOptional

Filters for part with any of the provided tags.

typelist of enumsOptional

Filters for parts of the provided type(s).

Response

Success.

partslist of objects

The list of parts.

next_cursorstringOptionalformat: "text"

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptionalformat: "text"

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors

GET

1 curl https://api.devrev.ai/parts.list \
2      -H "Authorization: Bearer <token>"

200listExample

1 {
2   "parts": [
3     {
4       "created_by": {
5         "display_id": "foo",
6         "id": "foo",
7         "display_name": "foo",
8         "display_picture": {
9           "display_id": "foo",
10           "id": "foo",
11           "file": {}
12         },
13         "email": "foo",
14         "full_name": "foo",
15         "state": "active"
16       },
17       "created_date": "2023-01-01T12:00:00.000Z",
18       "display_id": "foo",
19       "id": "foo",
20       "modified_by": {
21         "display_id": "foo",
22         "id": "foo",
23         "display_name": "foo",
24         "display_picture": {
25           "display_id": "foo",
26           "id": "foo",
27           "file": {}
28         },
29         "email": "foo",
30         "full_name": "foo",
31         "state": "active"
32       },
33       "modified_date": "2023-01-01T12:00:00.000Z",
34       "artifacts": [
35         {
36           "display_id": "foo",
37           "id": "foo",
38           "file": {
39             "type": "foo",
40             "name": "foo",
41             "size": 42
42           }
43         }
44       ],
45       "custom_fields": {},
46       "custom_schema_fragments": [
47         "foo"
48       ],
49       "description": "foo",
50       "name": "foo",
51       "owned_by": [
52         {
53           "display_id": "foo",
54           "id": "foo",
55           "display_name": "foo",
56           "display_picture": {},
57           "email": "foo",
58           "full_name": "foo",
59           "state": "active"
60         }
61       ],
62       "stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
63       "subtype": "foo",
64       "sync_metadata": {
65         "external_reference": "foo",
66         "last_sync_in": {
67           "status": "failed",
68           "sync_date": "2023-01-01T12:00:00.000Z",
69           "sync_unit": {
70             "display_id": "foo",
71             "id": "foo",
72             "external_system_type": "adaas",
73             "is_archived": true,
74             "name": "foo",
75             "sync_run": {
76               "mode": "initial",
77               "progress": {
78                 "state": "completed"
79               }
80             },
81             "sync_type": "manual"
82           }
83         },
84         "last_sync_out": {
85           "status": "failed",
86           "sync_date": "2023-01-01T12:00:00.000Z",
87           "sync_unit": {
88             "display_id": "foo",
89             "id": "foo",
90             "external_system_type": "adaas",
91             "is_archived": true,
92             "name": "foo",
93             "sync_run": {
94               "mode": "initial",
95               "progress": {
96                 "state": "completed"
97               }
98             },
99             "sync_type": "manual"
100           }
101         },
102         "origin_system": "foo"
103       },
104       "tags": [
105         {
106           "tag": {
107             "display_id": "foo",
108             "id": "foo",
109             "name": "foo",
110             "style_new": {
111               "color": "foo"
112             }
113           },
114           "value": "foo"
115         }
116       ]
117     }
118   ],
119   "next_cursor": "foo",
120   "prev_cursor": "foo"
121 }

List Parts (POST)

Up Next

Built with

1	curl https://api.devrev.ai/parts.list \
2	-H "Authorization: Bearer <token>"

1	{
2	"parts": [
3	{
4	"created_by": {
5	"display_id": "foo",
6	"id": "foo",
7	"display_name": "foo",
8	"display_picture": {
9	"display_id": "foo",
10	"id": "foo",
11	"file": {}
12	},
13	"email": "foo",
14	"full_name": "foo",
15	"state": "active"
16	},
17	"created_date": "2023-01-01T12:00:00.000Z",
18	"display_id": "foo",
19	"id": "foo",
20	"modified_by": {
21	"display_id": "foo",
22	"id": "foo",
23	"display_name": "foo",
24	"display_picture": {
25	"display_id": "foo",
26	"id": "foo",
27	"file": {}
28	},
29	"email": "foo",
30	"full_name": "foo",
31	"state": "active"
32	},
33	"modified_date": "2023-01-01T12:00:00.000Z",
34	"artifacts": [
35	{
36	"display_id": "foo",
37	"id": "foo",
38	"file": {
39	"type": "foo",
40	"name": "foo",
41	"size": 42
42	}
43	}
44	],
45	"custom_fields": {},
46	"custom_schema_fragments": [
47	"foo"
48	],
49	"description": "foo",
50	"name": "foo",
51	"owned_by": [
52	{
53	"display_id": "foo",
54	"id": "foo",
55	"display_name": "foo",
56	"display_picture": {},
57	"email": "foo",
58	"full_name": "foo",
59	"state": "active"
60	}
61	],
62	"stock_schema_fragment": "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id",
63	"subtype": "foo",
64	"sync_metadata": {
65	"external_reference": "foo",
66	"last_sync_in": {
67	"status": "failed",
68	"sync_date": "2023-01-01T12:00:00.000Z",
69	"sync_unit": {
70	"display_id": "foo",
71	"id": "foo",
72	"external_system_type": "adaas",
73	"is_archived": true,
74	"name": "foo",
75	"sync_run": {
76	"mode": "initial",
77	"progress": {
78	"state": "completed"
79	}
80	},
81	"sync_type": "manual"
82	}
83	},
84	"last_sync_out": {
85	"status": "failed",
86	"sync_date": "2023-01-01T12:00:00.000Z",
87	"sync_unit": {
88	"display_id": "foo",
89	"id": "foo",
90	"external_system_type": "adaas",
91	"is_archived": true,
92	"name": "foo",
93	"sync_run": {
94	"mode": "initial",
95	"progress": {
96	"state": "completed"
97	}
98	},
99	"sync_type": "manual"
100	}
101	},
102	"origin_system": "foo"
103	},
104	"tags": [
105	{
106	"tag": {
107	"display_id": "foo",
108	"id": "foo",
109	"name": "foo",
110	"style_new": {
111	"color": "foo"
112	}
113	},
114	"value": "foo"
115	}
116	]
117	}
118	],
119	"next_cursor": "foo",
120	"prev_cursor": "foo"
121	}