OrbitSenderDocs
ReferenceParceiro

Listar grupos conhecidos da conta

GET
/api/external/partner/groups

Lista paginada dos grupos conhecidos da conta, cada um com um group_ref opaco (nunca o JID) e os channel_refs[] dos canais elegíveis. Fonte: segmentos, campanhas e grupos sincronizados (últimos 30 dias). Não consulta o WhatsApp. Use o group_ref em partner/group-invite-links. Exclusivo de app de parceiro.

Authorization

PartnerOAuth segments:read
AuthorizationBearer <token>

OAuth 2.0 (Authorization Code + PKCE) para apps de parceiro. O access_token opaco (orb_at_...) vai no header Authorization: Bearer. Cada operação exige os scopes que o usuário consentiu; scopes integrations:* nunca são concedíveis a parceiro.

In: header

Scope: segments:read

Query Parameters

page?integer

Página (20 itens por página).

Range1 <= value
Default1

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/external/partner/groups"
{  "success": true,  "total": 0,  "page": 0,  "per_page": 0,  "pages": 0,  "groups": [    {      "group_ref": "string",      "name": "string",      "channel_refs": [        "string"      ]    }  ]}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Forbidden",  "code": "unsupported_credential",  "message": "Esta credencial não pode consultar link de convite de grupo."}