1. Accounts
Rocketlead
  • Welcome to RocketLead
  • Accounts
    • List WA accounts
      GET
    • Get account by ID
      GET
    • Get account activity
      GET
    • Register phone on WhatsApp
      POST
    • Connect WA account
      POST
    • Setup account profile
      POST
    • Toggle account pause state
      POST
    • Update account phase
      PATCH
    • Set account display name
      POST
    • Set account avatar
      POST
  • Campaigns
    • List campaigns
      GET
    • Create campaign
      POST
    • Get campaign by ID
      GET
    • Update campaign
      PATCH
    • Delete campaign
      DELETE
    • Add step to campaign
      POST
    • Update campaign step
      PATCH
    • Delete campaign step
      DELETE
    • Reorder campaign steps
      PUT
    • Upload campaign media
      POST
    • Send test message for a campaign step
      POST
    • Start campaign
      POST
    • Pause campaign
      POST
    • Add leads to campaign
      POST
    • List campaign leads
      GET
    • Bulk lead action
      POST
    • Import leads into campaign
      POST
    • Get campaign daily stats
      GET
    • Duplicate campaign
      POST
    • Archive campaign
      POST
  • Leads
    • List all leads
    • List all lead tags
    • Update a lead
    • Bulk delete leads
    • List custom field definitions
    • Create custom field definition
  • Lead Lists
    • List lead lists
    • Create lead list
    • Get lead list by ID
    • Delete lead list
    • List leads in a list
    • Add lead to list
    • Bulk import leads to list
  • Conversations
    • List conversations
    • Get conversation messages
    • Send message in conversation
    • Update conversation tags
    • Toggle conversation read status
    • Schedule a message
    • List scheduled messages
    • Cancel scheduled message
    • List conversation tags
    • Create conversation tag
    • Delete conversation tag
    • Bulk conversation action
    • Get contact by phone
    • Update contact
    • Send test message
  • Agents
    • List agents
    • Create agent
    • Get agent usage stats
    • Get agent by ID
    • Update agent
    • Delete agent
    • Test agent with a message
    • Get competitor analysis
    • Run competitor analysis
  • Warmup
    • Get warmup status
    • Pause warmup for account
    • Resume warmup for account
  • Credits
    • Get current credit balance
    • List credit transactions
  • Orders
    • Create a new order
    • List orders
    • Get order details
  • Provision
    • Start provisioning by requesting OTP
    • Verify OTP and complete provisioning
  • Settings
    • Get workspace settings
    • Update workspace settings
  • Knowledge Base
    • List knowledge base sources
    • Create knowledge base source
    • Discover links from URL
    • Delete knowledge base source
    • Re-ingest knowledge base source
    • Get source chunks
    • Get knowledge base stats
  1. Accounts

List WA accounts

GET
/api/v1/accounts/
List all WhatsApp accounts in the workspace. Supports filtering by phase, connection status, and search. Returns paginated results sorted by the specified field.

Request

Authorization
API Key
Add parameter in header
x-api-key
Example:
x-api-key: ********************
or
Query Params

Responses

🟢200OK
Default Response
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.rocketlead.com/api/v1/accounts/?phase&connectionStatus&search&hasCampaign&limitNotReached&sort&sortDir&limit&offset' \
--header 'x-api-key: <api-key>'
Modified at 2026-03-10 15:25:45
Previous
Welcome to RocketLead
Next
Get account by ID
Built with