Skip to main content
GET
Buscar instancia por ID

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json
id
string

Identificador único da instância

Example:

"507f1f77bcf86cd799439011"

name
string

Nome da instância

Example:

"Instância atendimentos suporte"

createdAt
string<date-time>

Data de criação da instância

Example:

"2024-04-11T12:00:00.000Z"

updatedAt
string<date-time>

Data de atualização da instância

Example:

"2024-04-11T14:30:00.000Z"

platform
string

Platforma da instância

Example:

"WHATSAPP"

provider
string

Provedor da integração

Example:

"WHATSAPP_CLOUD_API"

engine
string

Motor da instância

Example:

"WHATSAPP_CLOUD_API_19"

config
object

Configurações adicionais da instância

Example:
isActive
boolean

Indica se a instância está ativa

Example:

true

webhook
string

Path do webhook

Example:

"/webhooks/z-api/d129a692-e5ab-42b3-b0e4-90ad9a12b068/68597f2a95fb0298e5c128b5"

status
string

Status da conexão

Example:

"CONNECTED"

errorCode
string

Código de erro da conexão com a instância

Example:

"429"

errorMessage
string

Mensagem de erro da conexão com a instância

Example:

"Não foi possível se conectar com o provedor"

deletedAt
string<date-time>

Data de exclusão da instância

Example:

"2025-11-07T22:05:15.754Z"