Sprootal Public API

Contact management operations

LinkedIn message operations

Automation sequence operations

Webhook endpoint management

Project management (read-only)

Contact list management

Deal pipeline management

Task inbox, creation, and lifecycle actions (claim / snooze / complete / reassign / execute / review).

AI reply drafts a human reviews before anything reaches a real person.

Every machine-initiated action shares one rail. A sender drains it one action at a time, at least two minutes apart, inside its working hours and within its own API-queue budget — so a message and a connection request never leave the same LinkedIn account at the same moment.

Nothing here sends inside the request. Each endpoint answers 202 with a queue position and an estimated send time. What actually happened is in GET /queue: the resolution field says sent, or names the reason the queue declined to spend the action.

What you can queue

• Send a message — POST /contacts/{id}/messages · scope messages:write. Opens the conversation when there is none yet.
• Send a draft a human approved — POST /drafts/{draftId}/approve · scope messages:write.
• Send a connection request — POST /connection-requests · scope connections:write. An optional note, ≤300 characters.
• Visit a profile — POST /profile-visits · scope engagements:write. Shows up in their “who viewed your profile”. A repeat visit the same day costs nothing.
• Like a post — POST /post-likes · scope engagements:write. You name the post; this never picks one for you.

Address a contact by its contact_id. A connection request also accepts a linkedin_url instead, and creates the contact when the URL is new to the workspace.

curl -X POST https://sprootal.com/api/v1/connection-requests \
  -H "Authorization: Bearer $SPROOTAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sender_id":"<uuid>","linkedin_url":"https://www.linkedin.com/in/ada-lovelace","note":"Saw your GTM post."}'

Execution conditions

An action can carry the condition under which it should still happen when its turn comes — which may be minutes or days after you asked for it. Omit them and the action simply runs.

• skip_if_replied on a message — stand down if the contact writes back after the message was queued. The item settles cancelled with resolution: already_replied.
• withdraw_after_hours on a connection request — withdraw the invitation if it is still unaccepted this many hours later (1–720). Leave it out and the invitation stands.
• skip_note_if_limit_reached on a connection request — LinkedIn meters note-bearing invitations under a smaller weekly quota; when it is exhausted, retry the same invitation without the note rather than failing.

A withdrawal is not a timer hidden inside the invitation: it joins the queue as its own action, scheduled forward, so it is paced, budgeted and visible exactly like everything else — and you can cancel it.

curl -X POST https://sprootal.com/api/v1/contacts/$CONTACT_ID/messages \
  -H "Authorization: Bearer $SPROOTAL_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"sender_id":"<uuid>","text":"Following up on my note.","skip_if_replied":true}'

Reading the rail

GET /queue sees every action type and filters by status, action_type, sender_id and contact_id. GET /messages/queue is the message-only view kept for integrations that predate the others.

There is deliberately no send-failure webhook: the queue is the failure surface, so poll status=failed here. resolution also separates a real failure from a deliberate stand-down — already_connected, already_invited and already_replied mean the queue refused to spend an action it no longer believed in.

Budgets and pacing

Each sender account carries a daily API-queue budget per action type, kept separate from what campaigns may spend on the same account. An exhausted budget does not fail the action, it holds it until the account daily reset. Working hours, the two-minute gap between actions and the invite brake apply to everything on the rail.

Sprootal CRM speaks the Model Context Protocol over Streamable HTTP, so an AI client such as Claude, Claude Code or Cursor can work inside your Sprootal workspace directly. It exposes the same data as the REST API above, governed by the same API-key scopes.

Endpoint POST https://sprootal.com/api/mcp · Server version 1.0.0 · 91 tools across 15 groups

Connecting

Claude, Cursor and other OAuth clients

Add https://sprootal.com/api/mcp as a custom connector. The server implements OAuth 2.1 with dynamic client registration and PKCE, so there is nothing to pre-provision: the client discovers its endpoints from https://sprootal.com/.well-known/oauth-protected-resource and takes you through a consent screen where you choose which scope groups to grant.

Headless clients (API key)

Clients that cannot run an OAuth flow send a Sprootal API key as a bearer token instead. Create one under Settings → API keys; lg_test_* keys behave identically to lg_live_*.

{
  "mcpServers": {
    "sprootal": {
      "type": "http",
      "url": "https://sprootal.com/api/mcp",
      "headers": {
        "Authorization": "Bearer lg_live_your_key_here"
      }
    }
  }
}

Raw JSON-RPC

Every call is JSON-RPC 2.0. Open a session with initialize, then send the returned Mcp-Session-Id header back on each subsequent request.

curl -X POST https://sprootal.com/api/mcp \
  -H 'Authorization: Bearer lg_live_your_key_here' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

Sessions, transport and limits

• POST https://sprootal.com/api/mcp carries JSON-RPC requests, GET opens the server-to-client SSE stream, DELETE terminates a session.
• The Mcp-Session-Id response header identifies the session. A session expires after 30 minutes idle or 4 hours total, whichever comes first.
• Up to 5 concurrent sessions per API key; request bodies are capped at 256 KB.
• Rate limits are shared with the REST API and reported on every response through X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. A 401 carries a WWW-Authenticate header pointing at the resource metadata document.
• Revoking or deleting an API key immediately closes every session opened with it.

Scopes

A tool call returns permission_denied when the key or token lacks the scope it needs. OAuth consent is granted in groups:

Resources and prompts

Besides tools the server exposes two read-only resources — crm://team/summary (contact, campaign and project counts) and crm://schema/projects (projects with their pipeline stages and tags) — plus the prompts contact_summary, campaign_report and enrich_contact.

Tools

Contacts

Create, search, update and delete contacts, and manage their list memberships.

Scopes: contacts:read, contacts:write, lists:read, lists:write

create_contact

Create a contact, or update the one that already matches. Identity is the LinkedIn slug or URN. Calling it twice with the same person updates rather than duplicating, and restores the contact if it had been deleted. A projectId or a listId is required; for a LinkedIn connection request, pass the LinkedIn URL or the ACo… attendeeProviderId.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_contact",
    "arguments": {
      "firstName": "<string>",
      "lastName": "<string>"
    }
  }
}

delete_contact

Remove a contact. A soft delete: the contact stops appearing in every read, and support can restore it.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_contact",
    "arguments": {
      "id": "<string>"
    }
  }
}

get_contact

Get one contact, with its profile, engagement and conversations

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_contact",
    "arguments": {
      "id": "<string>"
    }
  }
}

search_contacts

List contacts. Scoped to a project with project_id, which applies that project visibility rules. q matches name, LinkedIn slug and provider id.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_contacts",
    "arguments": {}
  }
}

update_contact

Change a contact details

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_contact",
    "arguments": {
      "id": "<string>"
    }
  }
}

Messages

Read LinkedIn conversations and message history, inspect messaging stats, and queue a message or a connection request to a contact.

Scopes: messages:read, messages:write, connections:write, engagements:write

cancel_message_queue_item

Cancel a queued message before it sends

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cancel_message_queue_item",
    "arguments": {
      "itemId": "<string>"
    }
  }
}

get_message

Get one message

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_message",
    "arguments": {
      "id": "<string>"
    }
  }
}

like_post

Queue a LIKE on one specific LinkedIn post. It joins the same paced API queue as messages and invitations, so it is not performed instantly. Name the post you mean — this never picks a post for you.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "like_post",
    "arguments": {
      "contact_id": "<uuid>",
      "sender_id": "<uuid>",
      "post_url": "<string>"
    }
  }
}

search_message_queue

List queued outbound actions. Covers every queued action type, not just messages. Filter with {"action_type":{"eq":"send_connection"}}.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_message_queue",
    "arguments": {}
  }
}

search_messages

List messages across the team. Narrow with contact_id, sender_profile_id or type. Newest first, cursor-paged.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_messages",
    "arguments": {}
  }
}

send_connection_request

Queue a LinkedIn connection request to a contact. It joins the same paced API queue as messages, so it is not sent instantly — the response carries the queue position and an estimated send time. Connection requests are the scarcest LinkedIn quota there is; the queue refuses a duplicate to someone already invited or already connected rather than burning one. Requires an API key created by a workspace owner or admin.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "send_connection_request",
    "arguments": {
      "contact_id": "<uuid>",
      "sender_id": "<uuid>"
    }
  }
}

send_message

Queue a LinkedIn message to a contact. The message enters the API queue and is paced against every other machine send on that sender, so it is not delivered instantly — the response carries the queue position and an estimated send time. Requires an API key created by a workspace owner or admin; otherwise use create_draft and have a human approve it.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "send_message",
    "arguments": {
      "contact_id": "<uuid>",
      "sender_id": "<uuid>",
      "text": "<string>"
    }
  }
}

update_message_queue_item

Edit a queued message, or move it in the queue. Only works while the message is still waiting. Once it is sending or sent the call is a conflict.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_message_queue_item",
    "arguments": {
      "itemId": "<string>"
    }
  }
}

visit_profile

Queue a LinkedIn profile visit, which shows up in the recipient’s “who viewed your profile” list. It joins the same paced API queue as messages and invitations, so it is not performed instantly. A repeat visit to the same contact on the same day does not spend a second visit from the daily quota.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "visit_profile",
    "arguments": {
      "contact_id": "<uuid>",
      "sender_id": "<uuid>"
    }
  }
}

withdraw_connection_request

Queue the withdrawal of a connection request this sender already sent to a contact and that is still unaccepted. It joins the same paced API queue as invitations, so it is not performed instantly; if the invitation turns out to be accepted or already gone by then, the queue item reports that instead of withdrawing anything. An invitation still waiting in the queue is not out yet: cancel it with cancel_message_queue_item instead. Requires an API key created by a workspace owner or admin.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "withdraw_connection_request",
    "arguments": {
      "contact_id": "<uuid>",
      "sender_id": "<uuid>"
    }
  }
}

Drafts

Create, list and discard AI reply drafts for a conversation.

Scopes: messages:read, messages:write

create_draft

Write a reply draft into a conversation for a human to review in the Inbox. This does NOT send anything — a person approves it. Use search_contacts to find the contact and search_senders to pick the sender.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_draft",
    "arguments": {
      "contact_id": "<uuid>",
      "sender_id": "<uuid>",
      "text": "<string>"
    }
  }
}

discard_draft

Withdraw a draft you created so it stops competing for the reviewer attention. Fails if a human already sent or discarded it.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "discard_draft",
    "arguments": {
      "draft_id": "<uuid>"
    }
  }
}

list_drafts

List reply drafts in a conversation, including ones a human already sent or discarded

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_drafts",
    "arguments": {
      "contact_id": "<uuid>",
      "sender_id": "<uuid>"
    }
  }
}

Campaigns

Manage outreach campaigns: create, enrol and unenrol contacts, change status, read stats.

Scopes: automations:read, automations:write

create_campaign

Create a new outreach campaign from either a free-text brief (prompt) or an explicit step chain (blocks) — exactly one of the two, never both. prompt runs the same campaign builder as the app and writes the copy from the project context. blocks is a plain linear list of the steps you want, and the same safety steps the builder uses are added around it: a connection check first, so contacts who are already connected skip the invite; after an invite, a wait for acceptance and a withdrawal if it is not accepted; after a message, a wait for a reply. The response lists what was added in addedSteps. Describe the audience and goal in description. The campaign is always created as a DRAFT and sends nothing: a person must activate it, and senders are chosen in the app, so do not tell the user the campaign has been launched.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_campaign",
    "arguments": {
      "name": "<string>",
      "description": "<string>",
      "project_id": "<uuid>"
    }
  }
}

delete_campaign

Delete a DRAFT campaign. The deletion is soft: the campaign disappears from lists and can be restored from the app. A campaign that has been activated cannot be deleted here, because contacts are moving through it; pause it with update_campaign_status instead.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_campaign",
    "arguments": {
      "campaign_id": "<uuid>"
    }
  }
}

enroll_contacts

Enroll up to 100 contacts into a campaign. In an active campaign its steps start reaching them, so confirm with the user first. Contacts already enrolled are skipped; the result counts enrolled, alreadyEnrolled and notFound.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "enroll_contacts",
    "arguments": {
      "campaign_id": "<uuid>",
      "contact_ids": [
        "<uuid>"
      ]
    }
  }
}

get_campaign

Get campaign details including stats, enrolled contacts summary, and the campaign structure: a linear block chain when it has one, otherwise every step with the step each outcome leads to

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_campaign",
    "arguments": {
      "campaign_id": "<uuid>"
    }
  }
}

list_campaigns

List campaigns with optional status and project filters

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_campaigns",
    "arguments": {}
  }
}

unenroll_contacts

Remove contacts from a campaign sequence

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "unenroll_contacts",
    "arguments": {
      "campaign_id": "<uuid>",
      "contact_ids": [
        "<uuid>"
      ]
    }
  }
}

update_campaign

Edit a DRAFT campaign: rename it, change its description, or replace its steps with new blocks or a new prompt (one of the two, never both). Replacing the steps rebuilds the whole flow the same way create_campaign does. A campaign that has been activated cannot be edited here, because contacts are already moving through its steps; edit it in the app.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_campaign",
    "arguments": {
      "campaign_id": "<uuid>"
    }
  }
}

update_campaign_status

Activate or pause a campaign. Activating starts real LinkedIn sends to every enrolled contact, so do it only on the user explicit instruction. Pausing stops new sends; a completed campaign cannot change status.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_campaign_status",
    "arguments": {
      "campaign_id": "<uuid>",
      "status": "active"
    }
  }
}

Projects

Read projects and their pipeline stages, and list or create project custom fields.

Scopes: projects:read, projects:write

add_contacts_to_list

Add contacts to a list

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_contacts_to_list",
    "arguments": {
      "list_id": "<uuid>",
      "contact_ids": [
        "<uuid>"
      ]
    }
  }
}

create_custom_field

Create a custom field in a project. fieldKey defaults to fieldName in snake_case and must be unique in the project. select and multi_select need options.choices; currency needs currencyCode. Without order the field is appended last.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_custom_field",
    "arguments": {
      "id": "<uuid>",
      "fieldName": "<string>",
      "fieldType": "text"
    }
  }
}

create_list

Create a new contact list

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_list",
    "arguments": {
      "name": "<string>"
    }
  }
}

list_lists

List contact lists, optionally filtered by project

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_lists",
    "arguments": {}
  }
}

list_projects

List all projects

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_projects",
    "arguments": {}
  }
}

remove_contacts_from_list

Remove contacts from a list

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "remove_contacts_from_list",
    "arguments": {
      "list_id": "<uuid>",
      "contact_ids": [
        "<uuid>"
      ]
    }
  }
}

search_custom_fields

List the active custom fields of a project. Search by name with filter {"field_name":{"contains":"..."}} (case-insensitive). fieldKey is the key to use in a contact customFields object for this project.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_custom_fields",
    "arguments": {
      "id": "<uuid>"
    }
  }
}

Sender Profiles

Read connected LinkedIn sender accounts and their limits.

Scopes: sender_profiles:read

check_connections

Check which team senders have each LinkedIn person as a 1st-degree connection. Takes up to 200 LinkedIn profile URLs, slugs or member URNs and returns, in the same order, whether any sender of the team is connected with that person and which senders. It reads the synced connection lists only: it never visits a profile and uses no sender limits. A new connection shows up after the sender connection sync, usually within minutes and at most six hours.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "check_connections",
    "arguments": {
      "identifiers": [
        "<string>"
      ]
    }
  }
}

get_sender

Get one sender, with its full limits, sync state and mailbox counts

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_sender",
    "arguments": {
      "id": "<string>"
    }
  }
}

get_sender_cooldown

Check whether a sender is cooling down. Ask before executing: a sender inside its cooldown refuses the send, and this says how long to wait.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_sender_cooldown",
    "arguments": {
      "id": "<string>"
    }
  }
}

get_sender_daily_limit

Check a sender daily allowance for one action type

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_sender_daily_limit",
    "arguments": {
      "id": "<string>",
      "actionType": "send_connection"
    }
  }
}

search_senders

List connected LinkedIn sender accounts. Filter with {"status":{"eq":"connected"}} to find the senders that can actually send right now, or {"name":{"contains":"anna"}} to resolve a sender the user named.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_senders",
    "arguments": {}
  }
}

Webhooks

Manage webhook endpoints and inspect delivery attempts for your team.

Scopes: webhooks:manage

act_on_webhook

Rotate an endpoint signing secret, or re-enable it. Rotation keeps the previous secret valid for a grace window so deliveries in flight still verify. Re-enabling also clears the failure counter.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "act_on_webhook",
    "arguments": {
      "id": "<string>",
      "action": "rotate_secret"
    }
  }
}

create_webhook

Register a webhook endpoint. The signing secret is returned once, here. Store it: it is never shown again, and the only way to get a new one is to rotate.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_webhook",
    "arguments": {
      "name": "<string>",
      "url": "<uri>",
      "events": [
        "lead.created"
      ]
    }
  }
}

delete_webhook

Permanently delete an endpoint and its delivery history. Irreversible, and the signing secret goes with it. To stop deliveries without losing the endpoint, set enabled=false instead. Destructive: call without confirm first to preview.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_webhook",
    "arguments": {
      "id": "<string>"
    }
  }
}

get_webhook

Get one webhook endpoint, with its delivery health

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_webhook",
    "arguments": {
      "id": "<string>"
    }
  }
}

get_webhook_delivery

Get one delivery attempt, with its payload and response

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_webhook_delivery",
    "arguments": {
      "id": "<string>",
      "deliveryId": "<string>"
    }
  }
}

replay_webhook_delivery

Send a past delivery again, to the endpoint it was for

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "replay_webhook_delivery",
    "arguments": {
      "id": "<string>",
      "deliveryId": "<string>"
    }
  }
}

search_webhook_deliveries

List an endpoint delivery attempts. The first thing to look at when a webhook stops arriving. The filter {"success":{"eq":false}} shows only the failures, and page_size=0 counts them without fetching any.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_webhook_deliveries",
    "arguments": {
      "id": "<string>"
    }
  }
}

search_webhooks

List webhook endpoints

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_webhooks",
    "arguments": {}
  }
}

update_webhook

Change an endpoint name, URL, events or enabled state

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_webhook",
    "arguments": {
      "id": "<string>"
    }
  }
}

Tags

Create project tags and attach or detach them from contacts.

Scopes: tags:read, tags:write

add_tag_to_contact

Add a tag to a contact in a project

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_tag_to_contact",
    "arguments": {
      "project_id": "<uuid>",
      "contact_id": "<uuid>",
      "tag_id": "<uuid>"
    }
  }
}

create_tag

Create a new tag in a project

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_tag",
    "arguments": {
      "project_id": "<uuid>",
      "name": "<string>"
    }
  }
}

list_tags

List tags for a project

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_tags",
    "arguments": {
      "project_id": "<uuid>"
    }
  }
}

remove_tag_from_contact

Remove a tag from a contact in a project

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "remove_tag_from_contact",
    "arguments": {
      "project_id": "<uuid>",
      "contact_id": "<uuid>",
      "tag_id": "<uuid>"
    }
  }
}

Companies

Read, create and update company records.

Scopes: companies:read, companies:write

create_company

Create a company, or return the existing match. Resolves against domain, LinkedIn id and name before inserting, so calling it twice with the same company yields one record rather than a duplicate.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_company",
    "arguments": {
      "name": "<string>"
    }
  }
}

get_company

Get one company, with the contacts linked to it. The contacts expansion carries each person role and dates at the company, so a caller does not have to fetch and join them itself.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_company",
    "arguments": {
      "id": "<uuid>"
    }
  }
}

search_companies

List companies

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_companies",
    "arguments": {}
  }
}

update_company

Change a company details. Renaming a company also updates the company shown on every contact linked to it.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_company",
    "arguments": {
      "id": "<uuid>"
    }
  }
}

Deals

Read the deal pipeline, create deals and move them between stages.

Scopes: deals:read, deals:write

create_deal

Create a new deal for a contact in a project pipeline stage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_deal",
    "arguments": {
      "project_id": "<string>",
      "contact_id": "<string>",
      "stage_id": "<string>"
    }
  }
}

deal_pipeline_summary

Get pipeline KPIs for your team: open/won/lost counts and value, win rate, and value by stage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "deal_pipeline_summary",
    "arguments": {}
  }
}

get_deal

Get a single deal by ID from your team

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_deal",
    "arguments": {
      "deal_id": "<string>"
    }
  }
}

list_deals

List deals for your team, optionally filtered by project or status

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_deals",
    "arguments": {}
  }
}

list_pipeline_stages

List the deal pipeline stages of a project, ordered by position

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_pipeline_stages",
    "arguments": {
      "project_id": "<string>"
    }
  }
}

move_deal_stage

Move a deal to a different pipeline stage (stamps won/lost when the target stage is an outcome stage)

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "move_deal_stage",
    "arguments": {
      "deal_id": "<string>",
      "stage_id": "<string>"
    }
  }
}

Tasks

Work the task inbox: search, claim, complete, snooze and reassign tasks, run the rules that create them, and execute or review the messages they propose.

Scopes: tasks:read, tasks:write, messages:write

approve_review_task

Approve the message a campaign review step drafted, so the campaign sends it. Only for tasks of type review: find them with search_tasks and the filter {"type":{"eq":"review"}}. The message goes to a real person, so confirm the text with the user first; editedMessage replaces it.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "approve_review_task",
    "arguments": {
      "id": "<string>"
    }
  }
}

cancel_task

Cancel a task

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "cancel_task",
    "arguments": {
      "id": "<string>"
    }
  }
}

claim_task

Claim a task for yourself. An API key claims on behalf of the user who created it. Claiming an already-claimed task is a conflict, not a silent reassignment.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "claim_task",
    "arguments": {
      "id": "<string>"
    }
  }
}

complete_task

Complete a task. Marks it done without performing anything. To perform a LinkedIn task, use execute_task; to decide a review task, use approve_review_task or reject_review_task.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "complete_task",
    "arguments": {
      "id": "<string>"
    }
  }
}

create_task

Create a task

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_task",
    "arguments": {
      "contactId": "<uuid>",
      "title": "<string>",
      "type": "linkedin_message"
    }
  }
}

create_task_rule

Create a task rule

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_task_rule",
    "arguments": {
      "name": "<string>",
      "triggerSource": "manual",
      "taskTemplate": {}
    }
  }
}

delete_task_rule

Delete a task rule Destructive: call without confirm first to preview.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_task_rule",
    "arguments": {
      "id": "<string>"
    }
  }
}

dry_run_task_rule

See what a rule would have matched, without creating anything. Replays the rule against the last 30 days of signal events and reports how many would have matched, with a sample. Creates nothing. Limited to once every 10 seconds per rule.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "dry_run_task_rule",
    "arguments": {
      "id": "<string>"
    }
  }
}

execute_task

Execute a task, performing its LinkedIn action. Sends the message, connection request or engagement the task describes. Subject to the sender cooldown and daily limits.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "execute_task",
    "arguments": {
      "id": "<string>",
      "senderId": "<uuid>"
    }
  }
}

get_task

Get a task

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_task",
    "arguments": {
      "id": "<string>"
    }
  }
}

get_task_rule

Get a task rule

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_task_rule",
    "arguments": {
      "id": "<string>"
    }
  }
}

reassign_task

Reassign a task to another team member

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "reassign_task",
    "arguments": {
      "id": "<string>",
      "assigneeId": "<string>"
    }
  }
}

reject_review_task

Reject the message a campaign review step drafted, so it is never sent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "reject_review_task",
    "arguments": {
      "id": "<string>",
      "reason": "<string>"
    }
  }
}

search_task_rules

List task rules

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_task_rules",
    "arguments": {}
  }
}

search_tasks

List tasks. Tasks of type review hold a message a campaign drafted and is waiting to send; approve_review_task or reject_review_task decides them.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_tasks",
    "arguments": {}
  }
}

snooze_task

Snooze a task until a given time

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "snooze_task",
    "arguments": {
      "until": "<iso-8601>",
      "id": "<string>"
    }
  }
}

update_task

Update a task

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_task",
    "arguments": {
      "id": "<string>"
    }
  }
}

update_task_rule

Update a task rule

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_task_rule",
    "arguments": {
      "id": "<string>"
    }
  }
}

Analytics

Aggregate contact, message and pipeline statistics.

Scopes: analytics:read

get_campaign_stats

Get campaign performance metrics for a specific campaign or all campaigns

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_campaign_stats",
    "arguments": {}
  }
}

get_contact_stats

Get contact counts grouped by pipeline stage, tags, or overall totals for a project

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_contact_stats",
    "arguments": {
      "project_id": "<uuid>"
    }
  }
}

get_message_stats

Get message volume statistics for the team over a time period

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_message_stats",
    "arguments": {}
  }
}

Bulk Operations

Run a change across many records as one tracked job: preview what it would touch, commit it, then watch or stop it.

Scopes: automations:write

act_on_bulk_operation

Commit, pause, resume, cancel or retry a bulk run. Cancelling stops the run; it does not reverse work already done, because a sent message does not unsend. retry_failed requeues only the items that failed.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "act_on_bulk_operation",
    "arguments": {
      "id": "<uuid>",
      "action": "commit"
    }
  }
}

get_bulk_operation

Get a bulk run

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_bulk_operation",
    "arguments": {
      "id": "<uuid>"
    }
  }
}

preview_bulk_operation

Resolve what a bulk run would do, without doing it. Resolves the exact set of affected records and writes it down, so the number you approve is the number that runs. Nothing happens until the run is committed.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "preview_bulk_operation",
    "arguments": {
      "operation": "<string>"
    }
  }
}

search_bulk_items

List the items of a bulk run. Which records went through and which did not, with the machine-readable reason for each. The filter {"status":{"eq":"failed"}} answers the question you actually have after a partial run; page_size=0 answers how many without fetching them.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_bulk_items",
    "arguments": {
      "id": "<uuid>"
    }
  }
}

search_bulk_operations

List bulk runs

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "search_bulk_operations",
    "arguments": {}
  }
}

Discovery

Find out what this server can do without loading every tool schema: list toolsets, pull one group, or describe a single tool.

describe_tool

Return the description and input schema for a single tool by name, for when you know the tool but not its arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "describe_tool",
    "arguments": {
      "name": "<string>"
    }
  }
}

get_toolset_tools

Return the full description and input schema for every tool in one toolset. Use it after list_toolsets when you know which group you need, instead of carrying every schema on the server.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_toolset_tools",
    "arguments": {
      "toolset": "<string>"
    }
  }
}

list_toolsets

List the tool groups this server exposes, with a one-line summary and the scopes each needs. Start here: it is far cheaper than loading every tool schema, and it tells you which toolset to pull with get_toolset_tools.

No arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_toolsets",
    "arguments": {}
  }
}

Server

Server liveness and version.

mcp_health

Get MCP server health status including version and uptime

No arguments.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "mcp_health",
    "arguments": {}
  }
}