Skip to main content
GET
/
api
/
v2
/
instances
/
{instanceId}
Obtém uma instância
curl --request GET \
  --url https://server.zapperapi.com/api/v2/instances/{instanceId} \
  --header 'Authorization: Bearer <token>'
{
  "instance": {
    "apikey": "<string>",
    "beta": true,
    "connectionStatus": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "delay": "<string>",
    "enableLinkPreview": true,
    "enableSendPresenceUpdate": true,
    "endpointId": 123,
    "id": "<string>",
    "label": "<string>",
    "markAsRead": true,
    "metaAccessToken": "<string>",
    "metaBusinessAccountId": "<string>",
    "metaPhoneNumberId": "<string>",
    "metaVerificationToken": "<string>",
    "metaForwardWebhook": "<string>",
    "ownerId": "<string>",
    "stackId": 123,
    "type": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "userImage": "<string>",
    "userJid": "<string>",
    "version": "<string>",
    "webhookUrl": "<string>",
    "webhookSecret": "<string>"
  }
}

Authorizations

Authorization
string
header
required

API Key global para autenticação na Instance API (Bearer token)

Path Parameters

instanceId
string
required

Id da instância

Query Parameters

userId
string

Id do usuário selecionado. Aplica-se somente para clientes parceiros com autorização para gerenciar sub-contas na ZapperAPI.

Response

200 - application/json

Default Response

instance
object
required