GET
List stock labels
Company space For: Stock keeper, Manager · Permission: stock_labels.list, inventory_stocks.list Conditions
  • Either the stock_labels.list or the inventory_stocks.list permission is enough.
  • Only labels of the current organization are listed; the shared label catalogue is not filtered by company.
Part of Check stock levels and label lots.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

per_page
integer

Number of items per page.

Required range: 1 <= x <= 100
cursor
string

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string>

Field the list is sorted by.

Available options:
name,
created_at
sort_order
enum<string>

asc for ascending order, desc for descending order.

Available options:
asc,
desc
search
string | null

Optional text, up to 100 characters. Keeps labels whose name contains it, ignoring case.

Maximum string length: 100
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, name, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
StockLabelResource · object[]
required

Items of this page.

meta
object
required

Pagination details.