Skip to main content
GET
/
api
/
sessions
curl -X GET "https://api.oxenty.api.br/api/sessions?page=1&limit=10&status=connected" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "atendimento-principal",
      "status": "connected",
      "phone": "5511999999999",
      "allowGroup": true,
      "hasWebhook": true,
      "createdAt": "2024-01-15T10:00:00.000Z",
      "connectedAt": "2024-01-15T10:05:00.000Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "suporte",
      "status": "connected",
      "phone": "5511888888888",
      "allowGroup": false,
      "hasWebhook": false,
      "createdAt": "2024-01-14T08:00:00.000Z",
      "connectedAt": "2024-01-14T08:10:00.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 10,
    "totalPages": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.oxenty.api.br/llms.txt

Use this file to discover all available pages before exploring further.

Retorna uma lista paginada de todas as sessões do tenant.

​
Query Parameters

​
page
integer
default:"1"
Número da página.
​
limit
integer
default:"10"
Quantidade de itens por página (máximo 100).
​
status
string
Filtrar por status da sessão.Valores: disconnected, qr, connecting, connected

​
Resposta

​
data
array
Lista de sessões.
​
meta
object
Metadados de paginação.
curl -X GET "https://api.oxenty.api.br/api/sessions?page=1&limit=10&status=connected" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "atendimento-principal",
      "status": "connected",
      "phone": "5511999999999",
      "allowGroup": true,
      "hasWebhook": true,
      "createdAt": "2024-01-15T10:00:00.000Z",
      "connectedAt": "2024-01-15T10:05:00.000Z"
    },
    {
      "id": "550e8400-e29b-41d4-a716-446655440001",
      "name": "suporte",
      "status": "connected",
      "phone": "5511888888888",
      "allowGroup": false,
      "hasWebhook": false,
      "createdAt": "2024-01-14T08:00:00.000Z",
      "connectedAt": "2024-01-14T08:10:00.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 10,
    "totalPages": 1
  }
}