Saltar para o conteúdo

Lista as empresas residentes

GET/api/resident-companies

Auth
Exige token
X-CommunityId
X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Owner, admin, financeiro e moderador; membro leva 403. O moderador recebe as empresas sem os campos de contrato. Ordem alfabética. `status` filtra por `active` ou `ended`; `search` busca no nome.

Parâmetros

NomeOndeTipoDescrição
statusopcionalqueryactive | ended
searchopcionalquerystring

Headers

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

Respostas

CódigoDescrição
200Empresas da comunidade.
401Token ausente, inválido ou expirado.
403Autenticado, mas sem permissão para esta operação.
500Erro interno do servidor.

Exemplo com curl

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