---
title: "Usuário: API da plataforma"
description: "API da plataforma APIBrasil (Perfil do usuário). Os endpoints abaixo são os da conta e da operação do gateway."
lang: pt-BR
canonical: https://doc.apibrasil.io/apis/plataforma/usuario
markdown: https://doc.apibrasil.io/apis/plataforma/usuario.md
source: apibrasil-documentation
---

# Usuário: API da plataforma

> API da plataforma APIBrasil (Perfil do usuário). Os endpoints abaixo são os da conta e da operação do gateway.

- **Especificação OpenAPI:** https://doc.apibrasil.io/apis/plataforma/usuario/openapi.json

## Como chamar

**Endereço base:** `https://gateway.apibrasil.io/api/v2`

## Endpoints (10 endpoints)

**Sumário**

1. `GET /plan`
2. `POST /profile`
3. `GET /invoices`
4. `GET /invoices`
5. `GET /tickets`
6. `POST /ticket`
7. `GET /ticket/TCK-HKGMWHCW2S/messages`
8. `POST /ticket/TCK-HKGMWHCW2S/messages`
9. `POST /ticket/TCK-HKGMWHCW2S`
10. `GET /balance`

### 1. GET /plan

Com esse endpoint é possível listar os dados do plano cadastrado através do usuario

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/plan`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/plan" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "name": "Plano c/ 4 APIs",
  "description": "Personalizado para: jhondoe@gmail.com",
  "value_month": 870.6,
  "value_year": 10051.2,
  "payment_at": "2025-12-03 09:05:03",
  "expired_at": "2026-01-03 23:27:40",
  "status": "active",
  "status_finance": "active",
  "apis": [
    {
      "name": "API CPF Dados",
      "search": "abcd1234-1234-5678-9abc-abcdef123456",
      "service_name": "api-cpf",
      "description": "Com a API de CPF completo, você pode obter dados de uma pessoa apenas com o CPFtotal de 100 valor unitário de R$ 0.34 87.6",
      "value": 0.34,
      "limit": 100,
      "limit_for": "request",
      "limit_cicle": "month",
      "home_disponible": "active",
      "icon": null,
      "type": "cpf",
      "version": "0.0.1"
    },
    {
      "name": "API Tabela FIPE",
      "search": "abcd1234-1234-5678-9abc-abcdef123456",
      "service_name": "fipefull-ilimitada",
      "description": "Com essa API é possível chegar ao valor FIPE de um veiculo percorrendo os dados por atráves de informações",
      "value": 0.01,
      "limit": 200,
      "limit_for": "request",
      "limit_cicle": "month",
      "home_disponible": "active",
      "icon": null,
      "type": "generic",
      "version": "v2"
    },
    {
      "name": "API WhatsApp Baileys",
      "search": "d4f5e6c7-89ab-4cde-0123-456789abcdef",
      "service_name": "whatsapp-baileys",
      "description": "Com essa API do WhatsApp, você pode enviar e receber mensagens via Rest, é possível integrar com Webhook, ideal para conexões a longo prazototal de 2 valor unitário de R$ 9.9 45.6",
      "value": 9.9,
      "limit": 2,
      "limit_for": "device",
      "limit_cicle": "month",
      "home_disponible": "active",
      "icon": null,
      "type": "baileys",
      "version": "0.0.1"
    },
    {
      "name": "API WhatsApp Wpp",
      "search": "e7f8g9h0-1a2b-3c4d-5e6f-7890abcdef12",
      "service_name": "whatsapp-wpp",
      "description": "Com essa API do WhatsApp, você pode enviar e receber mensagens via Rest, é possível integrar com Webhook, ideal para disparos em massatotal de 2 valor unitário de R$ 12.9 25.8",
      "value": 12.9,
      "limit": 2,
      "limit_for": "device",
      "limit_cicle": "month",
      "home_disponible": "active",
      "icon": null,
      "type": "whatsapp",
      "version": "1.0.59"
    },
    {
      "name": "Placa Dados",
      "search": "f1g2h3i4-5j6k-7l8m-9n0o-pqrstuvwxyz12",
      "service_name": "vehicles-old",
      "description": "Com essa API é possível buscar informações completas de um veículo informando apenas a placa, em 92% da Base Nacionaltotal de 100 valor unitário de R$ 0.08 53.6",
      "value": 0.08,
      "limit": 100,
      "limit_for": "request",
      "limit_cicle": "month",
      "home_disponible": "active",
      "icon": null,
      "type": "vehicles",
      "version": "0.0.1"
    }
  ]
}
```

### 2. POST /profile

Com esse endpoint é possivel obter os dados do seu perfil

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/profile`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/profile" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "error": false,
  "user": {
    "search": "2d55c381-6fa3-4a62-8cec-1AB",
    "cellphone": "[omitido]",
    "first_name": "[omitido]",
    "last_name": "[omitido]",
    "status": "active",
    "status_finance": "active"
  }
}
```

### 3. GET /invoices

Com esse endpoint é possivel obter os dados de suas faturas

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/invoices`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/invoices" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
[
  {
    "type": "pix",
    "description": "Mensalidade: JHON / Plano c/ 3 APIs",
    "transaction_id": "wallet_yfFWvp7j",
    "value": 74.5,
    "value_discount": 0,
    "payment_at": "16/10/2025 23:27:30",
    "expired_at": "06/10/2025 09:32:55",
    "status_finance": "approved",
    "bank": "Santander",
    "pix_copy_paste": "00020126850014br.gov.bcb.pix2563pix.santander.com.br/qr/v2/c2d91105-1c72-4422-9f26-6bfa72c122d95204000053039865802BR5914APIBRASIL LTDA6014BELO HORIZONTE62070503***63041026",
    "line_digits": null,
    "chave_nf": null,
    "pdf": null
  }
]
```

### 4. GET /invoices

Com esse endpoint é possivel obter os dados de uma fatura pelo id da transação

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/invoices`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/invoices" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
[
  {
    "type": "pix",
    "description": "Mensalidade: JHON / Plano c/ 3 APIs",
    "transaction_id": "wallet_yfFWvp7j",
    "value": 74.5,
    "value_discount": 0,
    "payment_at": "16/10/2025 23:27:30",
    "expired_at": "06/10/2025 09:32:55",
    "status_finance": "approved",
    "bank": "Santander",
    "pix_copy_paste": "00020126850014br.gov.bcb.pix2563pix.santander.com.br/qr/v2/c2d91105-1c72-4422-9f26-6bfa72c122d95204000053039865802BR5914APIBRASIL LTDA6014BELO HORIZONTE62070503***63041026",
    "line_digits": null,
    "chave_nf": null,
    "pdf": null
  }
]
```

### 5. GET /tickets

Lista todos os Tickets de um usuario

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/tickets`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/tickets" \
  -H "Content-Type: application/json"
```

**Resposta de exemplo, do catálogo**

```json
{
  "tickets": [
    {
      "title": "Não consigo gerar boleto",
      "number": "TCK-LZZB3GH9DA",
      "resum": "Ao gerar recarga boleto o pdf não aparece.",
      "description": "Ao gerar recarga boleto o pdf não aparece.",
      "status": "open",
      "coast": "0.00",
      "status_finance": "pending",
      "priority": "important",
      "dificulty": "medium",
      "type": "support",
      "attendance_id": null,
      "is_public": "no",
      "project": "apibrasil",
      "due_date": "2026-01-04 23:42:32",
      "url_file": "https://...",
      "time_estimate": "0",
      "time_spent": "0",
      "time_original_estimate": "0",
      "aggregatetime_estimate": "0",
      "resolution": null,
      "resolution_date": null,
      "votes": "0",
      "created_at": "2025-12-29T02:42:32.000000Z",
      "updated_at": "2025-12-29T02:42:32.000000Z"
    }
  ]
}
```

### 6. POST /ticket

Cria um Ticket vinculado ao bearer token do usuario

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/ticket`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |

**Corpo da requisição**

```json
{
  "title": "Não consigo gerar boleto",
  "description": "Ao gerar recarga boleto o pdf não aparece.",
  "priority": "important",
  "type": "support",
  "project": "apibrasil",
  "url_file": "https://..."
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/ticket" \
  -H "Content-Type: application/json" \
  -d '{"title":"Não consigo gerar boleto","description":"Ao gerar recarga boleto o pdf não aparece.","priority":"important","type":"support","project":"apibrasil","url_file":"https://..."}'
```

**Resposta de exemplo, do catálogo**

```json
{
  "ticket": {
    "title": "Não consigo gerar boleto",
    "description": "Ao gerar recarga boleto o pdf não aparece.",
    "priority": "important",
    "type": "support",
    "project": "apibrasil",
    "url_file": "https://...",
    "status": "open",
    "status_finance": "pending",
    "number": "TCK-LZZB3GH9DA",
    "resum": "Ao gerar recarga boleto o pdf não aparece.",
    "due_date": "2026-01-05T02:42:32.118222Z",
    "attendance_id": null,
    "dificulty": "medium",
    "time_estimate": 0,
    "time_spent": 0,
    "time_original_estimate": 0,
    "aggregatetime_estimate": 0,
    "votes": 0,
    "coast": 0,
    "updated_at": "2025-12-29T02:42:32.000000Z",
    "created_at": "2025-12-29T02:42:32.000000Z"
  }
}
```

### 7. GET /ticket/TCK-HKGMWHCW2S/messages

Obtem todas as mensagens de um determinado ticket

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/ticket/TCK-HKGMWHCW2S/messages`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/ticket/TCK-HKGMWHCW2S/messages" \
  -H "Content-Type: application/json"
```

**Resposta de exemplo, do catálogo**

```json
{
  "ticket": {
    "id": 1941,
    "title": "Não consigo gerar boleto",
    "number": "TCK-LVWMUYKJDE",
    "resum": "Ao gerar recarga boleto o pdf não aparece.",
    "description": "Ao gerar recarga boleto o pdf não aparece.",
    "status": "open",
    "coast": "0.00",
    "status_finance": "pending",
    "priority": "important",
    "dificulty": "medium",
    "type": "support",
    "attendance_id": null,
    "creator_id": 2,
    "is_public": "no",
    "project": "apibrasil",
    "due_date": "2026-01-04 23:39:30",
    "url_file": "",
    "time_estimate": "0",
    "time_spent": "0",
    "time_original_estimate": "0",
    "aggregatetime_estimate": "0",
    "resolution": null,
    "resolution_date": null,
    "votes": "0",
    "created_at": "2025-12-29T02:39:30.000000Z",
    "updated_at": "2025-12-29T02:39:30.000000Z",
    "deleted_at": null
  },
  "messages": []
}
```

### 8. POST /ticket/TCK-HKGMWHCW2S/messages

Envia uma mensagem para um determinado ticket

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/ticket/TCK-HKGMWHCW2S/messages`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |

**Corpo da requisição**

```json
{
  "message": "abc1234"
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/ticket/TCK-HKGMWHCW2S/messages" \
  -H "Content-Type: application/json" \
  -d '{"message":"abc1234"}'
```

**Resposta de exemplo, do catálogo**

```json
{
  "ticket": {
    "id": 1946,
    "title": "Não consigo gerar boleto 2",
    "number": "TCK-HKGMWHCW2S",
    "resum": "Ao gerar recarga boleto o pdf não aparece.",
    "description": "Ao gerar recarga boleto o pdf não aparece.",
    "status": "open",
    "coast": "0.00",
    "status_finance": "pending",
    "priority": "important",
    "dificulty": "medium",
    "type": "support",
    "attendance_id": null,
    "creator_id": 2,
    "is_public": "no",
    "project": "apibrasil",
    "due_date": "2026-01-05 11:25:02",
    "url_file": "",
    "time_estimate": "0",
    "time_spent": "0",
    "time_original_estimate": "0",
    "aggregatetime_estimate": "0",
    "resolution": null,
    "resolution_date": null,
    "votes": "0",
    "created_at": "2025-12-29T14:25:02.000000Z",
    "updated_at": "2025-12-29T14:25:02.000000Z",
    "deleted_at": null
  },
  "message": {
    "ticket_id": 1946,
    "message": "abc1234",
    "creator_id": 2,
    "attendance_id": null,
    "title": null,
    "file_path": null,
    "updated_at": "2025-12-29T14:48:51.000000Z",
    "created_at": "2025-12-29T14:48:51.000000Z",
    "id": 1923
  }
}
```

### 9. POST /ticket/TCK-HKGMWHCW2S

Com esse endpoint é possivel atualizar detalhes de um ticket como prioridade de atendimento e outros

- **Método:** `POST`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/ticket/TCK-HKGMWHCW2S`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |

**Corpo da requisição**

```json
{
  "status": "resolved",
  "is_important": true,
  "priority": "low"
}
```

**Em cURL**

```bash
curl -X POST "https://gateway.apibrasil.io/api/v2/ticket/TCK-HKGMWHCW2S" \
  -H "Content-Type: application/json" \
  -d '{"status":"resolved","is_important":true,"priority":"low"}'
```

**Resposta de exemplo, do catálogo**

```json
{
  "ticket": {
    "id": 1946,
    "title": "Não consigo gerar boleto 2",
    "number": "TCK-HKGMWHCW2S",
    "resum": "Ao gerar recarga boleto o pdf não aparece.",
    "description": "Ao gerar recarga boleto o pdf não aparece.",
    "status": "open",
    "coast": "0.00",
    "status_finance": "pending",
    "priority": "important",
    "dificulty": "medium",
    "type": "support",
    "attendance_id": null,
    "creator_id": 2,
    "is_public": "no",
    "project": "apibrasil",
    "due_date": "2026-01-05 11:25:02",
    "url_file": "",
    "time_estimate": "0",
    "time_spent": "0",
    "time_original_estimate": "0",
    "aggregatetime_estimate": "0",
    "resolution": null,
    "resolution_date": null,
    "votes": "0",
    "created_at": "2025-12-29T14:25:02.000000Z",
    "updated_at": "2025-12-29T14:25:02.000000Z",
    "deleted_at": null
  },
  "message": {
    "ticket_id": 1946,
    "message": "abc1234",
    "creator_id": 2,
    "attendance_id": null,
    "title": null,
    "file_path": null,
    "updated_at": "2025-12-29T14:48:51.000000Z",
    "created_at": "2025-12-29T14:48:51.000000Z",
    "id": 1923
  }
}
```

### 10. GET /balance

Com esse endpoint é possivel obter o saldo do usuario

- **Método:** `GET`
- **Endereço:** `https://gateway.apibrasil.io/api/v2/balance`
- **Versão da rota:** v2

**Cabeçalhos**

| Cabeçalho | Valor |
| --- | --- |
| `Content-Type` | `application/json` |
| `Authorization` | `Bearer $APIBRASIL_TOKEN` |

**Em cURL**

```bash
curl -X GET "https://gateway.apibrasil.io/api/v2/balance" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $APIBRASIL_TOKEN"
```

**Resposta de exemplo, do catálogo**

```json
{
  "error": false,
  "last_recharg": "R$ 10,000",
  "message": "APIBRASIL DA SILVA, seu saldo é de R$ 152.570",
  "balance": "152.570"
}
```

Nos exemplos de resposta, os campos da conta que gerou o exemplo (`user.first_name`, `user.email`, `user.cellphone`) saem como `[omitido]`. O resto é o que o catálogo publica.

## Ver também

- Especificação OpenAPI: https://doc.apibrasil.io/apis/plataforma/usuario/openapi.json
- Catálogo de APIs: [Catálogo de APIs](https://doc.apibrasil.io/apis.md)
- SDKs oficiais: [SDKs oficiais](https://doc.apibrasil.io/sdks.md)
- Índice da documentação: https://doc.apibrasil.io/llms.txt
- Versão HTML desta página: https://doc.apibrasil.io/apis/plataforma/usuario