API ReferencePick Lists

List Pick Lists

Returns a paginated list of pick lists for the authenticated business. Optionally filter by status. Invalid status values return 400 with a list of valid values.

Requires scope: pick_lists:read

Authentication

API_KEYstring
API Key authentication via header

Query parameters

pageintegerOptional

Zero-based page index. Defaults to 0.

sizeintegerOptional

Items per page. Defaults to 20, maximum 100.

statusenumOptional

Filter by status. Returns 400 with a list of valid values if an unrecognized status is provided.

Allowed values:
sortstringOptional

Sort by field,direction (Spring Pageable format; direction asc or desc, default asc). Allowed fields: id, name, note, status, requestDate, createdAt, updatedAt. Default order (when no sort is supplied): createdAt,desc.

Response

This endpoint returns an object.
datalist of objects
paginationobject
Pagination metadata returned on all list endpoints.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error