CodeChat APIv1.0.0
ChangelogPostman
Referência/Legacy - Instances/legacyListInstances
Legacy - Instances

Lista instâncias pelo alias legado

Lista instâncias pelo alias legado

Deprecated
GEThttp://localhost:8084/instance/fetchInstances

Autenticação

GlobalApiKeyobrigatório

Token global. O runtime também aceita x-api-key e apiKey; aliases simultâneos precisam ter o mesmo valor.

Header
apikey
Exemplo
<GLOBAL_API_KEY>

Parâmetros

instanceNamequery
string

Filtro opcional, não vazio, máximo 255

minLength 1maxLength 255

Respostas

application/json
200

Lista de instâncias

response 200array
items[]object
idintegerobrigatório
namestringobrigatório
descriptionstring | nullobrigatório
statusenum<ONLINE | OFFLINE>obrigatório
connectionStatusenum<offline | connecting | qr_code | pairing_code | pairing | online | reconnecting | disconnected | connection_timeout | logged_out | session_missing | stream_replaced | keepalive_timeout | client_outdated | temporary_ban | connection_error>obrigatório
ownerJidstring | nullobrigatório
profilePicUrlstring | nullobrigatório
createdAtstring | nullobrigatórioformat: date-time
updatedAtstring | nullobrigatórioformat: date-time
AuthoneOfobrigatório
opção 1object
idintegerobrigatório
tokenstringobrigatório
createdAtstringobrigatórioformat: date-time
updatedAtstringobrigatórioformat: date-time
opção 2null
WebhookoneOfobrigatório
opção 1object
idintegerobrigatório
urlstringobrigatórioformat: uri
enabledbooleanobrigatório
eventsobjectobrigatório
callUpsertboolean
chatsDeletedboolean
chatsUpdatedboolean
connectionUpdatedboolean
contactsUpdatedboolean
contactsUpsertboolean
groupsParticipantsUpdatedboolean
groupsUpdatedboolean
groupsUpsertboolean
historySyncboolean
identityUpdatedboolean
labelsAssociationboolean
labelsEditboolean
mediaRetryboolean
messagesDeletedboolean
messagesStarredboolean
messagesUndecryptableboolean
messagesUpdatedboolean
messagesUpsertboolean
newsLetterboolean
presenceUpdatedboolean
profilePictureUpdatedboolean
qrcodeUpdatedboolean
sendMessageboolean
settingsUpdatedboolean
statusInstanceboolean
userAboutUpdatedboolean
createdAtstring | nullobrigatórioformat: date-time
updatedAtstringobrigatórioformat: date-time
instanceIdintegerobrigatório
opção 2null
Exemplo 200gerado do schema
[
  {
    "id": 1,
    "name": "CodeChat",
    "description": "string",
    "status": "ONLINE",
    "connectionStatus": "offline",
    "ownerJid": "[email protected]",
    "profilePicUrl": "string",
    "createdAt": "2026-07-13T15:10:00Z",
    "updatedAt": "2026-07-13T15:10:00Z",
    "Auth": {
      "id": 1,
      "token": "<INSTANCE_TOKEN>",
      "createdAt": "2026-07-13T15:10:00Z",
      "updatedAt": "2026-07-13T15:10:00Z"
    },
    "Webhook": {
      "id": 1,
      "url": "https://api.example.com/webhooks/codechat",
      "enabled": true,
      "events": {
        "callUpsert": true,
        "chatsDeleted": true,
        "chatsUpdated": true,
        "connectionUpdated": true,
        "contactsUpdated": true,
        "contactsUpsert": true,
        "groupsParticipantsUpdated": true,
        "groupsUpdated": true,
        "groupsUpsert": true,
        "historySync": true,
        "identityUpdated": true,
        "labelsAssociation": true,
        "labelsEdit": true,
        "mediaRetry": true,
        "messagesDeleted": true,
        "messagesStarred": true,
        "messagesUndecryptable": true,
        "messagesUpdated": true,
        "messagesUpsert": true,
        "newsLetter": true,
        "presenceUpdated": true,
        "profilePictureUpdated": true,
        "qrcodeUpdated": true,
        "sendMessage": true,
        "settingsUpdated": true,
        "statusInstance": true,
        "userAboutUpdated": true
      },
      "createdAt": "2026-07-13T15:10:00Z",
      "updatedAt": "2026-07-13T15:10:00Z",
      "instanceId": 1
    }
  }
]