Skip to main content
GET
Instance data

Overview

This method returns your instance data and settings.

Attributes

string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.

Response

200

string
Instance ID
string
Instance token
string
Instance name
number
Instance expiration date timestamp (unix timestamp)
boolean
Whether the instance is connected
string
Instance payment status
string
Instance creation date
string
Connection webhook URL
string
Message delivery webhook URL
string
Disconnection webhook URL
string
Message status webhook URL
string
Chat presence webhook URL
string
Message received webhook URL
boolean
Whether to receive webhooks for messages sent by the instance itself
boolean
Whether to automatically reject incoming calls
string
Message to send when rejecting a call
boolean
Whether to automatically mark received messages as read
string
Initial data webhook URL after connection
string
Proxy URL configured on the instance.
boolean
Defines whether the instance is using the configured proxy.

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.