> ## Documentation Index
> Fetch the complete documentation index at: https://developer.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Dados da instância

> Retorna os dados e configurações da instância

## Conceituação

Este método retorna os dados e configurações da sua instância.

***

## Atributos

### Header

<ParamField path="instanceId" type="string" required>
  ID da sua instância. Disponível no painel Z-API em **Instâncias**.
</ParamField>

<ParamField path="token" type="string" required>
  Token da sua instância Z-API.
</ParamField>

***

## Response

### 200

<ResponseField name="id" type="string">
  Id da instância
</ResponseField>

<ResponseField name="token" type="string">
  Token da instância
</ResponseField>

<ResponseField name="name" type="string">
  Nome da instância
</ResponseField>

<ResponseField name="due" type="number">
  Timestamp com a data de vencimento da instância (unix timestamp)
</ResponseField>

<ResponseField name="connected" type="boolean">
  Define se a instância está conectada
</ResponseField>

<ResponseField name="paymentStatus" type="string">
  Define o status de pagamento da instância
</ResponseField>

<ResponseField name="created" type="string">
  Data de criação da instância
</ResponseField>

<ResponseField name="connectedCallbackUrl" type="string">
  URL do webhook de conexão
</ResponseField>

<ResponseField name="deliveryCallbackUrl" type="string">
  URL do webhook de envio de mensagem
</ResponseField>

<ResponseField name="disconnectedCallbackUrl" type="string">
  URL do webhook de desconexão
</ResponseField>

<ResponseField name="messageStatusCallbackUrl" type="string">
  URL do webhook de status da mensagem
</ResponseField>

<ResponseField name="presenceChatCallbackUrl" type="string">
  URL do webhook de presença do chat
</ResponseField>

<ResponseField name="receivedCallbackUrl" type="string">
  URL do webhook de recebimento
</ResponseField>

<ResponseField name="receiveCallbackSentByMe" type="boolean">
  Define se irá receber webhook das mensagens enviadas pela própria instância
</ResponseField>

<ResponseField name="callRejectAuto" type="boolean">
  Define se irá rejeitar uma chamada recebida automaticamente
</ResponseField>

<ResponseField name="callRejectMessage" type="string">
  Mensagem a ser enviada quando rejeitar uma chamada
</ResponseField>

<ResponseField name="autoReadMessage" type="boolean">
  Define se irá marcar as mensagens recebidas como lidas automaticamente
</ResponseField>

<ResponseField name="initialDataCallbackUrl" type="string">
  URL do webhook de dados iniciais após conexão
</ResponseField>

<ResponseField name="proxyUrl" type="string">
  URL do proxy configurado na instância
</ResponseField>

<ResponseField name="useProxy" type="boolean">
  Define se a instância está utilizando o proxy configurado
</ResponseField>

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "id": "123456",
  "token": "abcdef-ghij-klmn-opqr",
  "name": "Minha instância",
  "due": 1700000000,
  "connected": true,
  "paymentStatus": "ACTIVE",
  "created": "2024-01-01T00:00:00.000Z",
  "connectedCallbackUrl": "https://meusite.com/webhook/connected",
  "deliveryCallbackUrl": "https://meusite.com/webhook/delivery",
  "disconnectedCallbackUrl": "https://meusite.com/webhook/disconnected",
  "messageStatusCallbackUrl": "https://meusite.com/webhook/message-status",
  "presenceChatCallbackUrl": "https://meusite.com/webhook/presence",
  "receivedCallbackUrl": "https://meusite.com/webhook/received",
  "receiveCallbackSentByMe": false,
  "callRejectAuto": false,
  "callRejectMessage": "",
  "autoReadMessage": false,
  "initialDataCallbackUrl": "",
  "proxyUrl": "socks5://user:senha123@localhost:1080",
  "useProxy": true
}
```

### 405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

### 415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o "Content-Type" do objeto que você está enviando, em sua grande maioria "application/json".