API Reference
Knowledge Base

List all materials

get
https://api.katanamrp.com/v1/materials

Returns a list of materials you’ve previously created. The materials are returned in sorted order, with the most recent materials appearing first.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
ids
array of integers

Filters materials by an array of IDs

ids
string

Filters materials by a name

string

Filters materials by a uom

integer

Filters materials by a default_supplier_id

boolean

Filters materials by a is_sellable

boolean

Filters materials by a batch_tracked

string

Filters materials by a purchase_uom

number

Filters materials by a purchase_uom_conversion_rate

extend
array of strings

Array of objects that need to be added to the response

extend
boolean

Soft-deleted data is excluded from result set by default. Set to true to include it.

boolean

Archived data is excluded from result set by default. Set to true to include it.

string

Used for pagination (default is 50)

string

Used for pagination (default is 1)

string

Minimum value for created_at range. Must be compatible with ISO 8601 format

string

Maximum value for created_at range. Must be compatible with ISO 8601 format

string

Minimum value for updated_at range. Must be compatible with ISO 8601 format

string

Maximum value for updated_at range. Must be compatible with ISO 8601 format

Responses

Updated 13 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json

Updated 13 days ago