List catalog providers

Lists the providers that have at least one voucher set visible to you, whatever your toggles say (management view). Apps should filter with filter[providerToggle]=true. Provider availability is active if any visible set is active, else deactivation-scheduled, else upcoming. See Catalog and toggles.

Required permissions: view-consumer-catalog · API keys: allowed

GET /consumer/v1/catalog/providers

List catalog providers

cURL

curl --request GET \
  --url https://api.voucher-staging.allride.io/consumer/v1/catalog/providers \
  --header 'Authorization: Bearer <token>'

200

default

{
  "data": {
    "data": [
      {
        "id": 1030,
        "resource": "consumer-catalog-provider",
        "slug": "acme-scooters",
        "availability": "active",
        "voucherSetCounts": {
          "upcoming": 1,
          "active": 1,
          "deactivationScheduled": 0
        },
        "nextActiveFrom": "2026-11-01T00:00:00Z",
        "earliestDeactivateAt": null,
        "profile": {
          "displayName": {
            "de": "Acme Scooters",
            "en": "Acme Scooters"
          },
          "tagline": {
            "de": "E-Scooter und E-Bikes",
            "en": "E-scooters and e-bikes"
          },
          "description": null,
          "termsText": null,
          "termsUrl": "https://acme-scooters.example.com/terms",
          "privacyUrl": "https://acme-scooters.example.com/privacy",
          "websiteUrl": "https://acme-scooters.example.com",
          "supportUrl": null,
          "appLinks": {
            "appStoreUrl": "https://apps.apple.com/app/id0000000001",
            "playStoreUrl": null
          },
          "defaultCategoryId": 7017,
          "countries": [
            "DE"
          ]
        },
        "profileRevisionNo": 2,
        "listingBranding": {
          "primaryColor": "#14d0e8",
          "secondaryColor": null,
          "backgroundColor": "#0b1f33",
          "surfaceColor": null,
          "textColor": "#ffffff",
          "accentColor": null,
          "buttonColor": "#14d0e8",
          "buttonTextColor": "#0b1f33",
          "buttonBorderColor": null,
          "logoAssetId": 3095,
          "logoDarkAssetId": null,
          "iconAssetId": null,
          "heroImageAssetId": null,
          "faviconAssetId": null,
          "emailLogoAssetId": null,
          "fontFamily": "inter",
          "cornerRadius": "md",
          "extensions": null,
          "assetUrls": {
            "logo": {
              "assetId": 3095,
              "url": "https://assets.voucher.allride.io/acme-scooters/3095.png",
              "width": 320,
              "height": 80,
              "variants": null
            },
            "logoDark": null,
            "icon": null,
            "hero": null
          }
        },
        "providerToggle": true,
        "featured": true,
        "effectiveCategoryId": 7017,
        "setting": {
          "enabled": true,
          "autoEnableNewVoucherSets": true,
          "position": 1,
          "featured": true,
          "categoryOverrideId": null,
          "settings": {
            "schemaVersion": 1,
            "minClientVersion": "3.0.24"
          },
          "externalRef": "3",
          "updatedAt": "2026-10-20T10:00:00Z"
        },
        "_links": {
          "self": {
            "href": "https://api.voucher.allride.io/consumer/v1/catalog/providers/1030",
            "type": "application/json"
          }
        }
      }
    ],
    "page": 1,
    "perPage": 25,
    "totalPages": 1,
    "total": 1
  }
}

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"

search · string

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).

filter[featured] · boolean

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

200

application/json

OK

Page envelope of ConsumerCatalogProvider items.

data · object · required

The page.

Show child attributes