Skip to main content
GET
/
discount-brands
List discount brands
curl --request GET \
  --url https://api.sprucecollective.co.uk/discount-brands
[
  {
    "archived": true,
    "collection_id": "<string>",
    "created_at": "<string>",
    "description": "<string>",
    "discount_codes": [
      {
        "active": true,
        "allow_multiple_claims": true,
        "alphanumeric": true,
        "category": "<string>",
        "claimed_codes": [
          "<string>"
        ],
        "code": "<string>",
        "code_display": "<string>",
        "code_length": 123,
        "code_pattern": "<string>",
        "code_required": true,
        "created_at": "<string>",
        "current_uses": 123,
        "description": "<string>",
        "discount_brand": "<unknown>",
        "discount_brand_id": "<string>",
        "discount_percentage": 123,
        "featured": true,
        "has_claimed_code": true,
        "id": "<string>",
        "is_bulk_code": true,
        "is_valid": true,
        "max_uses": 123,
        "partner_logo": "<string>",
        "partner_url": "<string>",
        "points_required": 123,
        "site_id": "<string>",
        "tags": [
          {
            "active": true,
            "color": "<string>",
            "created_at": "<string>",
            "description": "<string>",
            "id": "<string>",
            "name": "<string>",
            "site_id": "<string>",
            "slug": "<string>",
            "updated_at": "<string>"
          }
        ],
        "terms": "<string>",
        "third_party_id": "<string>",
        "thumbnail": "<string>",
        "title": "<string>",
        "updated_at": "<string>",
        "valid_from": "<string>",
        "valid_until": "<string>"
      }
    ],
    "draft": true,
    "id": "<string>",
    "item_id": "<string>",
    "locale_id": "<string>",
    "logo": "<string>",
    "logo_black_and_white": "<string>",
    "max_discount": "<string>",
    "name": "<string>",
    "published_on": "<string>",
    "site_id": "<string>",
    "slug": "<string>",
    "thumbnail": "<string>",
    "updated_at": "<string>"
  }
]

Query Parameters

page
integer
default:1

Page number

page_size
integer
default:10

Page size

archived
boolean

Filter by archived status

draft
boolean

Filter by draft status

Search term (name, slug, description)

sort_by
string

Sort by field (name, slug, created_at, updated_at, archived, draft)

order
string

Sort order (asc or desc)

Response

200 - application/json

OK

archived
boolean
collection_id
string
created_at
string
description
string
discount_codes
object[]
draft
boolean
id
string
item_id
string
locale_id
string
logo_black_and_white
string
max_discount
string
name
string
published_on
string
site_id
string
slug
string
thumbnail
string
updated_at
string