WUAPI
  1. Instances
WUAPI
  • Messages
    • Send plain text
      POST
    • Send image
      POST
    • Send audio
      POST
    • Send video
      POST
    • Send document
      POST
    • Send location
      POST
    • Send link
      POST
    • Send contact
      POST
    • Delete message by id
      DELETE
    • Get message by id
      GET
  • Users
    • Create new user
      POST
    • Get all users
      GET
  • Instances
    • Create new instance
      POST
    • List All instance
      GET
    • Update instance
      PUT
    • List by instance id
      GET
    • Delete instance
      DELETE
    • Restart instance
      GET
    • Get QRCode
      GET
    • Get QRCode in base64 image.
      GET
    • Disconnect instance
      GET
    • Update profile picture
      PUT
    • Delete profile picture
      DELETE
    • Update profile name
      PUT
  • Webhook
    • Connection event for your instance
      POST
    • Disconnection event for your instance
      POST
    • Event when you receive a message
      POST
    • Event when you send a message
      POST
  • Queues
    • Get queue instance
    • Delete queue instance
    • Get queue failed instance
    • Retry queue
  • Groups
    • Create new group
    • Get all groups
    • Get group by id
    • Add contact to group
    • Update picture of group
    • Set admins only
    • Add and remove admins in group
  • Manage
    • Restart server
  • Raiz
    • Groups
      • Get invite code
      • Leave the group
  • Schemas
    • Sample Schemas
      • Pet
      • Category
      • Tag
    • Schemas
      • ErrorResponseDTO
      • ChatMessage
      • requestBodyReceivedAndDelivery
      • error
      • Error
      • PlainTextMessageDto
      • LocationMessage
      • BaseMessageResponseDto
      • ImageMessage
      • SendImageMessageDto
      • VideoMessage
      • SendAudioMessageDto
      • DocumentMessage
      • SendVideoMessageDto
      • AudioMessage
      • SendDocumentMessageDto
      • VoiceMessage
      • SendLocationMessageDto
      • StickerMessage
      • SendLinkMessageDto
      • SendContactMessageDto
      • CreateUserDto
      • PickTypeClass
      • UsersEntity
      • CreateInstanceDto
      • CreateInstanceResponseDto
      • InstanceResponseDto
      • UpdateInstanceDto
      • UpdateInstanceResponseDto
      • ReturnInstanceResponseDto
      • ReturnInstanceQrCodeResponseDto
      • UpdateInstanceProfilePictureDto
      • UpdateInstanceProfilePictureResponseDto
      • UpdateInstanceProfileNameDto
      • CreateGroupsDto
      • GroupsEntity
      • CreateGroupsResponseDto
      • UpdateGroupsDto
      • UpdateGroupsAddContactsDto
      • UpdateGroupsResponseDto
      • UpdateGroupsUpdateProfilePictureDto
      • UpdateGroupsAdminsOnlyDto
      • UpdateGroupsUpdatePromoteDemoteDto
      • ReturnMenageResponseDto
      • GetGroupsInviteCodeResponseDto
  1. Instances

List All instance

GET
/instances
Last modified:2025-08-23 15:58:26
OperationId:InstancesController_listAll

Request

Authorization
Add parameter in header
authorization
Example:
authorization: ********************

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/instances' \
--header 'authorization: <api-key>'

Responses

🟢200OK
application/json
Body

Example
[
    {
        "name": "string",
        "deliveryWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
        "receivedWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
        "disconnectedWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
        "connectedWebhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf",
        "instanceId": "string",
        "webhookUrl": "https://webhook.site/8498babf-0281-49cf-9075-9e5317488faf"
    }
]
🟠400Bad Request
🔴500Server Error
Modified at 2025-08-23 15:58:26
Previous
Create new instance
Next
Update instance
Built with