Skip to main content
GET
/
api
/
public
/
v1
/
budgets
/
products
List budget products
curl --request GET \
  --url https://app.msportal.ai/api/public/v1/budgets/products \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "sku": "<string>",
      "category": "<string>",
      "vendor": "<string>",
      "unitPrice": 1,
      "description": "<string>",
      "productGroup": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "page": 2,
    "limit": 50,
    "totalCount": 123,
    "totalPages": 123,
    "hasNextPage": true,
    "hasPrevPage": true
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Query Parameters

​
page
number
default:1

Page number

Required range: x >= 1
​
limit
number
default:25

Items per page

Required range: 1 <= x <= 100
​
sortColumn
enum<string>
default:name

Field to sort by

Available options:
name,
sku,
category,
vendor,
unit_price,
unitPrice,
created_at,
createdAt
​
sortDesc
boolean | null
default:false

Sort descending

​
search
string

Search in name, SKU, description

Maximum string length: 255
​
companyId
string<uuid>

Filter by company ID

​
category
string

Filter by category

Maximum string length: 255
​
vendor
string

Filter by vendor

Maximum string length: 255

Response

List of budget products

​
data
object[]
required

Array of budget products

​
pagination
object
required