Skip to main content
GET
List catalog providers

Authorizations

Authorization
string
header
required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Query Parameters

page
integer
default:1

Page number, 1-100,000 (default 1). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100000
perPage
integer
default:25

Items per page, 1-100 (default 25). Outside the range: 400 data-failed-validation with the constraint invalid-page.

Required range: 1 <= x <= 100
sort
string

One sort field; prefix - for descending (sort=field or sort=-field). Allowed: position, slug, nextActiveFrom, earliestDeactivateAt. Default position. The server appends id as a tie-breaker.

Example:

"position"

Case-insensitive search (at most 255 characters) over slug, profile.displayName.

Maximum string length: 255
filter[availability]
enum<string>

Provider availability (equals).

Available options:
upcoming,
active,
deactivation-scheduled
filter[availability][in]
string

Provider availability (one of (comma-separated)). Comma-separated values.

filter[providerToggle]
boolean

Your Provider Toggle (equals).

Featured (effective) (equals).

filter[effectiveCategoryId]
integer

Effective category id (equals).

Required range: x >= 0
filter[effectiveCategoryId][in]
string

Effective category id (one of (comma-separated)). Comma-separated values.

filter[slug]
string

Provider slug (equals).

filter[slug][in]
string

Provider slug (one of (comma-separated)). Comma-separated values.

filter[setting.externalRef]
string

Your external reference (equals).

filter[setting.externalRef][in]
string

Your external reference (one of (comma-separated)). Comma-separated values.

Response

OK

Page envelope of ConsumerCatalogProvider items.

data
object
required

The page.