List Components

get

https://app.bluetallyapp.com/api/v1/components

Returns all components.

Query Params

tenant_id

int32

The ID of the tenant the API request is for (for users with multi-tenancy enabled)

limit

int32

Defaults to 50

The maximum number of entries to return.

sort

string

Defaults to name

The column to sort the results by. Options: { created_at, updated_at, name, model_number, order_number, purchase_date, purchase_cost, minimum_quantity, quantity, notes }

order

string

Defaults to asc

The order to sort the results by. Options: { asc, desc }

offset

int32

Defaults to 0

Offset the results by a number.

name

string

The exact search for name.

model_number

string

The exact search for model number.

order_number

string

The exact search for order number.

purchase_date

string

The exact search for purchase date. Format: YYYY-MM-DD

unit_cost

float

The exact search for unit cost.

minimum_quantity

int32

The exact search for minimum quantity.

quantity

int32

The exact search for quantity.

category_id

int32

The exact search for category ID.

manufacturer_id

int32

The exact search for manufacturer ID.

supplier_id

int32

The exact search for supplier ID.

location_id

int32

The exact search for location ID.

department_id

int32

The exact search for department ID.

notes

string

The exact search for notes.

Response

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200