Lista as empresas residentes
GET/api/resident-companies
- Auth
- Requiere token
- 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. 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. |
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/resident-companies" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"