graph8

https://docs.graph8.com/developers
Admin
graph8 is a B2B data discovery and CRM platform with a REST API for programmatically discovering...
Tokens:60,113
Snippets:364
Trust Score:7.8
Update:7 months ago
Show doc for...
Tokens:
Raw
### Example AI Queries for graph8 Studio

Source: https://docs.graph8.com/developers/cursor-setup

Sample prompts that can be used within the Cursor AI chat interface once the MCP connection is successfully established.

```text
Show me my active campaigns in G8 Studio
What accounts are in the healthcare industry?
Get the intelligence report for [account name]
Search G8 Studio for content about enterprise pricing
```

--------------------------------

### Example Workflows

Source: https://docs.graph8.com/developers/n8n-setup

Illustrative examples of how to use n8n with graph8 Studio MCP tools to automate common tasks.

```APIDOC
## Example Workflows

### Sync New Campaigns to Slack

1.  **Trigger** : Schedule (every hour) or Webhook
2.  **MCP Node** : `list_campaigns` with status=“active”
3.  **Filter Node** : Only new campaigns since last run
4.  **Slack Node** : Post to #marketing channel

### Enrich CRM with Account Intelligence

1.  **Trigger** : Webhook from CRM (new deal created)
2.  **MCP Node** : `get_account` by company name
3.  **MCP Node** : `get_intelligence` for the account
4.  **HTTP Node** : Update CRM record with intelligence data

### Daily Pipeline Report

1.  **Trigger** : Schedule (9am daily)
2.  **MCP Node** : `list_deals`
3.  **Code Node** : Summarize pipeline by stage
4.  **Email Node** : Send report to sales team
```

--------------------------------

### Example Questions for Claude Desktop with graph8 Studio

Source: https://docs.graph8.com/developers/claude-desktop-setup

These are example natural language queries you can ask Claude Desktop once connected to graph8 Studio. They demonstrate how to retrieve information about campaigns, accounts, intelligence reports, and pipeline deals.

```text
Show me my active campaigns in G8 Studio
```

```text
What accounts are in the healthcare industry?
```

```text
Get the intelligence report for [account name]
```

```text
Search G8 Studio for content about competitive positioning
```

```text
What deals are in my pipeline?
```

--------------------------------

### n8n Setup and Configuration

Source: https://docs.graph8.com/developers/n8n-setup

Instructions for connecting n8n to graph8 Studio using the MCP integration. This includes prerequisites, setup steps, and configuring the HTTP Request node.

```APIDOC
## n8n Setup

Connect n8n to graph8 Studio to automate workflows with your campaigns, accounts, and intelligence data.

### Prerequisites

*   n8n instance (self-hosted or cloud)
*   A graph8 Studio account
*   n8n MCP support enabled (requires n8n 1.x+)

### Setup Steps

1.  **Connect in graph8 Studio**
    Go to Profile and click “Connect” in the MCP card. Complete the sign-in flow.
2.  **Copy the n8n configuration**
    After connecting, expand “Setup Instructions” and select the **n8n** tab. Copy the HTTP Request configuration.
3.  **Add HTTP Request node in n8n**
    In your n8n workflow, add an **HTTP Request** node.
4.  **Configure the connection**
    Paste the configuration from your Profile page, or use this format:
    ```
    https://mcp-production-c2f3.up.railway.app/mcp?session_id=YOUR_SESSION_ID
    ```
5.  **Test the connection**
    Use the “Test” button in n8n to verify the connection works.
```

--------------------------------

### Manual HTTP Request Configuration

Source: https://docs.graph8.com/developers/n8n-setup

Configuration details for the HTTP Request node in n8n, useful for manual setup or older n8n versions without native MCP support.

```APIDOC
## Manual HTTP Setup

If your n8n version doesn’t have native MCP support, use the HTTP Request node:

```json
{
  "method": "POST",
  "url": "https://mcp-production-c2f3.railway.app/mcp",
  "headers": {
    "Content-Type": "application/json"
  },
  "body": {
    "jsonrpc": "2.0",
    "method": "tools/call",
    "params": {
      "name": "list_campaigns",
      "arguments": {
        "status": "active"
      }
    },
    "id": 1
  },
  "qs": {
    "session_id": "YOUR_SESSION_ID"
  }
}
```
```

--------------------------------

### Install g8 CLI

Source: https://docs.graph8.com/developers/cli

Installs the g8 command-line interface using pip. Requires Python 3.10 or higher.

```bash
pip install g8-mcp-server
```

--------------------------------

### Example 429 Response Headers

Source: https://docs.graph8.com/developers/rate-limits

Demonstrates the structure of an HTTP response when a rate limit is exceeded. It includes headers like 'Retry-After' to guide subsequent requests and 'X-RateLimit-Limit-Minute'/'X-RateLimit-Limit-Second' to indicate the enforced limits.

```http
HTTP/1.1 429 Too Many Requests
Retry-After: 3
X-RateLimit-Limit-Minute: 200
X-RateLimit-Limit-Second: 10
Content-Type: application/json

{"detail": "Rate limit exceeded. Please slow down."}
```

--------------------------------

### Get Graph8 tracking snippet for Next.js

Source: https://docs.graph8.com/developers/cli

Generates the Graph8 tracking snippet specifically for Next.js applications. It provides setup instructions for both App Router and Pages Router, along with code examples for integrating the script. The snippet facilitates tracking and identification methods.

```javascript
// app/layout.tsx (App Router)
import Script from 'next/script';


export default function RootLayout({ children }) {
  return (
    <html>
      <head>
        <Script
          src="https://t.graph8.com/p.js"
          data-write-key="your-write-key"
          data-tracking-host="https://t.graph8.com"
          strategy="afterInteractive"
        />
      </head>
      <body>{children}</body>
    </html>
  );
}
```

--------------------------------

### Configure Remote MCP Server for AI Clients

Source: https://docs.graph8.com/developers/mcp

Configuration JSON for connecting AI clients to the graph8 remote MCP server via URL. This setup is recommended for Claude Code, Cursor, and Windsurf to enable seamless integration without local installation.

```json
{
  "mcpServers": {
    "graph8": {
      "url": "https://be.graph8.com/mcp/"
    }
  }
}
```

--------------------------------

### Get Deal

Source: https://docs.graph8.com/developers/deals

Returns a single deal by ID.

```APIDOC
## Get Deal

### Description
Returns a single deal by ID.

### Method
GET

### Endpoint
/deals/{deal_id}

### Parameters
#### Path Parameters
- **deal_id** (string) - Required - The ID of the deal to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl "https://be.graph8.com/api/v1/deals/deal-abc" \
  -H "Authorization: Bearer $API_KEY"
```

### Response
#### Success Response (200)
- **data** (object) - The deal object.
  - **id** (string) - The unique identifier for the deal.
  - **name** (string) - The name of the deal.
  - **amount** (number) - The monetary value of the deal.
  - **currency** (string) - The currency code (e.g., 'USD').
  - **stage_id** (string) - The ID of the current stage.
  - **stage_name** (string) - The name of the current stage.
  - **pipeline_id** (string) - The ID of the pipeline the deal belongs to.
  - **company_id** (integer) - The ID of the associated company.
  - **close_date** (string) - The expected close date in ISO 8601 format.
  - **created_at** (string) - The timestamp when the deal was created.
  - **updated_at** (string) - The timestamp when the deal was last updated.

#### Response Example
```json
{
  "data": {
    "id": "deal-abc",
    "name": "Enterprise Contract",
    "amount": 50000,
    "currency": "USD",
    "stage_id": "stage-2",
    "stage_name": "Proposal",
    "pipeline_id": "pipe-123",
    "company_id": 456,
    "close_date": "2026-06-30T00:00:00",
    "created_at": "2026-02-20T10:00:00",
    "updated_at": "2026-02-25T14:30:00"
  }
}
```
```

--------------------------------

### Frequently Asked Questions

Source: https://docs.graph8.com/developers/n8n-setup

Answers to common questions regarding n8n Cloud vs. self-hosted, session expiration handling, rate limits, triggering workflows, and testing MCP calls.

```APIDOC
## Frequently Asked Questions

### Can I use n8n Cloud or do I need self-hosted?

Both work. n8n Cloud and self-hosted instances can connect to graph8 Studio via MCP. The HTTP Request node method works universally.

### How do I handle session expiration in automated workflows?

Store your session ID in n8n credentials for easy updating. Set up error handling to catch authentication failures, and consider adding alerting when sessions expire.

### Are there rate limits on MCP calls from n8n?

Yes, graph8 Studio has rate limits. Add delays between requests in high-volume workflows. If you hit limits, you’ll receive a rate limit error response.

### Can I trigger n8n workflows from graph8 Studio?

Use webhooks for this. Configure an outbound webhook in graph8 Studio that calls your n8n webhook trigger URL when events occur (campaign created, intelligence complete, etc.).

### How do I test MCP calls before building full workflows?

Use n8n’s HTTP Request node with the “Test” button. You can verify responses before connecting to other nodes. Start with simple calls like `list_campaigns`.
```

--------------------------------

### Identify MCP Configuration File Paths

Source: https://docs.graph8.com/developers/cursor-setup

Lists the standard file system paths for the mcp.json configuration file across different operating systems.

```text
macOS: ~/.cursor/mcp.json
Windows: %USERPROFILE%\.cursor\mcp.json
Linux: ~/.cursor/mcp.json
```

--------------------------------

### Troubleshooting Common Issues

Source: https://docs.graph8.com/developers/n8n-setup

Guidance on resolving common problems encountered during n8n integration, such as authentication failures, tool not found errors, and rate limiting.

```APIDOC
## Troubleshooting

### "Authentication failed"

1.  Go to Profile in graph8 Studio
2.  Check if your session is still active
3.  If expired, click “Connect” for a new session
4.  Update the session ID in your n8n workflow

### "Tool not found"

*   Verify you’re using the correct tool name (case-sensitive)
*   Check the capabilities guide for available tools

### Rate limiting

*   graph8 Studio has rate limits on API calls
*   Add delays between requests in high-volume workflows
*   Consider batching operations where possible
```

--------------------------------

### Session Management

Source: https://docs.graph8.com/developers/n8n-setup

Information on managing MCP session expiration for long-running automations and best practices for maintaining active connections.

```APIDOC
## Session Management

MCP sessions expire after 24 hours of inactivity. For long-running automations:

1.  Check session validity at the start of critical workflows
2.  Set up alerts for authentication failures
3.  Refresh sessions proactively from the Profile page
```

--------------------------------

### Manage Tracking Snippets and Data

Source: https://docs.graph8.com/developers/cli

Commands for installing the tracking snippet and piping output to external tools like jq.

```bash
g8 snippet --framework html --format json | jq '.snippet_code'
g8 snippet --framework nextjs
```

--------------------------------

### Example Authentication Error Response

Source: https://docs.graph8.com/developers/authentication

Provides an example of an error response when authentication fails due to a missing or invalid 'Authorization' header. This JSON structure helps in diagnosing authentication issues.

```json
{
  "detail": "Missing Authorization header. Use: Authorization: Bearer <api_key>"
}
```

--------------------------------

### Available MCP Actions

Source: https://docs.graph8.com/developers/n8n-setup

List of available MCP tools that can be used within n8n workflows to interact with graph8 Studio data.

```APIDOC
## Available Actions

Once connected, you can use these MCP tools in your n8n workflows:

### Campaigns

*   `list_campaigns` — Get all campaigns with optional status filter
*   `get_campaign` — Get details for a specific campaign
*   `search_campaigns` — Search campaigns by keyword

### Accounts

*   `list_accounts` — Get all accounts
*   `get_account` — Get account details by ID or name
*   `search_accounts` — Search accounts by industry, name, etc.

### Deals

*   `list_deals` — Get pipeline deals
*   `get_deal` — Get deal details

### Intelligence

*   `get_intelligence` — Get intelligence for an account
*   `search` — Search across all graph8 Studio data
```

--------------------------------

### List Deal Pipelines

Source: https://docs.graph8.com/developers/deals

Returns all deal pipelines and their stages. Use this to get valid `pipeline_id` and `stage_id` values before creating deals.

```APIDOC
## List Deal Pipelines

### Description
Returns all deal pipelines and their stages. Use this to get valid `pipeline_id` and `stage_id` values before creating deals.

### Method
GET

### Endpoint
/deals/pipelines

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl "https://be.graph8.com/api/v1/deals/pipelines" \
  -H "Authorization: Bearer $API_KEY"
```

### Response
#### Success Response (200)
- **data** (array) - An array of pipeline objects, each containing stages.
  - **id** (string) - The unique identifier for the pipeline.
  - **name** (string) - The name of the pipeline.
  - **is_default** (boolean) - Indicates if this is the default pipeline.
  - **stages** (array) - An array of stage objects within the pipeline.
    - **id** (string) - The unique identifier for the stage.
    - **name** (string) - The name of the stage.
    - **probability** (integer) - The probability of closing a deal in this stage (0-100).
    - **position** (integer) - The order of the stage within the pipeline.
    - **stage_type** (string) - The type of stage (e.g., 'open').
    - **color** (string) - The color associated with the stage.

#### Response Example
```json
{
  "data": [
    {
      "id": "pipe-123",
      "name": "Sales Pipeline",
      "is_default": true,
      "stages": [
        {
          "id": "stage-1",
          "name": "Qualification",
          "probability": 10,
          "position": 0,
          "stage_type": "open",
          "color": "#3B82F6"
        },
        {
          "id": "stage-2",
          "name": "Proposal",
          "probability": 50,
          "position": 1,
          "stage_type": "open",
          "color": "#F59E0B"
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Iterating Through Pages with TypeScript

Source: https://docs.graph8.com/developers/pagination

This TypeScript example shows an asynchronous function to fetch all contacts. It employs a `while` loop and the `fetch` API to retrieve data page by page, stopping when `pagination.has_next` is false.

```APIDOC
## Iterating Through Pages (TypeScript)

```typescript
const API_KEY = "your_api_key_here";
const BASE_URL = "https://be.graph8.com/api/v1";


async function fetchAllContacts() {
  const allContacts = [];
  let page = 1;


  while (true) {
    const response = await fetch(
      `${BASE_URL}/contacts?page=${page}&limit=200`,
      { headers: { Authorization: `Bearer ${API_KEY}` } }
    );
    const { data, pagination } = await response.json();


    allContacts.push(...data);


    if (!pagination.has_next) break;
    page++;
  }


  return allContacts;
}
```
```

--------------------------------

### Get Graph8 tracking snippet for a specific repository

Source: https://docs.graph8.com/developers/cli

Generates the Graph8 tracking snippet for a given framework, tailored for a specific repository ID. This allows for repository-specific configurations when generating the snippet.

```bash
g8 snippet --framework react --repo-id <repo-id>
```

--------------------------------

### Configure n8n HTTP Request Connection

Source: https://docs.graph8.com/developers/n8n-setup

The base URL configuration required to establish a connection between n8n and the graph8 Studio MCP endpoint. Requires a valid session_id parameter for authentication.

```text
https://mcp-production-c2f3.up.railway.app/mcp?session_id=YOUR_SESSION_ID
```

--------------------------------

### Run Sequence (Python)

Source: https://docs.graph8.com/developers/sequences

Starts a drafted sequence using Python's requests library. This operation schedules future email sends for contacts within the sequence. Ensure BASE_URL and HEADERS are configured.

```python
import requests

BASE_URL = "https://api.graph8.com/api/v1"
API_KEY = "YOUR_API_KEY"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}
SEQUENCE_ID = "seq-abc"

response = requests.post(
    f"{BASE_URL}/sequences/{SEQUENCE_ID}/run",
    headers=HEADERS
)
```

--------------------------------

### List all supported frameworks for g8 snippet

Source: https://docs.graph8.com/developers/cli

Lists all the frameworks for which the g8 CLI can generate tracking snippets. This command is useful for discovering supported integrations.

```bash
g8 snippet --list
```

--------------------------------

### Initialize and Track Events with Graph8 SDK

Source: https://docs.graph8.com/developers/mcp

Demonstrates the standard implementation pattern for the Graph8 tracking SDK. This includes identifying users upon login and tracking specific user actions within a web application.

```javascript
// Identify user on login
g8.identify({
  userId: "user_123",
  email: "user@example.com"
});

// Track key actions
g8.track("button_clicked", {
  button_id: "signup_cta"
});
```

--------------------------------

### List Company Fields - Python

Source: https://docs.graph8.com/developers/fields

Uses Python's requests library to get all company field definitions. The code makes a GET request to the /fields/companies endpoint and processes the JSON response. Requires BASE_URL and HEADERS to be set.

```python
response = requests.get(
    f"{BASE_URL}/fields/companies",
    headers=HEADERS
)
fields = response.json()
```

--------------------------------

### Get Contact Deals

Source: https://docs.graph8.com/developers/deals

Returns all deals associated with a specific contact.

```APIDOC
## Get Contact Deals

### Description
Returns all deals associated with a specific contact.

### Method
GET

### Endpoint
/contacts/{contact_id}/deals

### Parameters
#### Path Parameters
- **contact_id** (string) - Required - The ID of the contact whose deals to retrieve.

#### Query Parameters
None

#### Request Body
None

### Request Example
```curl
curl "https://be.graph8.com/api/v1/contacts/12345/deals" \
  -H "Authorization: Bearer $API_KEY"
```

### Response
#### Success Response (200)
- **data** (array) - An array of deal objects associated with the contact.
  - **deal_id** (string) - The ID of the deal.
  - **name** (string) - The name of the deal.
  - **stage** (string) - The current stage of the deal.
  - **value** (number) - The value of the deal.
  - **currency** (string) - The currency of the deal.
  - **pipeline_id** (string) - The ID of the pipeline the deal belongs to.
  - **close_date** (string) - The expected close date.
  - **created_at** (string) - The timestamp when the deal was created.

#### Response Example
```json
{
  "data": [
    {
      "deal_id": "deal-abc",
      "name": "Enterprise Contract",
      "stage": "Proposal",
      "value": 50000,
      "currency": "USD",
      "pipeline_id": "pipe-123",
      "close_date": "2026-06-30",
      "created_at": "2026-02-20T10:00:00"
    }
  ]
}
```
```

--------------------------------

### Troubleshoot MCP Client Connection with Node.js

Source: https://docs.graph8.com/developers/claude-desktop-setup

This command-line snippet is used to manually run the MCP client and diagnose connection issues. It helps in identifying errors by executing the npx command directly with a test session ID.

```bash
npx -y @anthropic-ai/mcp-client-sse "https://mcp-production-c2f3.up.railway.app/mcp?session_id=TEST"
```

--------------------------------

### Get Company

Source: https://docs.graph8.com/developers/companies

Retrieves detailed information for a specific company using its ID.

```APIDOC
## GET /companies/{company_id}

### Description
Returns detailed information about a single company.

### Method
GET

### Endpoint
/companies/{company_id}

### Path Parameters
- **company_id** (integer) - Required - Company ID

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the company.
- **name** (string) - Name of the company.
- **description** (string) - Description of the company.
- **domain** (string) - Company's primary domain.
- **website** (string) - Company's website URL.
- **industry** (string) - Industry the company belongs to.
- **employee_count** (string) - Number of employees.
- **revenue** (string) - Annual revenue.
- **founded_year** (integer) - Year the company was founded.
- **city** (string) - City where the company is located.
- **state** (string) - State where the company is located.
- **country** (string) - Country where the company is located.
- **linkedin_url** (string) - URL to the company's LinkedIn profile.
- **linkedin_followers** (string) - Number of LinkedIn followers.
- **logo_url** (string) - URL to the company's logo.

#### Response Example
```json
{
  "id": 42,
  "name": "Acme Inc",
  "description": "Enterprise software company specializing in cloud solutions",
  "domain": "acme.com",
  "website": "https://acme.com",
  "industry": "Technology",
  "employee_count": "500",
  "revenue": "25000000",
  "founded_year": 2015,
  "city": "San Francisco",
  "state": "CA",
  "country": "US",
  "linkedin_url": "https://linkedin.com/company/acme",
  "linkedin_followers": "12500",
  "logo_url": "https://logo.clearbit.com/acme.com"
}
```
```

--------------------------------

### GET /sequences

Source: https://docs.graph8.com/developers/sequences

Retrieve a list of all sequences with support for filtering by status and pagination.

```APIDOC
## GET /sequences

### Description
Returns all sequences with optional status filter and pagination.

### Method
GET

### Endpoint
/sequences

### Parameters
#### Query Parameters
- **page** (integer) - Optional - Page number (default: 1)
- **limit** (integer) - Optional - Items per page (max 200, default: 50)
- **status** (string) - Optional - Filter by status (drafted, live, paused, completed)

### Response
#### Success Response (200)
- **data** (array) - List of sequence objects
- **pagination** (object) - Pagination metadata

### Response Example
{
  "data": [
    {
      "id": "seq-abc",
      "name": "Q2 Outbound",
      "status": "live"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 1
  }
}
```

--------------------------------

### Iterating Through Pages with cURL

Source: https://docs.graph8.com/developers/pagination

This example demonstrates how to fetch data page by page using cURL. It shows the initial request for page 1 and how to subsequently request page 2 if the `has_next` field in the response indicates that more pages are available.

```APIDOC
## Iterating Through Pages (cURL)

Use `has_next` to determine when to stop paginating.

### Request Example (Fetch page 1)

```bash
curl "https://be.graph8.com/api/v1/contacts?page=1&limit=100" \
  -H "Authorization: Bearer $API_KEY"
```

### Request Example (Fetch page 2 if `has_next` is true)

```bash
curl "https://be.graph8.com/api/v1/contacts?page=2&limit=100" \
  -H "Authorization: Bearer $API_KEY"
```
```

--------------------------------

### GET /sequences/{sequence_id}/contacts

Source: https://docs.graph8.com/developers/sequences

List all contacts currently enrolled in a sequence and their status.

```APIDOC
## GET /sequences/{sequence_id}/contacts

### Description
Returns contacts enrolled in a sequence with their current state.

### Method
GET

### Endpoint
/sequences/{sequence_id}/contacts

### Parameters
#### Path Parameters
- **sequence_id** (string) - Required - The unique identifier of the sequence
#### Query Parameters
- **page** (integer) - Optional - Page number
- **limit** (integer) - Optional - Items per page
- **state** (string) - Optional - Filter by contact state

### Response
#### Success Response (200)
- **data** (array) - List of enrolled contacts

### Response Example
{
  "data": [
    {
      "id": "sc-1",
      "contact_id": 12345,
      "state": "active"
    }
  ]
}
```

--------------------------------

### Pagination Best Practices

Source: https://docs.graph8.com/developers/pagination

Recommendations for effectively using pagination, including maximizing the `limit` parameter, relying on `has_next` for iteration logic, respecting rate limits, and handling data ordering.

```APIDOC
## Best Practices

*   **Use the maximum `limit` (200)** when exporting large datasets to minimize requests.
*   **Check `has_next`** instead of computing from `page * limit < total` — this avoids off-by-one errors.
*   **Respect rate limits** — add a short delay between pages if fetching many pages. See Rate Limits.
*   **Don’t assume order** — results are returned in the default order for each resource. If you need a specific order, sort client-side.
```

--------------------------------

### GET /companies/{company_id}/contacts

Source: https://docs.graph8.com/developers/companies

Retrieves a list of contacts associated with a specific company.

```APIDOC
## GET /companies/{company_id}/contacts

### Description
Retrieves a list of contacts associated with a specific company.

### Method
GET

### Endpoint
`/companies/{company_id}/contacts`

### Parameters
#### Path Parameters
- **company_id** (integer) - Required - The unique identifier for the company.

#### Query Parameters
- **limit** (integer) - Optional - Items per page. Defaults to `100`. Accepts values between 1 and 200.
- **offset** (integer) - Optional - Offset for pagination. Defaults to `0`.

### Request Example
```curl
curl "https://be.graph8.com/api/v1/companies/42/contacts?limit=50" \
  -H "Authorization: Bearer $API_KEY"
```

### Response
#### Success Response (200)
- **data** (array) - A list of contact objects.
  - **id** (integer) - The contact's unique identifier.
  - **first_name** (string) - The contact's first name.
  - **last_name** (string) - The contact's last name.
  - **full_name** (string) - The contact's full name.
  - **work_email** (string) - The contact's work email address.
  - **job_title** (string) - The contact's job title.
  - **seniority_level** (string) - The contact's seniority level.
  - **direct_phone** (string) - The contact's direct phone number.
  - **linkedin_url** (string) - URL to the contact's LinkedIn profile.
  - **city** (string) - The city where the contact is located.
  - **state** (string) - The state or province where the contact is located.
  - **country** (string) - The country where the contact is located.
- **pagination** (object) - Pagination details for the response.
  - **page** (integer) - The current page number.
  - **limit** (integer) - The number of items per page.
  - **total** (integer) - The total number of items available.
  - **has_next** (boolean) - Indicates if there is a next page of results.

#### Response Example
```json
{
  "data": [
    {
      "id": 1,
      "first_name": "Jane",
      "last_name": "Smith",
      "full_name": "Jane Smith",
      "work_email": "jane@acme.com",
      "job_title": "VP of Engineering",
      "seniority_level": "VP",
      "direct_phone": "+1-555-0100",
      "linkedin_url": "https://linkedin.com/in/janesmith",
      "city": "San Francisco",
      "state": "CA",
      "country": "US"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 50,
    "total": 15,
    "has_next": false
  }
}
```
```

--------------------------------

### List Contacts with Filters and Pagination (TypeScript)

Source: https://docs.graph8.com/developers/contacts

Provides examples of listing contacts via the Graph8 API using TypeScript's fetch API. Demonstrates basic pagination and filtering by name, company, department, and industry through URL query parameters.

```typescript
// Basic pagination
const response = await fetch(`${BASE_URL}/contacts?limit=10&page=1`, {
  headers: { Authorization: `Bearer ${API_KEY}` }
});
const contacts = await response.json();


// Search by name and company
const filtered = await fetch(
  `${BASE_URL}/contacts?name=jane&company_name=acme`,
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);


// Filter by department and industry
const deptFiltered = await fetch(
  `${BASE_URL}/contacts?job_department=Engineering&industry=SaaS`,
  { headers: { Authorization: `Bearer ${API_KEY}` } }
);
```

--------------------------------

### GET /webhooks

Source: https://docs.graph8.com/developers/webhooks

Lists all active and inactive webhook subscriptions for the authenticated organization.

```APIDOC
## GET /webhooks

### Description
Returns all webhook subscriptions for your organization.

### Method
GET

### Endpoint
/webhooks

### Parameters
#### Query Parameters
- **is_active** (boolean) - Optional - Filter by active status

### Response
#### Success Response (200)
- **data** (array) - List of webhook subscription objects

#### Response Example
{
  "data": [
    {
      "id": "wh-abc",
      "name": "CRM Sync",
      "url": "https://example.com/webhooks/graph8",
      "is_active": true
    }
  ]
}
```

--------------------------------

### Configure MCP Server in Cursor IDE

Source: https://docs.graph8.com/developers/cursor-setup

Defines the JSON structure required for the mcp.json configuration file to register the graph8 Studio MCP server. Users must replace the placeholder session ID with their unique identifier obtained from the graph8 Studio profile.

```json
{
  "mcpServers": {
    "g8studio": {
      "transport": "sse",
      "url": "https://mcp-production-c2f3.up.railway.app/mcp?session_id=YOUR_SESSION_ID"
    }
  }
}
```

--------------------------------

### GET /sequences/{sequence_id}

Source: https://docs.graph8.com/developers/sequences

Retrieve detailed configuration and status information for a specific sequence.

```APIDOC
## GET /sequences/{sequence_id}

### Description
Returns detailed information about a sequence, including configuration flags.

### Method
GET

### Endpoint
/sequences/{sequence_id}

### Parameters
#### Path Parameters
- **sequence_id** (string) - Required - The unique identifier of the sequence

### Response
#### Success Response (200)
- **data** (object) - Detailed sequence object

### Response Example
{
  "data": {
    "id": "seq-abc",
    "name": "Q2 Outbound",
    "status": "live",
    "finish_on_reply": true
  }
}
```

--------------------------------

### GET /enrichment/jobs/{job_id}

Source: https://docs.graph8.com/developers/enrichment

Polls the status of an existing enrichment job by its ID.

```APIDOC
## GET /enrichment/jobs/{job_id}

### Description
Check the status of an enrichment job.

### Method
GET

### Endpoint
/enrichment/jobs/{job_id}

### Parameters
#### Path Parameters
- **job_id** (string) - Required - The unique ID of the job

### Response
#### Success Response (200)
- **job_id** (string) - The job ID
- **status** (string) - Current status (queued, running, completed, failed)

#### Response Example
{
  "data": {
    "job_id": "abc-123-def",
    "status": "completed"
  }
}
```

--------------------------------

### Configure Local stdio MCP Server

Source: https://docs.graph8.com/developers/mcp

Configuration for running the graph8 MCP server locally using stdio. This requires Python 3.10+ and the uvx package runner, allowing users to specify the API key and operation mode via environment variables.

```json
{
  "mcpServers": {
    "graph8": {
      "command": "uvx",
      "args": ["g8-mcp-server"],
      "env": {
        "G8_API_KEY": "<your-api-key>",
        "G8_MCP_MODE": "dev"
      }
    }
  }
}
```

```json
{
  "mcpServers": {
    "graph8": {
      "command": "uvx",
      "args": ["g8-mcp-server"],
      "env": {
        "G8_API_KEY": "<your-api-key>",
        "G8_MCP_MODE": "gtm"
      }
    }
  }
}
```

--------------------------------

### Add G8 Studio Server Configuration to Claude Desktop

Source: https://docs.graph8.com/developers/claude-desktop-setup

This JSON configuration snippet is added to Claude Desktop's config file to establish a connection with the graph8 Studio MCP server. It specifies the command to run the MCP client and the arguments, including the server endpoint with a session ID.

```json
{
  "mcpServers": {
    "g8studio": {
      "command": "npx",
      "args": [
        "-y",
        "@anthropic-ai/mcp-client-sse",
        "https://mcp-production-c2f3.up.railway.app/mcp?session_id=YOUR_SESSION_ID"
      ]
    }
  }
}
```

--------------------------------

### GET /tasks

Source: https://docs.graph8.com/developers/tasks

Retrieves all tasks across the organization with support for various filtering options.

```APIDOC
## GET /tasks

### Description
Returns all tasks across the organization, with optional filters.

### Method
GET

### Endpoint
/tasks

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter by status.
- **priority** (integer) - Optional - Filter by priority (0=none, 1=urgent, 2=high, 3=normal, 4=low).
- **assignee_id** (string) - Optional - Filter by assignee.
- **search** (string) - Optional - Search in title and description.
```

--------------------------------

### Best Practices

Source: https://docs.graph8.com/developers/rate-limits

General recommendations for interacting with the API to stay within rate limits and improve efficiency.

```APIDOC
## Best Practices

*   **Use pagination with high limits** — fetch 200 items per page instead of making 200 individual requests.
*   **Add delays when paginating** — a small delay (100-200ms) between page requests helps stay within limits.
*   **Cache responses** — if you fetch the same data repeatedly, cache it locally to reduce API calls.
*   **Use backoff, not tight loops** — when rate-limited, always respect the `Retry-After` header instead of retrying immediately.
```

--------------------------------

### GET /companies/{company_id}

Source: https://docs.graph8.com/developers/companies

Retrieves detailed information about a specific company using its unique ID.

```APIDOC
## GET /companies/{company_id}

### Description
Retrieves detailed information about a specific company using its unique ID.

### Method
GET

### Endpoint
`/companies/{company_id}`

### Parameters
#### Path Parameters
- **company_id** (integer) - Required - The unique identifier for the company.

### Request Example
```curl
curl "https://be.graph8.com/api/v1/companies/42" \
  -H "Authorization: Bearer $API_KEY"
```

### Response
#### Success Response (200)
- **data** (object) - Contains the company details.
  - **id** (integer) - The company's unique identifier.
  - **name** (string) - The name of the company.
  - **description** (string) - A brief description of the company.
  - **domain** (string) - The primary domain of the company.
  - **website** (string) - The company's website URL.
  - **logo_url** (string) - URL for the company's logo.
  - **phone** (string) - The company's phone number.
  - **address** (string) - The company's street address.
  - **city** (string) - The city where the company is located.
  - **state** (string) - The state or province where the company is located.
  - **country** (string) - The country where the company is located.
  - **zip** (string) - The ZIP or postal code.
  - **founded_year** (integer) - The year the company was founded.
  - **employee_count** (string) - The number of employees.
  - **revenue** (string) - The company's revenue.
  - **industry** (string) - The industry the company operates in.
  - **industry_group** (string) - The industry group.
  - **linkedin_url** (string) - URL to the company's LinkedIn profile.
  - **linkedin_followers** (string) - Number of LinkedIn followers.
  - **facebook_url** (string) - URL to the company's Facebook profile (nullable).
  - **twitter_url** (string) - URL to the company's Twitter profile.
  - **crunchbase_url** (string) - URL to the company's Crunchbase profile (nullable).
  - **meta_data** (object) - Additional metadata (nullable).
  - **contact_count** (integer) - The number of contacts associated with the company.
  - **created_at** (string) - Timestamp of when the company record was created.
  - **updated_at** (string) - Timestamp of when the company record was last updated.

#### Response Example
```json
{
  "data": {
    "id": 42,
    "name": "Acme Inc",
    "description": "Enterprise software company",
    "domain": "acme.com",
    "website": "https://acme.com",
    "logo_url": "https://logo.clearbit.com/acme.com",
    "phone": "+1-555-0200",
    "address": "123 Market St",
    "city": "San Francisco",
    "state": "CA",
    "country": "US",
    "zip": "94105",
    "founded_year": 2015,
    "employee_count": "500",
    "revenue": "25000000",
    "industry": "Technology",
    "industry_group": "Software",
    "linkedin_url": "https://linkedin.com/company/acme",
    "linkedin_followers": "12500",
    "facebook_url": null,
    "twitter_url": "https://twitter.com/acme",
    "crunchbase_url": null,
    "meta_data": null,
    "contact_count": 15,
    "created_at": "2026-01-10T08:00:00Z",
    "updated_at": "2026-02-20T16:45:00Z"
  }
}
```

### Errors
Status| Meaning  
---|---
`404`| Company not found
```

--------------------------------

### Authenticate with g8 CLI using OAuth

Source: https://docs.graph8.com/developers/cli

Initiates the OAuth authentication flow for the g8 CLI, opening a browser for sign-in. Upon successful authentication, a token is saved to `~/.g8/credentials.json` for automatic use in future commands. This method does not require an API key.

```bash
g8 login
```

--------------------------------

### GET /webhooks/events

Source: https://docs.graph8.com/developers/webhooks

Retrieves a list of all available event types that can be subscribed to via webhooks.

```APIDOC
## GET /webhooks/events

### Description
Returns all event types you can subscribe to.

### Method
GET

### Endpoint
/webhooks/events

### Response
#### Success Response (200)
- **data** (array) - List of available event objects

#### Response Example
{
  "data": [
    { "event": "campaign.created" },
    { "event": "campaign.updated" }
  ]
}
```

--------------------------------

### GET /companies/{company_id}/deals

Source: https://docs.graph8.com/developers/deals

Retrieves a list of all deals associated with a specified company ID.

```APIDOC
## GET /companies/{company_id}/deals

### Description
Returns all deals associated with a specific company. The response structure is identical to the contact deals endpoint.

### Method
GET

### Endpoint
/companies/{company_id}/deals

### Parameters
#### Path Parameters
- **company_id** (string) - Required - The unique identifier of the company.

### Request Example
GET /companies/12345/deals

### Response
#### Success Response (200)
- **deals** (array) - A list of deal objects associated with the company.

#### Response Example
{
  "deals": [
    {
      "id": "deal_987",
      "amount": 5000,
      "status": "open"
    }
  ]
}
```

--------------------------------

### GET /webhooks/{webhook_id}/deliveries

Source: https://docs.graph8.com/developers/webhooks

Retrieves a paginated list of delivery attempts for a specific webhook.

```APIDOC
## GET /webhooks/{webhook_id}/deliveries

### Description
Returns delivery attempts for a webhook, with pagination.

### Method
GET

### Endpoint
/webhooks/{webhook_id}/deliveries

### Parameters
#### Path Parameters
- **webhook_id** (string) - Required - The ID of the webhook

#### Query Parameters
- **page** (integer) - Optional - Page number
- **limit** (integer) - Optional - Items per page
- **status** (string) - Optional - Filter by status (success, failed, pending)

### Response
#### Success Response (200)
- **data** (array) - List of delivery attempts
- **pagination** (object) - Pagination metadata
```

--------------------------------

### Iterating Through Pages with Python

Source: https://docs.graph8.com/developers/pagination

This Python script illustrates how to programmatically fetch all data across multiple pages. It uses a `while` loop that continues as long as `has_next` is true, accumulating data from each page and incrementing the page number.

```APIDOC
## Iterating Through Pages (Python)

```python
import requests


API_KEY = "your_api_key_here"
BASE_URL = "https://be.graph8.com/api/v1"
HEADERS = {"Authorization": f"Bearer {API_KEY}"}


all_contacts = []
page = 1


while True:
    response = requests.get(
        f"{BASE_URL}/contacts",
        headers=HEADERS,
        params={"page": page, "limit": 200}
    )
    data = response.json()


    all_contacts.extend(data["data"])


    if not data["pagination"]["has_next"]:
        break
    page += 1


print(f"Fetched {len(all_contacts)} contacts")
```
```

--------------------------------

### GET /lists

Source: https://docs.graph8.com/developers

Retrieves a list of all lists within your Graph8 workspace. This operation is free and does not consume credits.

```APIDOC
## GET /lists

### Description
Retrieves a list of all the contact lists you have created or saved within your Graph8 workspace.

### Method
GET

### Endpoint
/lists

### Parameters
#### Path Parameters
None

#### Query Parameters
None

### Request Example
```bash
curl -X GET "https://be.graph8.com/api/v1/lists"
```

### Response
#### Success Response (200)
- **lists** (array) - An array of list objects, each containing details about a list in your workspace.

#### Response Example
```json
{
  "lists": [
    {
      "id": "list_abc123",
      "title": "Tech CTOs",
      "contact_count": 5
    }
  ]
}
```
```

--------------------------------

### GET /companies

Source: https://docs.graph8.com/developers

Retrieves a list of all companies that are saved in your Graph8 workspace. This operation is free and does not consume credits.

```APIDOC
## GET /companies

### Description
Retrieves a paginated list of all companies that you own within your Graph8 workspace. This includes companies imported or created manually.

### Method
GET

### Endpoint
/companies

### Parameters
#### Path Parameters
None

#### Query Parameters
- **limit** (integer) - Optional - The maximum number of companies to return per page.
- **offset** (integer) - Optional - The number of companies to skip before returning results (for pagination).

### Request Example
```bash
curl -X GET "https://be.graph8.com/api/v1/companies?limit=20&offset=0"
```

### Response
#### Success Response (200)
- **companies** (array) - An array of company objects stored in your workspace.

#### Response Example
```json
{
  "companies": [
    {
      "id": "company_id_1",
      "name": "Example Corp",
      "industry": "Technology",
      "website": "https://example.com"
    }
  ]
}
```
```
Tokens:
Raw