Instance

Returns all instances, optionally filtered by name or ID

get/v1/instance/fetchInstances

Request

  • Base URL
    http://localhost:8080
  • Auth
    API key in header apikey

Query parameters

instanceNamestring

Filter by instance name

idstring

Filter by instance ID

Response

OK

alwaysOnlineboolean
groupsIgnoreboolean
idstring
instanceNamestring
msgCallstring
ownerJidstring
proxyHoststring
proxyPasswordstring
proxyPortstring
proxyProtocolstring
proxyUsernamestring
readMessagesboolean
rejectCallboolean
remoteJIDstring
saveMediaboolean
syncFullHistoryboolean

Changes