Zum Inhalt springen

Lista as empresas residentes

GET/api/resident-companies

Auth
Token erforderlich
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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.

Parameter

NameOrtTypBeschreibung
statusoptionalqueryactive | ended
searchoptionalquerystring

Header

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

Antworten

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

curl-Beispiel

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