Skip to content

Get the inventories of file/folder ids

Request

Returns the inventories file and/or folder ids

Security
bearerAuth
Query
projectIdinteger, (int64), >= 1required

ID of the Project

Example:projectId=1
fileIdsstring

Provide list of file ids

folderIdsstring

Provide list of folder ids

publishedboolean

If true, then only published inventory items are returned; if false, then only un-published inventory items are returned

limitinteger, (int64), >= 1

Page Size. Number Of Records to fetch per page

Default:25
offsetinteger, (int64), >= 1

Page Number. Index of the page to start with(starts from 1)

Default:1
curl -i -X GET \
  'https://codeinsightapi.redocly.app/_mock/swagger/inventories/search?projectId=1&fileIds=string&folderIds=string&published=true&limit=25&offset=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
object(Json)
Response
{}