Skip to main content
GET
List offers (filterable by status / search / archived).

Authorizations

x-api-key
string
header
required

API key for authentication (can be generated in the settings)

Query Parameters

status
enum<string>

Filter by offer status. Omit to receive offers in every status.

Available options:
DRAFT,
SENT,
WON,
LOST

The search query for the offer

isArchived
boolean
default:false

Whether to filter for archived offers or not. Defaults to false.

limit
number
default:20

The maximum amount of retrieved items per page

Required range: 1 <= x <= 20
page
number
default:1

The page number to retrieve items from.

Required range: x >= 1

Response

Offers retrieved successfully

The response is of type any.