Developer documentation · v1 pilot

Find reps. Find opportunities. Start a conversation.

Connect your assistant to the ZillaSales marketplace. Find relevant reps for your business, or discover commission-based opportunities as a rep. Save your choices to your ZillaSales Favorites.

Connect an assistant

An example workflow

“Find reps with commercial lighting experience in Texas and save the candidates I choose.”
  1. Search

    See relevant product and buyer experience.

  2. Review

    Check why each candidate may fit.

  3. Shortlist

    Save selected reps to ZillaSales Favorites.

Illustrative workflow. A profile match does not confirm a rep’s interest or availability.

Get connected

One key. Two ways to connect.

Sign in with your company or rep account and open Settings → Integrations. Create a named connection and copy its key. Enable Favorites saving only if you want the assistant to save reps or opportunities. Keep the key private; it is shown once and expires after 90 days.

Add a custom remote MCP server

In a compatible assistant, choose a remote server with Streamable HTTP transport. Enter this URL and configure your key as bearer authentication:

https://zillasales.com/api/mcp

Authorization: Bearer YOUR_ZILLASALES_KEY

Then try: “Find reps for commercial lighting sold to electrical wholesalers in Texas.” If prompted to save a candidate, review the choice before confirming. As a rep, try: “Find commission-based lighting opportunities in Texas.”

The pilot uses API keys. OAuth and automatic account linking are not included. Client support for custom headers varies; if your assistant only accepts OAuth, use a compatible API integration or contact us. Muse directory approval is a separate process.

Tools & endpoints

Both interfaces use the same permissions and limits. API requests use POST and a JSON body, including an empty object for tools with no inputs.

API base: https://zillasales.com/api/connectors/v1
MCP endpoint: https://zillasales.com/api/mcp

search_opportunities

POST /opportunities/search

For reps: find up to 10 approved, published commission-based opportunities by product keywords, territory and industry. Empty query browses recent listings. Includes listed commission terms and website links.

{ "query": "lighting", "territories": ["Texas"], "industries": [] }

get_opportunity

POST /opportunities/detail

Read an available opportunity and its commission terms. Company identities, private contacts and moderation records are not included. Review and apply on the website.

{ "opportunityId": "<id from search>" }

save_opportunity

POST /opportunities/favorite

Save an opportunity to your rep account’s Favorites. Requires your own rep key with save permission. Repeating a save is safe; it does not submit an application.

{ "opportunityId": "<id from search>" }

search_reps

POST /search

Search by product, target buyers and optional territories. Returns bounded candidate previews with match explanations.

{ "query": "commercial lighting for electrical wholesalers", "territories": ["Texas"] }

get_rep_preview

POST /preview

Revisit a candidate returned by your connection. References expire after 24 hours and cannot be shared between keys.

{ "candidateRef": "<reference from search>" }

save_to_shortlist

POST /shortlist

Save a candidate to your company’s Favorites. Requires shortlist permission. Repeated saves do not create duplicates.

{ "candidateRef": "<reference from search>" }

get_account_access

POST /account

Read your current plan, credit balance, permissions and daily search usage. Rep keys show rep permissions and allowances. Partner keys cannot access personal accounts.

{}

get_recruiting_options

POST /options

Get marketplace and managed recruiting information, with website links for current pricing and next steps.

{}

The connector does not expose private contact records, unlock contacts, publish opportunities, submit applications, send messages or make purchases. Use the returned website links to take those next steps.

Your existing plan applies

There is no separate connector fee in this pilot. Searches and saving Favorites do not consume contact credits. On the website, contact access follows your existing plan and unlock history. See current pricing for available subscriptions.

Daily pilot allowances
AllowancePreview / free accountActive paid plan
Searches per day10100
Profiles per searchUp to 3Up to 6
Opportunities per searchUp to 10Up to 10
Save requests per day20 (personal keys only)100
Total requests per day1001,000

Daily limits reset at midnight UTC and are shared across your account’s keys. Rep accounts use the free allowance. Rep and opportunity searches share the daily search allowance. Each key also has a 30-request-per-minute limit. Creating another key does not reset your daily allowance. These are pilot limits. Approved shared partner keys have a separate allowance: 300 requests per minute, 10,000 requests and 1,000 searches per day. Valid keys are limited by key and account, not by the shared IP address of an assistant provider.

Working with results

search_reps returns a profiles array with candidateRef, experience, coverage, product and buyer evidence, whyFit and an interest status of not_confirmed. References are scoped to the key that created them and expire after 24 hours. A candidate can become unavailable sooner if their profile leaves the marketplace.

An empty profiles array is a valid result. Refine the product, buyer or territory requirements rather than inventing candidates. Returned links include referral attribution so we can evaluate this pilot.

search_opportunities returns an opportunities array and hasMore. Refine filters or follow browseUrl for more listings. Territory filters accept codes or full names; industry filters accept IDs or full labels. Commission amounts are company-supplied, and a null currency means it has not been specified. These are independent sales opportunities, not salaried job offers or guaranteed earnings. Review contract terms and apply on the website.

// Illustrative error response
{
  "error": {
    "code": "CANDIDATE_UNAVAILABLE",
    "message": "This preview has expired or belongs to a different connector. Search again."
  }
}
  • 400: Correct the input. Rep queries are 3–300 characters; opportunity queries are 0–200. Provide at most 10 territories or industries.
  • 401: Check your key, its expiry and revocation status.
  • 403: Connect a personal key for the appropriate account type or enable save permission. Browser requests must use an allowed origin.
  • 404: Search again for a fresh candidate reference or a currently available opportunity.
  • 429: Respect Retry-After on HTTP responses. DAILY_LIMIT resets at midnight UTC. MCP tool errors also include retryAfterSeconds in their JSON error text.
  • 503: The service is temporarily unavailable. Retry later with backoff.

MCP tool failures return isError with a JSON error message in text content. Transport failures use HTTP status codes. The server is stateless: POST handles JSON-RPC; GET and DELETE return 405. It does not provide a persistent SSE stream or accept batches.

Data & permissions

Company keys can read rep previews and your plan and credit balance. Rep keys can search opportunities and optionally save them to rep Favorites. Saving is an additional permission you choose when creating a key. Revoke a key in Settings to disconnect it; existing Favorites remain in your account.

We store a hash of the key, connection metadata, temporary search previews and daily usage totals. Search references expire after 24 hours; expired previews are removed by scheduled cleanup. Do not include customer lists, private contact details or confidential business information in search queries. Your assistant provider also processes the data you choose to share with it.

Building a partner integration?

For a directory demonstration or acquisition pilot, request a dedicated partner key. It can search reps and opportunities and show previews, but has no access to personal accounts or saved Favorites. Approved shared integrations receive the partner allowance above. Customers connect their own keys for account features.

Muse supports a connector submission process; listing and client compatibility need to be verified with the platform. This documentation does not imply directory approval or a partnership.

Request pilot access