Skip to main content
GET
List catalog offers

Authorizations

client_id
string
header
required
secret_key
string
header
required

Headers

x-broker-id
string<uuid>

Query Parameters

discontinued
boolean
recurrence
enum<string>
Available options:
MONTHLY,
QUARTERLY,
ANNUAL,
CUSTOM
isAddon
boolean
name
string
Minimum string length: 1
broker
string<uuid>

Filter by broker (partner). The x-broker-id header takes precedence over this filter.

createdAtFrom
string<date-time>
createdAtTo
string<date-time>
updatedAtFrom
string<date-time>
updatedAtTo
string<date-time>
orderBy
enum<string>
default:createdAt
Available options:
createdAt,
name,
updatedAt
order
enum<string>
default:desc
Available options:
asc,
desc
page
number
default:1
pageSize
number
default:10
Required range: x <= 100
status

Filter by one or more offer statuses. Repeat the parameter or pass a comma-separated list.

Available options:
ACTIVE,
DRAFT,
PAUSED,
DISCONTINUED
chargeType

Filter by one or more charge types. Repeat the parameter or pass a comma-separated list.

Available options:
PREPAID,
POSTPAID
tags

Filter by one or more tags. Repeat the parameter or pass a comma-separated list.

Minimum string length: 1

Response

200 - application/json

Default Response

items
object[]
required
meta
object
required