Jump to Content
API Reference
v1.6
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.6
API Reference
retrieve instance
Search
JUMP TO
WaAPI
Introduction
Get Started 🚀️️
Setup
API Token
Webhooks 🪝
Message Event
QR Event
Ready Event
Loading Event
Authenticated Event
Auth Failure Event
Disconnected Event
Message Create Event
Message Edit Event
Message Acknowlegded Event
Message Revoke Everyone Event
Message Revoke Me Event
Message Reaction Event
Group Update Event
Group Join Event
Group Leave Event
Vote Update Event
Libraries and Packages 📦
WaAPI API
instances
list instances
get
create instance
post
retrieve instance
get
update instance
put
delete instance
delete
client
client status of instance
get
retrieve QR Code
get
retrieve basic client information
get
logout
post
Reboot Instance
post
Send presence available
post
Set WhatsApp status
post
Set display name
post
Request Pairing Code
post
Send presence unavailable
post
message
Send a text message to a chat
post
Send a media message (image, video, audio, document)
post
Send vCard
post
Send Location
post
Fetch messages from a chat
post
Get Message by ID
post
get message info by id
post
delete message by id
post
Search Messages
post
Create Poll Message
post
get message reactions
post
react to message
post
get message mentions
post
pin message
post
unpin message
post
star message
post
unstar message
post
chat
Mark chat messages as seen (blue ticks)
post
Get all chats
post
Mark Chat as Unread
post
Mute Chat
post
Unmute Chat
post
Pin Chat
post
Unpin Chat
post
get chat by id
post
delete chat by id
post
archive chat
post
unarchive chat
post
get chat labels
post
get chats by labelId
post
Send typing state
post
Clear chat messages
post
Sync chat history
post
Stop typing indicator
post
contact
Get all WhatsApp contacts
post
get formatted number
post
is registered user
post
Get Profile Picture URL
post
Get Contact Details by ID
post
Block a WhatsApp Contact
post
Unblock a WhatsApp Contact
post
Get blocked contacts
post
Get common groups with contact
post
Get contact about info
post
number
Get WhatsApp chat ID from phone number
post
get country code
post
group
Create Group
post
get group participants
post
get group info
post
update group info
post
update group settings
post
add group participant
post
remove group participant
post
promote group participant
post
demote group participant
post
approve group membership requests
post
deny group membership requests
post
get group membership requests
post
accept group invite
post
get group invite info
post
channel
create a channel
post
get channels
post
get channel by id
post
subscribe to channel
post
unsubscribe from channel
post
search channels
post
label
get all labels
post
get label by id
post
story
Get WhatsApp Stories
post
Powered by
retrieve instance
get
https://waapi.app/api/v1/instances/
{id}
Retrieve a single instance by its ID
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
RESPONSE
Click
Try It!
to start a request and see the response here!