Skip to main content
GET
Get list of items

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Query Parameters

num_records
string
default:25

Number of records to fetch(max 100), default : 25 items will be sent in response

page
integer
default:1

Page number

sort_by
enum<string>

Field to sort the items by. If omitted, items are returned in creation order.

Available options:
name,
category,
quantity,
unit_price,
price_with_tax,
tax_rate,
created_at,
updated_at
sort_order
enum<string>
default:asc

Sort direction applied when sort_by is set: 'asc' (default) or 'desc'.

Available options:
asc,
desc

Response

Item List fetched successfully

success
boolean

Success flag

Example:

true

message
string

Response message

Example:

""

error_code
string

Error Code

Example:

""

errors
object

Errors

data
object