Skip to main content
GET
List online offers

Authorizations

X-API-Key
string
header
required

Path Parameters

organization_id
string<shortuuid>
required

UUID of the organization that owns the offers.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Query Parameters

scope
enum<string>
default:submitted

submitted (default) returns the offers this organization submitted. on_products adds the unverified offers other organizations submitted on products this organization owns — those are hidden from public surfaces, and the owner may delete them. Closient-ingested and verified offers are not included.

Available options:
submitted,
on_products
page
integer
default:1

Page number (1-indexed).

Required range: x >= 1
page_size
integer
default:25

Number of items per page (max 100).

Required range: 1 <= x <= 100

Response

OK

data
OnlineOfferOut · object[]
required

Items on the current page, each conforming to the endpoint's item schema. Empty when the result set is empty or page is past the end.

pagination
PaginationMeta · object
required

Pagination envelope describing position within the full result set.

Example: