---
canonical_url: "https://docs.composio.dev/toolkits/bread_butter"
markdown_url: "https://docs.composio.dev/toolkits/bread_butter.md"
product: "platform"
version: null
last_updated: null
---

# Bread & Butter

Bread & Butter is a lead-intelligence and identity platform for managing website visitors, profiles, attribution, authentication, and conversion workflows.

- **Category:** marketing automation
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 8
- **Triggers:** 0
- **Slug:** `BREAD_BUTTER`
- **Version:** 00000000_00

## Tools

### Get Application

**Slug:** `BREAD_BUTTER_GET_APPLICATION`

Return settings, feature flags, plan details, and lead-status definitions for the application bound to the connected credentials.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Attribution Report

**Slug:** `BREAD_BUTTER_GET_ATTRIBUTION_REPORT`

Return visitor and conversion attribution metrics by reporting period and source for the connected application.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Insights

**Slug:** `BREAD_BUTTER_GET_USER_INSIGHTS`

Return aggregate attribution and user-journey insights for the connected application, with optional top-page and geography detail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `include_top_pages` | boolean | No | Include top-page detail within the requested insight sections. |
| `include_attribution` | boolean | No | Include attribution summaries such as visitor counts and conversion rates. |
| `include_user_journey` | boolean | No | Include user-journey summaries such as engagement metrics. |
| `include_top_geography` | boolean | No | Include top-city and top-country detail within the requested insight sections. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Applications

**Slug:** `BREAD_BUTTER_LIST_APPLICATIONS`

List Bread & Butter applications available to the connected credentials, optionally filtering by status or name; returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `active` | boolean | No | Filter applications by active status; omit to include both active and inactive applications. |
| `search` | string | No | Filter applications using the provider's application search text. |
| `page_size` | integer | No | Number of applications to request in this page; no provider-wide maximum was live-verified. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Event Definitions

**Slug:** `BREAD_BUTTER_LIST_EVENT_DEFINITIONS`

List configured event definitions for the connected application, optionally filtering by enabled status; returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Filter event definitions by whether they are enabled; omit to include both states. |
| `page_size` | integer | No | Number of event definitions to request in this page; no maximum was live-verified. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Events

**Slug:** `BREAD_BUTTER_LIST_EVENTS`

List tracked activity events for the connected application, optionally scoped to a user or date range; returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | No | Return only events associated with this Bread & Butter user or profile ID. |
| `end_date` | string | No | Provider date/time string marking the end of the event range. |
| `page_size` | integer | No | Number of events to request in this page; the provider default is 25. |
| `start_date` | string | No | Provider date/time string marking the beginning of the event range. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Lead Lists

**Slug:** `BREAD_BUTTER_LIST_LEAD_LISTS`

Return the saved lead lists configured for the application bound to the connected credentials.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Leads

**Slug:** `BREAD_BUTTER_LIST_LEADS`

List lead and visitor profiles for the connected application, optionally filtering by email address; returns one page and a continuation cursor.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page_size` | integer | No | Number of lead profiles to request in this page; no maximum was live-verified for this route. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `email_address` | string | No | Return profiles matching this email address; omit to list profiles without an email filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |