API Reference
Needle API
Needle Agents API Reference (v1).
Programmatic access to leads, campaigns, LinkedIn, Instagram, and more. Every endpoint uses the same base URL and Bearer authentication.
For AI agents, start at the onboarding skill, connect at the MCP server, or read the full index at /llms-full.txt.
Features
Leads
Build lead lists from LinkedIn and the Places API.
Campaigns
Run multi-channel, multi-account outreach on LinkedIn and Instagram.
Search people and run outreach from connected accounts.
Reach people on Instagram from connected accounts.
Events
Search activity across campaigns, leads, and connected accounts.
Places
Find companies and locations to source lists.
Connected Accounts
Connect LinkedIn and Instagram accounts to send from.
Suppressions
Keep people and companies you should not contact off the list.
Compose
Preview a message before you send it.
Base URL
All routes start with /api/v1.
Authentication
Authenticate every request with Authorization: Bearer sk-ndl-…. Create a key in the dashboard under API keys. Each key is bound to one user and one organization.
curl undefined/api/v1/me \ -H "Authorization: Bearer sk-ndl-…" \ -H "Content-Type: application/json"
Response codes
Successful requests return 2xx. Client errors return 4xx. Server errors return 5xx.
2xx | Success |
400 | Bad request |
401 | Unauthorized. Missing or invalid API key. |
403 | Forbidden |
404 | Not found |
422 | Invalid request payload |
5xx | Server error |