> ## Documentation Index > Fetch the complete documentation index at: https://docs.escrybe.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Listar os times em que você pode faturar > Os times em que esta conta pode faturar um pedido com `paymentMethod=team`, cada um com o `team_member_id` que os endpoints de pedido exigem (cartas, e-mail registrado e WhatsApp). É a mesma lista do grupo "Times" do select de pagamento das telas de envio do painel: só participações ativas e só times cujo responsável tem um plano que permite faturamento. O dono do time também aparece (`you_are_owner: true`), então o dono pode faturar no próprio time pela API com o seu `team_member_id`. Lista `teams` vazia significa que não há time em que faturar. O token também é aceito no header `securityToken` ou em `Authorization: Bearer` (nesse caso chame `/api/v2/teams` sem o segmento do caminho). ## OpenAPI ````yaml /openapi/escrybe.pt.yaml get /api/v2/teams/{securityToken} openapi: 3.1.0 info: title: API Escrybe version: 1.0.0 description: >- REST API da plataforma Escrybe — envie cartas físicas, cartas registradas, telegramas e e-Carta pelos Correios, dispare e-mails registrados juridicamente e envie mensagens de WhatsApp com carimbo de tempo certificado. ## Autenticação Toda conta possui um **`securityToken`** pessoal (disponível no painel em *Minhas configurações → Acesso a API*). Três produtos o utilizam de formas diferentes: | Produto | Esquema | Como | |---------|---------|------| | Cartas / Telegrama / e-Carta, E-mail Registrado, Recibos | Token de API | Envie `userSecurityToken` como parâmetro (query/body) ou `securityToken` como header | | WhatsApp | HTTP Basic | `Authorization: Basic base64(email:securityToken)` | > As rotas de **consulta** de carta e e-mail (`get`, `balance`, `download`, > `delete`) recebem o token como o primeiro segmento de **caminho** da URL — > ex.: `/api/v2/get/{securityToken}/{job_id}`. ## Envelopes de resposta A maioria dos endpoints responde com o envelope padrão `{"status": , "status_message": "...", "data": ...}` — isso cobre Cartas/Telegrama, E-mail Registrado e os endpoints de mensagens e remetentes de WhatsApp. Os endpoints de **modelos** de WhatsApp (e a sincronização de modelos) usam `{"code": , "status": "success|error", "message": "...", "data": ..., "request_id": "..."}`; o endpoint de logo usa o mesmo formato sem `request_id`. Consulte o schema de cada endpoint. Uma requisição aceita retorna HTTP `200` com o payload de sucesso; problemas de validação retornam `400`, credenciais inválidas `401` e acesso negado `403`. Métodos HTTP não suportados retornam `405`, tentativas repetidas de autenticação falhas retornam `429` e os endpoints de carta e e-mail retornam `503` durante janelas de manutenção. contact: name: Suporte Escrybe url: https://escrybe.com.br servers: - url: https://app.escrybe.com.br description: Produção - url: https://homolog.escrybe.com.br description: Homologação security: - securityTokenQuery: [] tags: - name: Letters & Telegram description: Crie e gerencie pedidos de carta, telegrama e e-Carta (Correios). - name: Account & Favorites description: Saldo da conta, contatos salvos e logo do remetente. - name: Registered E-mail description: Envie e acompanhe e-mails registrados juridicamente. - name: WhatsApp Messages description: Envie mensagens de WhatsApp e baixe atestações com carimbo de tempo. - name: WhatsApp Senders description: Gerencie números do WhatsApp Business (remetentes). - name: WhatsApp Templates description: Crie, sincronize e gerencie modelos de mensagem do WhatsApp. - name: Receipts description: Baixe recibos legais de qualquer pedido. paths: /api/v2/teams/{securityToken}: get: tags: - Account & Favorites summary: Listar os times em que você pode faturar description: >- Os times em que esta conta pode faturar um pedido com `paymentMethod=team`, cada um com o `team_member_id` que os endpoints de pedido exigem (cartas, e-mail registrado e WhatsApp). É a mesma lista do grupo "Times" do select de pagamento das telas de envio do painel: só participações ativas e só times cujo responsável tem um plano que permite faturamento. O dono do time também aparece (`you_are_owner: true`), então o dono pode faturar no próprio time pela API com o seu `team_member_id`. Lista `teams` vazia significa que não há time em que faturar. O token também é aceito no header `securityToken` ou em `Authorization: Bearer` (nesse caso chame `/api/v2/teams` sem o segmento do caminho). operationId: listTeams parameters: - $ref: '#/components/parameters/SecurityTokenPath' responses: '200': description: Times retornados (lista vazia quando não há nenhum) content: application/json: schema: allOf: - $ref: '#/components/schemas/V2Envelope' - properties: data: type: object properties: teams: type: array items: $ref: '#/components/schemas/Team' example: status: 200 status_message: Sucesso data: teams: - team_member_id: 57 team_id: 12 team_name: Financeiro owner_name: Acme Ltda you_are_owner: false '400': $ref: '#/components/responses/V2BadRequest' '401': $ref: '#/components/responses/V2Unauthorized' security: [] components: parameters: SecurityTokenPath: name: securityToken in: path required: true schema: type: string description: Seu token de segurança (usado como autenticação). schemas: V2Envelope: type: object properties: status: type: integer example: 200 status_message: type: string data: oneOf: - type: object - type: string - type: 'null' Team: type: object properties: team_member_id: type: integer description: >- Id da sua participação neste time (`team_members.id`). É este o valor que `paymentMethod=team` espera nos endpoints de pedido — NÃO o `team_id`. É diferente para cada membro do mesmo time. team_id: type: integer description: Id do time em si. Não é aceito pelos endpoints de pedido. team_name: type: string owner_name: type: string description: Nome da conta que recebe a fatura. you_are_owner: type: boolean description: true quando a conta do token é a dona do time. responses: V2BadRequest: description: Requisição inválida ou incompleta content: application/json: schema: $ref: '#/components/schemas/V2Envelope' example: status: 400 status_message: Requisição incompleta data: null V2Unauthorized: description: Token inválido content: application/json: schema: $ref: '#/components/schemas/V2Envelope' example: status: 401 status_message: Token inválido data: null securitySchemes: securityTokenQuery: type: apiKey in: query name: userSecurityToken description: >- Seu token de segurança, enviado como parâmetro `userSecurityToken` (query ou form). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.