Saltar al contenido

Minha empresa

GET/api/companies/mine

Auth
Requiere token
Clave de API:
companies:read
X-CommunityId
X-CommunityId Enví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.

A empresa de quem chama e a equipe, **sem os campos de contrato**. Qualquer pessoa da comunidade pode chamar; quem não está em nenhuma empresa recebe `data: null`. O e-mail das pessoas da equipe só vem para o admin da empresa enquanto ela está ativa; `canManageTeam` diz se quem chama pode convidar e remover (admin da empresa, empresa ativa). Em empresa encerrada `canManageTeam` é `false` e a equipe vem sem e-mail. Convites pendentes para entrar em uma empresa ficam em `GET /api/companies/invitations/mine`. `offers` são os planos e produtos que a equipe do coworking escolheu para a empresa (toda a equipe vê); `canPurchase` diz se quem chama pode contratar (admin da empresa, empresa ativa); `purchaseLink` é a URL da aba "Contratar"; `billing` (razão social, CNPJ, e-mail de cobrança) só vem para o admin da empresa. `benefits` é o que a empresa dá a **qualquer** pessoa da equipe com vínculo vivo: `items`, os planos e produtos com assinatura (`ACTIVE`) ou compra ativa da empresa (`productId`, `title`, `type`, `kind`, `isPlan`, `source` `subscription` | `purchase`, `plan` `{ id, name }` ou null, `spaces` que ele libera `{ id, title, slug, module }` e `contents` que o plano inclui `{ productId, title, kind }`), e `credits`, o saldo da carteira da empresa que a pessoa pode usar nas reservas (`balance`, `expiringSoon` `{ amount, at }` ou null). Sem preço e sem dados de cobrança. Empresa encerrada: `benefits: null`.

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Respuestas

CódigoDescripción
200A empresa e a equipe, ou `null`.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Ejemplo con curl

curl -X GET "https://api.memberfy.net/api/companies/mine" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"