Partner ApiPartner Account

Partner Account

Endpoints for retrieving partner details, updating branding, and fetching script configuration.

Get Partner Details

Retrieve the current partner account information.

Request:

GET /partner/me

Response:

{
  "partner": {
    "id": "uuid",
    "name": "Partner Name",
    "slug": "partner-slug",
    "status": "active",
    "companyName": "Company Inc",
    "supportEmail": "support@company.com",
    "logoUrl": "https://example.com/logo.png",
    "primaryColor": "#0066cc",
    "secondaryColor": "#333333",
    "scriptDomain": "track.example.com",
    "scriptDomainVerified": true,
    "billingMode": "pooled",
    "creditPoolTotal": 10000,
    "creditPoolUsed": 2500,
    "creditPoolAvailable": 7500,
    "maxOrganizations": 100,
    "maxIdentificationsPerOrg": 5000,
    "identificationWebhookUrl": "https://example.com/webhooks/identify",
    "identificationWebhookEnabled": true,
    "billingWebhookUrl": "https://example.com/webhooks/billing",
    "billingWebhookEnabled": true,
    "createdAt": "2025-01-01T00:00:00Z",
    "isOwner": true
  }
}

Example:

curl -X GET "https://api.app.bullseye.so/api/v1/partner/me" 
  -H "X-Partner-API-Key: your-api-key"

Update Branding

Update partner branding settings (logo, colors, company name).

Request:

PUT /partner/branding

Body:

{
  "logoUrl": "https://example.com/new-logo.png",
  "primaryColor": "#0066cc",
  "secondaryColor": "#333333",
  "companyName": "Updated Company Name"
}

All fields are optional. Only include fields you want to update.

Response:

{
  "partner": {
    "id": "uuid",
    "name": "Partner Name",
    "slug": "partner-slug",
    "logoUrl": "https://example.com/new-logo.png",
    "primaryColor": "#0066cc",
    "secondaryColor": "#333333",
    "companyName": "Updated Company Name"
  }
}

Example:

curl -X PUT "https://api.app.bullseye.so/api/v1/partner/branding" 
  -H "X-Partner-API-Key: your-api-key" 
  -H "Content-Type: application/json" 
  -d '{"primaryColor": "#0066cc", "companyName": "My Company"}'

Get Script Configuration

Retrieve the configuration needed for embedding the partner tracking script.

Request:

GET /partner/script-config

Response:

{
  "scriptDomain": "track.example.com",
  "scriptDomainVerified": true,
  "companyName": "Company Inc",
  "slug": "partner-slug"
}

Example:

curl -X GET "https://api.app.bullseye.so/api/v1/partner/script-config" 
  -H "X-Partner-API-Key: your-api-key"
AuthenticationAPI Keys