Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Query Parameters

status
enum<string> | null

open (the default) by when to order, or accepted or dismissed, latest first. Where a suggestion stands: open until a person accepts it, drafting an order or a build, or dismisses it with a reason.

Available options:
open,
accepted,
dismissed
search
string | null

The start of an item's SKU, or part of its name.

Maximum string length: 100

Response

Array of SuggestionResource

data
SuggestionResource · object[]
required