Instances
Fetch Instances
- GETGet Information
- POSTCreate Instance Basic
- GETFetch Instances
- GETInstance Connect
- PUTRestart Instance
- GETConnection State
- DELLogout Instance
- DELDelete Instance
- POSTSet Presence
- POSTSend Template
- POSTSend Plain Text
- POSTSend Status
- POSTSend Media
- POSTSend WhatsApp Audio
- POSTSend Sticker
- POSTSend Location
- POSTSend Contact
- POSTSend Reaction
- POSTSend Poll
- POSTSend List
- POSTCheck is WhatsApp
- PUTMark Message As Read
- PUTArchive Chat
- DELDelete Message for Everyone
- POSTSend Presence
- POSTFetch Profile Picture URL
- POSTFind Contacts
- POSTFind Messages
- POSTFind Status Message
- PUTUpdate Message
- GETFind Chats
- POSTFetch Business Profile
- POSTFetch Profile
- POSTUpdate Profile Name
- POSTUpdate Profile Status
- PUTUpdate Profile Picture
- DELRemove Profile Picture
- GETFetch Privacy Settings
- PUTUpdate Privacy Settings
- POSTCreate Group
- PUTUpdate Group Picture
- PUTUpdate Group Subject
- PUTUpdate Group Description
- GETFetch Invite Code
- GETAccept Invite Code
- PUTRevoke Invite Code
- POSTSend Group Invite
- GETFind Group by Invite Code
- GETFind Group by JID
- GETFetch All Groups
- GETFind Group Members
- PUTUpdate Group Members
- PUTUpdate Group Setting
- PUTToggle Ephemeral
- DELLeave Group
Início
Instances
Send Message
Chat Controller
Profile Settings
Profile Settings
Instances
Fetch Instances
Returns the instance with the name informed in the parameter, or all the instances if empty.
GET
https://{server-url}
/
instance
/
fetchInstances
server-url
string
server-url
string
The URL of your EvolutionAPI server
apikey
string
*
apikey
Required
string
Your authorization key header
instanceName
string
instanceName
string
Name of the instance to be fetched
curl --request GET \
--url https://{server-url}/instance/fetchInstances \
--header 'apikey: <api-key>'
[
{
"instance": {
"instanceName": "example-name",
"instanceId": "421a4121-a3d9-40cc-a8db-c3a1df353126",
"owner": "553198296801@s.whatsapp.net",
"profileName": "Guilherme Gomes",
"profilePictureUrl": null,
"profileStatus": "This is the profile status.",
"status": "open",
"serverUrl": "https://example.evolution-api.com",
"apikey": "B3844804-481D-47A4-B69C-F14B4206EB56",
"integration": {
"integration": "WHATSAPP-BAILEYS",
"webhook_wa_business": "https://example.evolution-api.com/webhook/whatsapp/db5e11d3-ded5-4d91-b3fb-48272688f206"
}
}
},
{
"instance": {
"instanceName": "teste-docs",
"instanceId": "af6c5b7c-ee27-4f94-9ea8-192393746ddd",
"status": "close",
"serverUrl": "https://example.evolution-api.com",
"apikey": "123456",
"integration": {
"token": "123456",
"webhook_wa_business": "https://example.evolution-api.com/webhook/whatsapp/teste-docs"
}
}
}
]
Authorizations
apikey
string
headerrequiredYour authorization key header
Query Parameters
instanceName
string
Name of the instance to be fetched
Response
200 - application/json
status
integer
The HTTP status of the response
error
string
The error message indicating the type of error
response
object
response.message
string[]
List of detailed error messages
curl --request GET \
--url https://{server-url}/instance/fetchInstances \
--header 'apikey: <api-key>'
[
{
"instance": {
"instanceName": "example-name",
"instanceId": "421a4121-a3d9-40cc-a8db-c3a1df353126",
"owner": "553198296801@s.whatsapp.net",
"profileName": "Guilherme Gomes",
"profilePictureUrl": null,
"profileStatus": "This is the profile status.",
"status": "open",
"serverUrl": "https://example.evolution-api.com",
"apikey": "B3844804-481D-47A4-B69C-F14B4206EB56",
"integration": {
"integration": "WHATSAPP-BAILEYS",
"webhook_wa_business": "https://example.evolution-api.com/webhook/whatsapp/db5e11d3-ded5-4d91-b3fb-48272688f206"
}
}
},
{
"instance": {
"instanceName": "teste-docs",
"instanceId": "af6c5b7c-ee27-4f94-9ea8-192393746ddd",
"status": "close",
"serverUrl": "https://example.evolution-api.com",
"apikey": "123456",
"integration": {
"token": "123456",
"webhook_wa_business": "https://example.evolution-api.com/webhook/whatsapp/teste-docs"
}
}
}
]