Palestine Campaign
API Documentation

Search and lookup boycotted brands. Find brands by name, campaign, or list all brands with campaign context information.

View Endpoints View Examples
Brand Search
Brand Listing
Campaign Lookup
Context Info
Quick Start
curl -X GET "https://api.univence.com/v1/boycott/search?q=nike" \
-H "X-API-Key: your-api-key-here"

Overview

Everything you need to know about the Boycott Brands API

Base URL

https://api.univence.com

Authentication

All endpoints require authentication via:

  • API Key: Include X-API-Key: your-api-key in headers
  • Bearer Token: Include Authorization: Bearer your-jwt-token in headers

Data Structure

Each brand record contains:

  • brandName - The brand name
  • campaignName - The boycott campaign name (e.g., "Free Palestine", "Liberty")
  • campaignTier - The tier level within the campaign

Table of Contents

  1. API Endpoints
  2. Usage Examples

API Endpoints

Complete documentation for all boycott brand endpoints

GET
/v1/boycott/search?q={query}

1. Search Brands by Name

Search boycott brands by name (case-insensitive). Returns up to 20 matching brands.

Request

curl -X GET "https://api.univence.com/v1/boycott/search?q=nike" \
  -H "X-API-Key: your-api-key"

Query Parameters

ParameterTypeRequiredDescription
qstringYesBrand name to search for (max 100 characters)

Response

{
  "success": true,
  "result": [
    {
      "brandName": "Nike",
      "campaignTier": "Tier 1",
      "campaignName": "Free Palestine"
    }
  ]
}
GET
/v1/boycott/brand/{name}

2. Get Single Brand

Get details for a single brand by exact name (case-insensitive).

Request

curl -X GET "https://api.univence.com/v1/boycott/brand/Nike" \
  -H "X-API-Key: your-api-key"

Path Parameters

ParameterTypeRequiredDescription
namestringYesExact brand name (case-insensitive)

Response

{
  "success": true,
  "result": {
    "brandName": "Nike",
    "campaignTier": "Tier 1",
    "campaignName": "Free Palestine"
  }
}

Error Responses

404 Not Found: Brand not found

{
  "error": "Brand 'UnknownBrand' not found"
}
GET
/v1/boycott/brands?page={page}&limit={limit}

3. List All Brands

List all boycott brands with pagination. Results are sorted alphabetically by brand name.

Request

curl -X GET "https://api.univence.com/v1/boycott/brands?page=1&limit=50" \
  -H "X-API-Key: your-api-key"

Query Parameters

ParameterTypeRequiredDescriptionDefault
pageintegerNoPage number (1-based)1
limitintegerNoItems per page (max 200)50

Response

{
  "success": true,
  "total": 500,
  "page": 1,
  "limit": 50,
  "result": [
    {
      "brandName": "Adidas",
      "campaignTier": "Tier 2",
      "campaignName": "Free Palestine"
    }
  ]
}
GET
/v1/boycott/campaign/{campaignName}

4. Get Brands by Campaign

Search brands by campaign name (e.g., "Free Palestine", "Liberty"). Case-insensitive with pagination.

Request

curl -X GET "https://api.univence.com/v1/boycott/campaign/Free%20Palestine?page=1&limit=50" \
  -H "X-API-Key: your-api-key"

Path Parameters

ParameterTypeRequiredDescription
campaignNamestringYesCampaign name to filter by

Query Parameters

ParameterTypeRequiredDescriptionDefault
pageintegerNoPage number (1-based)1
limitintegerNoItems per page (max 200)50

Response

{
  "success": true,
  "total": 150,
  "page": 1,
  "limit": 50,
  "campaign": "Free Palestine",
  "result": [
    {
      "brandName": "Nike",
      "campaignTier": "Tier 1",
      "campaignName": "Free Palestine"
    }
  ]
}
GET
/v1/boycott/campaigns

5. List All Campaigns

Get all unique campaign names.

Request

curl -X GET "https://api.univence.com/v1/boycott/campaigns" \
  -H "X-API-Key: your-api-key"

Response

{
  "success": true,
  "result": ["Free Palestine", "Liberty", "BDS"]
}
GET
/v1/boycott/campaign-info

6. Get Campaign Info

Get all campaign info with descriptions and tier meanings.

Request

curl -X GET "https://api.univence.com/v1/boycott/campaign-info" \
  -H "X-API-Key: your-api-key"

Response

{
  "success": true,
  "result": [
    {
      "campaignName": "Free Palestine",
      "description": "Campaign against companies supporting...",
      "moreInfoUrl": "https://bdsmovement.net/",
      "tierDescriptions": {
        "Tier 1": "Companies directly involved",
        "Tier 2": "Companies indirectly supporting"
      }
    }
  ]
}
GET
/v1/boycott/search-with-context?q={query}

7. Search Brands with Context

Search boycott brands by name and include campaign context (description + tier meanings) when results belong to a single campaign.

Request

curl -X GET "https://api.univence.com/v1/boycott/search-with-context?q=nike" \
  -H "X-API-Key: your-api-key"

Query Parameters

ParameterTypeRequiredDescription
qstringYesBrand name to search for (max 100 characters)

Response

{
  "success": true,
  "result": [
    {
      "brandName": "Nike",
      "campaignTier": "Tier 1",
      "campaignName": "Free Palestine"
    }
  ],
  "campaignContext": {
    "description": "Campaign against companies supporting...",
    "moreInfoUrl": "https://bdsmovement.net/",
    "tierDescriptions": {
      "Tier 1": "Companies directly involved",
      "Tier 2": "Companies indirectly supporting"
    }
  }
}

Usage Examples

End-to-end examples for common use cases

Search for a Brand

curl -X GET "https://api.univence.com/v1/boycott/search?q=starbucks" \
  -H "X-API-Key: your-api-key"

Expected: Returns brand details with campaign and tier info.

List All Brands (Page 1)

curl -X GET "https://api.univence.com/v1/boycott/brands?page=1&limit=20" \
  -H "X-API-Key: your-api-key"

Expected: Returns first 20 brands sorted alphabetically with total count.

List All Campaign Names

curl -X GET "https://api.univence.com/v1/boycott/campaigns" \
  -H "X-API-Key: your-api-key"

Get Brands in a Campaign

curl -X GET "https://api.univence.com/v1/boycott/campaign/Free%20Palestine" \
  -H "X-API-Key: your-api-key"

Expected: Returns all brands in the "Free Palestine" campaign.

Search with Campaign Context

curl -X GET "https://api.univence.com/v1/boycott/search-with-context?q=mcdonalds" \
  -H "X-API-Key: your-api-key"

Expected: Returns matching brands plus campaign description and tier meanings.

Get Campaign Info

curl -X GET "https://api.univence.com/v1/boycott/campaign-info" \
  -H "X-API-Key: your-api-key"

Expected: Returns all campaign descriptions and tier details.

Get Specific Brand

curl -X GET "https://api.univence.com/v1/boycott/brand/Coca-Cola" \
  -H "X-API-Key: your-api-key"

Expected: Returns exact brand match or 404 if not found.

Ready to Integrate?

Add boycott brand lookup to your applications today

Get Started Back to Home