Lista as empresas
GET/api/companies
- Auth
- Requiere token
- Clave de API:
- companies:read
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
Owner, admin, financeiro e moderador; membro leva 403. O moderador recebe as empresas sem os campos de contrato. Owner, admin e financeiro recebem também `offers` (planos e produtos que a empresa pode contratar), `billing` (razão social, CNPJ, e-mail de cobrança) e `purchaseLink` (a aba "Minha empresa › Contratar" no domínio da comunidade); o moderador não. `plan`, `product` e `monthlyValue` não existem mais. Ordem alfabética. `status` filtra por `active` ou `ended`; `search` busca no nome.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
statusopcional | query | active | ended | |
searchopcional | query | string |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respuestas
| Código | Descripción |
|---|---|
200 | Empresas da comunidade. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X GET "https://api.memberfy.net/api/companies" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"