Fetch Instances

GET 
/instance/fetchInstances

Fetch Instances

Request

Query Parameters

instanceName string
Recupere uma ou todas as intâncias - optional
Example: codechat-bot

Responses

200

OK

Response Headers

• X-Powered-By string
• Content-Type string
• Content-Length integer
• ETag string
• Vary string
• Date string
• Connection string
• Keep-Alive string

application/json

Schema

Schema

• object

Example (from schema)

{}

example-0

200 - Fetch Single

{
  "id": 1,
  "name": "codechat",
  "description": "Instance: Test V1",
  "connectionStatus": "ONLINE",
  "ownerJid": null,
  "profilePicUrl": null,
  "createdAt": "2023-12-04T00:00:00.000Z",
  "updatedAt": "2023-12-04T00:00:00.000Z",
  "Auth": {
    "id": 1,
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnN0YW5jZU5hbWUiOiJjb2RlY2hhdCIsImFwaU5hbWUiOiJ3aGF0c2FwcC1hcGkiLCJ0b2tlbklkIjoiYjEwZDYzZWYtZGQ4Ni00NzFmLTljZmMtOGYxMTAxYTJjNGI3IiwiaWF0IjoxNzAxNzMyODYyLCJleHAiOjE3MDE3MzY0NjIsInN1YiI6ImctdCJ9.ICtbfIIUm7tE52GlxhBTEHiYwWSNAeWTg3er6v1I9Qw",
    "createdAt": "2023-12-04T00:00:00.000Z",
    "updatedAt": "2023-12-04T00:00:00.000Z"
  },
  "Webhook": null,
  "Chatwoot": null,
  "Typebot": null
}

example-1

200 - Fetch All

[
  {
    "id": 1,
    "name": "codechat",
    "description": "Instance: Test V1",
    "connectionStatus": "ONLINE",
    "ownerJid": null,
    "profilePicUrl": null,
    "createdAt": "2023-12-04T00:00:00.000Z",
    "updatedAt": "2023-12-04T00:00:00.000Z",
    "Auth": {
      "id": 1,
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpbnN0YW5jZU5hbWUiOiJjb2RlY2hhdCIsImFwaU5hbWUiOiJ3aGF0c2FwcC1hcGkiLCJ0b2tlbklkIjoiYjEwZDYzZWYtZGQ4Ni00NzFmLTljZmMtOGYxMTAxYTJjNGI3IiwiaWF0IjoxNzAxNzMyODYyLCJleHAiOjE3MDE3MzY0NjIsInN1YiI6ImctdCJ9.ICtbfIIUm7tE52GlxhBTEHiYwWSNAeWTg3er6v1I9Qw",
      "createdAt": "2023-12-04T00:00:00.000Z",
      "updatedAt": "2023-12-04T00:00:00.000Z"
    },
    "Webhook": null,
    "Chatwoot": null,
    "Typebot": null
  }
]

Loading...