Skip to main content
GET
List sales orders for a company

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

companyId
integer
required

The unique identifier of the company.

Query Parameters

page
integer
default:1

Page number for pagination.

per_page
integer
default:10

Number of items per page (max 100).

Required range: x <= 100
fields
string

Comma-separated list of fields to include in each returned sales order (field projection). When omitted, the full sales order object is returned. Example: fields=id,order_number,status.

Response

Successful response

data
object[]
meta
object