External API

Build on the NetworkHQ API.

Explore the public API, authorize with a workspace key, and test campaign, sender account, lead list, lead creation, enrichment, and conversation requests in a dedicated OpenAPI reference.

Open referenceOpenAPI JSON
networkhq.io/apisLive

Sample request

List conversations

200 OK
GET/api/v1/conversations
Authorization: Bearer nhq_live_...

{
  "data": [{
    "lead": {
      "first_name": "Priya",
      "last_name": "Shah"
    },
    "intent": "INTERESTED",
    "last_message": {
      "direction": "received",
      "content": "Interested - send details."
    }
  }]
}
Scoped key

conversations:read

Messages

Direction included

Spec

OpenAPI 3.1

Ready for docs, client generators, and external tooling.

Auth

Bearer API key

Authorize once in the reference with a workspace-scoped token.

Base URL

https://sneakattack.networkhq.io/api/v1

Requests are scoped to the workspace that owns the API key.

Quick start

Two lines to your
first response.

Pick your language, copy the snippet, and replace the key. Conversation responses include the real latest message content and direction.

curl -G "https://sneakattack.networkhq.io/api/v1/conversations?limit=10" \
  -H "Authorization: Bearer nhq_live_..."

Sample response

200application/json
{
  "data": [
    {
      "id": "conv_01jwxq...",
      "intent": "INTERESTED",
      "is_unread": true,
      "last_message": {
        "direction": "received",
        "content": "Interested - send details."
      }
    }
  ],
  "pagination": {"has_more": false}
}
API surface

Workspace data, ready for external systems.

Public endpoints for campaign reporting, sender accounts, list management, lead workflows, and conversation history.

Open schema
GET

Campaigns

Campaign status, sender accounts, lead totals, sent activity, replies, and timestamps.

/campaignscampaigns:read
GET

LinkedIn accounts

List workspace sender accounts with profile, status, sending limits, usage, and cooldown fields.

/linkedin_accountslinkedin_accounts:read
GET / POST

Lead lists

Create lists, list existing lists, and inspect the leads attached to a list.

/lead_listsread + write
POST

Lead creation

Create one lead or submit a batch with per-item validation and results.

/lead_lists/{id}/leadsleads:write
POST

Enrichment

Refresh lead profiles with success, cached, failed, and credit-aware states.

/leads/{id}/enrichleads:write
GET

Conversations

List workspace conversations with lead, account, intent, unread state, and latest-message direction.

/conversationsconversations:read
GET

Conversation messages

Fetch one conversation with paginated message history ordered oldest first.

/conversations/{id}conversations:read
POST

Send messages

Send a plain-text message into an existing LinkedIn conversation thread.

/conversations/{id}/messagesconversations:write
Setup flow

From API key to first request without guesswork.

Keep setup inside NetworkHQ, then use the generated key in this reference or any external integration that can send bearer-token requests.

  1. 1

    Create the key

    Generate a workspace API key from NetworkHQ settings.

  2. 2

    Choose scopes

    Grant only the public API permissions your integration needs.

  3. 3

    Authorize the docs

    Paste the token into Swagger's Authorize dialog and keep it for the session.

  4. 4

    Ship against the schema

    Test requests here or open the raw OpenAPI JSON in a new tab.

Interactive reference

Test the public API on its own page.

Open the dedicated Swagger UI page to authorize with a bearer token and run live requests against the public API schema. The raw configuration is still available at https://sneakattack.networkhq.io/api/v1/openapi.json.

Open interactive referenceOpenAPI JSON