Skip to main content
GET
Get all sales

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Query Parameters

search
string | null

The search query.

Maximum string length: 255
per_page
integer | null

The number of items per page.

Required range: 1 <= x <= 100
page
integer | null

The page number.

Required range: x >= 1
sort_by
enum<string> | null

The field to sort by.

Available options:
created_at,
updated_at,
status
sort_order
enum<string> | null

The sort direction (asc or desc).

Available options:
asc,
desc
customer_id
integer | null

Filter by customer ID.

user_id
integer | null

Filter by user ID.

status
enum<string> | null

Filter by status.

Available options:
draft,
completed,
cancelled,
invoiced,
pending
created_at_from
string<date-time> | null

Filter records created on or after this date.

created_at_to
string<date-time> | null

Filter records created on or before this date.

trashed
boolean | null

Include only soft-deleted records.

Response

Paginated set of SaleResource

data
SaleResource · object[]
required
meta
object
required