API Reference

List Materials

get
https://{workspace}.api.vitruvi.cc/api/v1/materials/

Returns a list of all materials.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The material code to search for.

string

A generic expression to filter the list with.

boolean

Set to true to only list active materials.

integer
Defaults to 1000

The number of records returned in the single call. See API Paging.

material_categories
array of integers
deprecated

Filter materials by a list of material category ids.

material_categories
integer
Defaults to 0

The number of records to skip. The offset value is usually equal to the page_number * limit. See API Paging.

string

Which field to use when ordering the results.

integer

The material rank to search for.

string

A term that will be (case-insensitive) searched for in each of the fields: ('name', 'code', 'description')

Response

Updated 8 months ago

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago