Lista as empresas
GET/api/companies
- Auth
- Requires a token
- API key:
- companies:read
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
statusoptional | query | active | ended | |
searchoptional | query | string |
Headers
| Name | Type | Description |
|---|---|---|
X-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Responses
| Status | Description |
|---|---|
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. |
curl example
curl -X GET "https://api.memberfy.net/api/companies" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"