Skip to main content
GET
/
discount-codes
/
my-claims
Get user discount code claims
curl --request GET \
  --url https://api.sprucecollective.co.uk/discount-codes/my-claims \
  --header 'Authorization: <api-key>'
[
  {
    "claimed_code": "<string>",
    "created_at": "<string>",
    "discount_code": {
      "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": {
        "archived": true,
        "collection_id": "<string>",
        "created_at": "<string>",
        "description": "<string>",
        "discount_codes": "<array>",
        "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>"
      },
      "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>"
    },
    "discount_code_id": "<string>",
    "id": "<string>",
    "ip_address": "<string>",
    "points_spent": 123,
    "site_id": "<string>",
    "user": {
      "account_locked_until": "<string>",
      "activity_logs": [
        {
          "activity_type": "<string>",
          "created_at": "<string>",
          "description": "<string>",
          "id": "<string>",
          "ip_address": "<string>",
          "metadata": {},
          "request_id": "<string>",
          "resource_id": "<string>",
          "resource_type": "<string>",
          "session_id": "<string>",
          "severity": "<string>",
          "site_id": "<string>",
          "user_agent": "<string>",
          "user_id": "<string>"
        }
      ],
      "consent_given_at": "<string>",
      "consent_version": "<string>",
      "created_at": "<string>",
      "data_processing_consent": true,
      "deleted_at": "<string>",
      "deletion_reason": "<string>",
      "email": "<string>",
      "failed_login_attempts": 123,
      "has_consented": true,
      "id": "<string>",
      "last_login_at": "<string>",
      "marketing_consent": true,
      "name": "<string>",
      "payment_transactions": [
        {
          "amount_cents": 123,
          "created_at": "<string>",
          "currency": "<string>",
          "description": "<string>",
          "fraud_score": 123,
          "gateway": "<string>",
          "gateway_transaction_id": "<string>",
          "id": "<string>",
          "metadata": {},
          "payment_method": "<string>",
          "site_id": "<string>",
          "status": "<string>",
          "updated_at": "<string>",
          "user_id": "<string>",
          "webhook_received_at": "<string>"
        }
      ],
      "points": [
        {
          "amount": 123,
          "created_at": "<string>",
          "created_by": "<string>",
          "id": "<string>",
          "payment_transaction_id": "<string>",
          "reason": "<string>",
          "site_id": "<string>",
          "transaction_type": "<string>",
          "user_id": "<string>"
        }
      ],
      "profile": {
        "accepts_marketing": true,
        "address": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "country": "<string>",
        "created_at": "<string>",
        "first_name": "<string>",
        "id": "<string>",
        "klaviyo_id": "<string>",
        "last_name": "<string>",
        "latitude": "<string>",
        "locale": "<string>",
        "longitude": "<string>",
        "organization": "<string>",
        "phone_number": "<string>",
        "site_id": "<string>",
        "state_region": "<string>",
        "timezone": "<string>",
        "title": "<string>",
        "updated_at": "<string>",
        "user_id": "<string>",
        "zip_code": "<string>"
      },
      "raffle_entries": [
        {
          "created_at": "<string>",
          "entries_count": 123,
          "id": "<string>",
          "ip_address": "<string>",
          "points_spent": 123,
          "raffle": {
            "active": true,
            "allow_free_entries": true,
            "archived": true,
            "campaign_name": "<string>",
            "checkout_description": "<string>",
            "checkout_failure_url": "<string>",
            "checkout_success_url": "<string>",
            "closed": true,
            "collection_id": "<string>",
            "created_at": "<string>",
            "created_by": "<string>",
            "created_by_user": {
              "account_locked_until": "<string>",
              "activity_logs": [
                {
                  "activity_type": "<string>",
                  "created_at": "<string>",
                  "description": "<string>",
                  "id": "<string>",
                  "ip_address": "<string>",
                  "metadata": {},
                  "request_id": "<string>",
                  "resource_id": "<string>",
                  "resource_type": "<string>",
                  "session_id": "<string>",
                  "severity": "<string>",
                  "site_id": "<string>",
                  "user": "<unknown>",
                  "user_agent": "<string>",
                  "user_id": "<string>"
                }
              ],
              "consent_given_at": "<string>",
              "consent_version": "<string>",
              "created_at": "<string>",
              "data_processing_consent": true,
              "deleted_at": "<string>",
              "deletion_reason": "<string>",
              "email": "<string>",
              "failed_login_attempts": 123,
              "has_consented": true,
              "id": "<string>",
              "last_login_at": "<string>",
              "marketing_consent": true,
              "name": "<string>",
              "payment_transactions": [
                {
                  "amount_cents": 123,
                  "created_at": "<string>",
                  "currency": "<string>",
                  "description": "<string>",
                  "fraud_score": 123,
                  "gateway": "<string>",
                  "gateway_transaction_id": "<string>",
                  "id": "<string>",
                  "ip_address": "<string>",
                  "metadata": {},
                  "payment_method": "<string>",
                  "points": [
                    {
                      "amount": 123,
                      "created_at": "<string>",
                      "created_by": "<string>",
                      "created_by_user": "<unknown>",
                      "id": "<string>",
                      "ip_address": "<string>",
                      "payment_transaction": "<unknown>",
                      "payment_transaction_id": "<string>",
                      "reason": "<string>",
                      "site_id": "<string>",
                      "transaction_type": "<string>",
                      "user": "<unknown>",
                      "user_agent": "<string>",
                      "user_id": "<string>"
                    }
                  ],
                  "site_id": "<string>",
                  "status": "<string>",
                  "subscription": {
                    "amount_cents": 123,
                    "auto_renew": true,
                    "billing_interval": "<string>",
                    "cancellation_reason": "<string>",
                    "cancelled_at": "<string>",
                    "cooling_off_expiry": "<string>",
                    "created_at": "<string>",
                    "credits_used_this_period": 123,
                    "currency": "<string>",
                    "current_period_end": "<string>",
                    "current_period_start": "<string>",
                    "entry_credits_per_period": 123,
                    "id": "<string>",
                    "is_trial_active": true,
                    "metadata": {},
                    "next_billing_date": "<string>",
                    "nomupay_registration_id": "<string>",
                    "nomupay_schedule_id": "<string>",
                    "paused_until": "<string>",
                    "payment_method": "<string>",
                    "site_id": "<string>",
                    "status": "<string>",
                    "subscription_start_date": "<string>",
                    "tier": "<string>",
                    "trial_end_date": "<string>",
                    "trial_start_date": "<string>",
                    "updated_at": "<string>",
                    "user": "<unknown>",
                    "user_id": "<string>"
                  },
                  "subscription_id": "<string>",
                  "updated_at": "<string>",
                  "user": "<unknown>",
                  "user_agent": "<string>",
                  "user_id": "<string>",
                  "webhook_data": {},
                  "webhook_received_at": "<string>"
                }
              ],
              "points": [
                {
                  "amount": 123,
                  "created_at": "<string>",
                  "created_by": "<string>",
                  "created_by_user": "<unknown>",
                  "id": "<string>",
                  "ip_address": "<string>",
                  "payment_transaction": "<unknown>",
                  "payment_transaction_id": "<string>",
                  "reason": "<string>",
                  "site_id": "<string>",
                  "transaction_type": "<string>",
                  "user": "<unknown>",
                  "user_agent": "<string>",
                  "user_id": "<string>"
                }
              ],
              "profile": {
                "accepts_marketing": true,
                "address": "<string>",
                "address_2": "<string>",
                "city": "<string>",
                "country": "<string>",
                "created_at": "<string>",
                "first_name": "<string>",
                "id": "<string>",
                "klaviyo_id": "<string>",
                "last_name": "<string>",
                "latitude": "<string>",
                "locale": "<string>",
                "longitude": "<string>",
                "organization": "<string>",
                "phone_number": "<string>",
                "site_id": "<string>",
                "state_region": "<string>",
                "timezone": "<string>",
                "title": "<string>",
                "updated_at": "<string>",
                "user_id": "<string>",
                "zip_code": "<string>"
              },
              "raffle_entries": "<array>",
              "role": "<string>",
              "signup_source": "<string>",
              "site_id": "<string>",
              "updated_at": "<string>"
            },
            "cta_text": "<string>",
            "currency": "<string>",
            "current_entries": 123,
            "description": "<string>",
            "details": "<string>",
            "discount_tiers": [
              {
                "discount": 123,
                "min_quantity": 123
              }
            ],
            "draft": true,
            "drawn_at": "<string>",
            "end_date": "<string>",
            "entries": "<array>",
            "entries_purchased": 123,
            "final_cta_description": "<string>",
            "final_cta_heading": "<string>",
            "giveaway_type": "<string>",
            "hero_description": "<string>",
            "hero_header": "<string>",
            "id": "<string>",
            "image_gallery": "<string>",
            "item_id": "<string>",
            "last_person_who_brought": "<string>",
            "locale_id": "<string>",
            "long_description": "<string>",
            "main_image": "<string>",
            "max_entries": 123,
            "name": "<string>",
            "points_enabled": true,
            "points_multiplier": 123,
            "points_required": 123,
            "price_display": 123,
            "published_on": "<string>",
            "quick_buy_options": "<string>",
            "quick_wins": "<string>",
            "revolut_product_id": "<string>",
            "sendgrid_email_params": {
              "brand_logo_url": "<string>",
              "brand_name": "<string>",
              "brand_site_url": "<string>",
              "color_accent": "<string>",
              "color_bg": "<string>",
              "color_button_text": "<string>",
              "color_footer_text": "<string>",
              "color_text_primary": "<string>",
              "currency": "<string>",
              "current_year": "<string>",
              "email_title": "<string>",
              "first_name": "<string>",
              "from_email": "<string>",
              "from_name": "<string>",
              "giveaway_name": "<string>",
              "language": "<string>",
              "plural": true,
              "reply_to_email": "<string>",
              "ticket_quantity": "<string>",
              "unsubscribe": "<string>",
              "unsubscribe_preferences": "<string>"
            },
            "short_teaser": "<string>",
            "slug": "<string>",
            "start_date": "<string>",
            "total_entries_available": 123,
            "updated_at": "<string>",
            "upsells": [
              {
                "discount": 123,
                "percentage": 123,
                "qty": 123,
                "quantity": 123
              }
            ],
            "webflow_site_id": "<string>",
            "what_you_can_win_1": "<string>",
            "what_you_can_win_2": "<string>",
            "what_you_can_win_3": "<string>",
            "what_you_can_win_4": "<string>",
            "winner_names": "<string>",
            "winners": [
              {
                "claimed": true,
                "claimed_at": "<string>",
                "created_at": "<string>",
                "date_won": "<string>",
                "entry": "<unknown>",
                "entry_id": "<string>",
                "giveaway": "<string>",
                "giveaway_reference": "<string>",
                "id": "<string>",
                "image": "<string>",
                "prize_description": "<string>",
                "raffle": "<unknown>",
                "raffle_id": "<string>",
                "site_id": "<string>",
                "user": {
                  "account_locked_until": "<string>",
                  "activity_logs": [
                    {
                      "activity_type": "<string>",
                      "created_at": "<string>",
                      "description": "<string>",
                      "id": "<string>",
                      "ip_address": "<string>",
                      "metadata": {},
                      "request_id": "<string>",
                      "resource_id": "<string>",
                      "resource_type": "<string>",
                      "session_id": "<string>",
                      "severity": "<string>",
                      "site_id": "<string>",
                      "user": "<unknown>",
                      "user_agent": "<string>",
                      "user_id": "<string>"
                    }
                  ],
                  "consent_given_at": "<string>",
                  "consent_version": "<string>",
                  "created_at": "<string>",
                  "data_processing_consent": true,
                  "deleted_at": "<string>",
                  "deletion_reason": "<string>",
                  "email": "<string>",
                  "failed_login_attempts": 123,
                  "has_consented": true,
                  "id": "<string>",
                  "last_login_at": "<string>",
                  "marketing_consent": true,
                  "name": "<string>",
                  "payment_transactions": [
                    {
                      "amount_cents": 123,
                      "created_at": "<string>",
                      "currency": "<string>",
                      "description": "<string>",
                      "fraud_score": 123,
                      "gateway": "<string>",
                      "gateway_transaction_id": "<string>",
                      "id": "<string>",
                      "ip_address": "<string>",
                      "metadata": {},
                      "payment_method": "<string>",
                      "points": [
                        {
                          "amount": 123,
                          "created_at": "<string>",
                          "created_by": "<string>",
                          "created_by_user": "<unknown>",
                          "id": "<string>",
                          "ip_address": "<string>",
                          "payment_transaction": "<unknown>",
                          "payment_transaction_id": "<string>",
                          "reason": "<string>",
                          "site_id": "<string>",
                          "transaction_type": "<string>",
                          "user": "<unknown>",
                          "user_agent": "<string>",
                          "user_id": "<string>"
                        }
                      ],
                      "site_id": "<string>",
                      "status": "<string>",
                      "subscription": {
                        "amount_cents": 123,
                        "auto_renew": true,
                        "billing_interval": "<string>",
                        "cancellation_reason": "<string>",
                        "cancelled_at": "<string>",
                        "cooling_off_expiry": "<string>",
                        "created_at": "<string>",
                        "credits_used_this_period": 123,
                        "currency": "<string>",
                        "current_period_end": "<string>",
                        "current_period_start": "<string>",
                        "entry_credits_per_period": 123,
                        "id": "<string>",
                        "is_trial_active": true,
                        "metadata": {},
                        "next_billing_date": "<string>",
                        "nomupay_registration_id": "<string>",
                        "nomupay_schedule_id": "<string>",
                        "paused_until": "<string>",
                        "payment_method": "<string>",
                        "site_id": "<string>",
                        "status": "<string>",
                        "subscription_start_date": "<string>",
                        "tier": "<string>",
                        "trial_end_date": "<string>",
                        "trial_start_date": "<string>",
                        "updated_at": "<string>",
                        "user": "<unknown>",
                        "user_id": "<string>"
                      },
                      "subscription_id": "<string>",
                      "updated_at": "<string>",
                      "user": "<unknown>",
                      "user_agent": "<string>",
                      "user_id": "<string>",
                      "webhook_data": {},
                      "webhook_received_at": "<string>"
                    }
                  ],
                  "points": [
                    {
                      "amount": 123,
                      "created_at": "<string>",
                      "created_by": "<string>",
                      "created_by_user": "<unknown>",
                      "id": "<string>",
                      "ip_address": "<string>",
                      "payment_transaction": "<unknown>",
                      "payment_transaction_id": "<string>",
                      "reason": "<string>",
                      "site_id": "<string>",
                      "transaction_type": "<string>",
                      "user": "<unknown>",
                      "user_agent": "<string>",
                      "user_id": "<string>"
                    }
                  ],
                  "profile": {
                    "accepts_marketing": true,
                    "address": "<string>",
                    "address_2": "<string>",
                    "city": "<string>",
                    "country": "<string>",
                    "created_at": "<string>",
                    "first_name": "<string>",
                    "id": "<string>",
                    "klaviyo_id": "<string>",
                    "last_name": "<string>",
                    "latitude": "<string>",
                    "locale": "<string>",
                    "longitude": "<string>",
                    "organization": "<string>",
                    "phone_number": "<string>",
                    "site_id": "<string>",
                    "state_region": "<string>",
                    "timezone": "<string>",
                    "title": "<string>",
                    "updated_at": "<string>",
                    "user_id": "<string>",
                    "zip_code": "<string>"
                  },
                  "raffle_entries": "<array>",
                  "role": "<string>",
                  "signup_source": "<string>",
                  "site_id": "<string>",
                  "updated_at": "<string>"
                },
                "user_id": "<string>"
              }
            ],
            "worth_subline": "<string>",
            "worth_total": "<string>"
          },
          "raffle_id": "<string>",
          "site_id": "<string>",
          "user": {
            "account_locked_until": "<string>",
            "activity_logs": [
              {
                "activity_type": "<string>",
                "created_at": "<string>",
                "description": "<string>",
                "id": "<string>",
                "ip_address": "<string>",
                "metadata": {},
                "request_id": "<string>",
                "resource_id": "<string>",
                "resource_type": "<string>",
                "session_id": "<string>",
                "severity": "<string>",
                "site_id": "<string>",
                "user": "<unknown>",
                "user_agent": "<string>",
                "user_id": "<string>"
              }
            ],
            "consent_given_at": "<string>",
            "consent_version": "<string>",
            "created_at": "<string>",
            "data_processing_consent": true,
            "deleted_at": "<string>",
            "deletion_reason": "<string>",
            "email": "<string>",
            "failed_login_attempts": 123,
            "has_consented": true,
            "id": "<string>",
            "last_login_at": "<string>",
            "marketing_consent": true,
            "name": "<string>",
            "payment_transactions": [
              {
                "amount_cents": 123,
                "created_at": "<string>",
                "currency": "<string>",
                "description": "<string>",
                "fraud_score": 123,
                "gateway": "<string>",
                "gateway_transaction_id": "<string>",
                "id": "<string>",
                "ip_address": "<string>",
                "metadata": {},
                "payment_method": "<string>",
                "points": [
                  {
                    "amount": 123,
                    "created_at": "<string>",
                    "created_by": "<string>",
                    "created_by_user": "<unknown>",
                    "id": "<string>",
                    "ip_address": "<string>",
                    "payment_transaction": "<unknown>",
                    "payment_transaction_id": "<string>",
                    "reason": "<string>",
                    "site_id": "<string>",
                    "transaction_type": "<string>",
                    "user": "<unknown>",
                    "user_agent": "<string>",
                    "user_id": "<string>"
                  }
                ],
                "site_id": "<string>",
                "status": "<string>",
                "subscription": {
                  "amount_cents": 123,
                  "auto_renew": true,
                  "billing_interval": "<string>",
                  "cancellation_reason": "<string>",
                  "cancelled_at": "<string>",
                  "cooling_off_expiry": "<string>",
                  "created_at": "<string>",
                  "credits_used_this_period": 123,
                  "currency": "<string>",
                  "current_period_end": "<string>",
                  "current_period_start": "<string>",
                  "entry_credits_per_period": 123,
                  "id": "<string>",
                  "is_trial_active": true,
                  "metadata": {},
                  "next_billing_date": "<string>",
                  "nomupay_registration_id": "<string>",
                  "nomupay_schedule_id": "<string>",
                  "paused_until": "<string>",
                  "payment_method": "<string>",
                  "site_id": "<string>",
                  "status": "<string>",
                  "subscription_start_date": "<string>",
                  "tier": "<string>",
                  "trial_end_date": "<string>",
                  "trial_start_date": "<string>",
                  "updated_at": "<string>",
                  "user": "<unknown>",
                  "user_id": "<string>"
                },
                "subscription_id": "<string>",
                "updated_at": "<string>",
                "user": "<unknown>",
                "user_agent": "<string>",
                "user_id": "<string>",
                "webhook_data": {},
                "webhook_received_at": "<string>"
              }
            ],
            "points": [
              {
                "amount": 123,
                "created_at": "<string>",
                "created_by": "<string>",
                "created_by_user": "<unknown>",
                "id": "<string>",
                "ip_address": "<string>",
                "payment_transaction": "<unknown>",
                "payment_transaction_id": "<string>",
                "reason": "<string>",
                "site_id": "<string>",
                "transaction_type": "<string>",
                "user": "<unknown>",
                "user_agent": "<string>",
                "user_id": "<string>"
              }
            ],
            "profile": {
              "accepts_marketing": true,
              "address": "<string>",
              "address_2": "<string>",
              "city": "<string>",
              "country": "<string>",
              "created_at": "<string>",
              "first_name": "<string>",
              "id": "<string>",
              "klaviyo_id": "<string>",
              "last_name": "<string>",
              "latitude": "<string>",
              "locale": "<string>",
              "longitude": "<string>",
              "organization": "<string>",
              "phone_number": "<string>",
              "site_id": "<string>",
              "state_region": "<string>",
              "timezone": "<string>",
              "title": "<string>",
              "updated_at": "<string>",
              "user_id": "<string>",
              "zip_code": "<string>"
            },
            "raffle_entries": "<array>",
            "role": "<string>",
            "signup_source": "<string>",
            "site_id": "<string>",
            "updated_at": "<string>"
          },
          "user_agent": "<string>",
          "user_id": "<string>"
        }
      ],
      "role": "<string>",
      "signup_source": "<string>",
      "site_id": "<string>",
      "updated_at": "<string>"
    },
    "user_agent": "<string>",
    "user_id": "<string>"
  }
]

Authorizations

Authorization
string
header
required

Type "Bearer" followed by a space and JWT token.

Query Parameters

page
integer
default:1

Page number

page_size
integer
default:50

Page size

Response

OK

claimed_code
string
created_at
string
discount_code
object
discount_code_id
string
id
string
ip_address
string
points_spent
integer
site_id
string
user
object
user_agent
string
user_id
string