Listar Organizações
Descrição
Retorna as organizações cadastradas no sistema com suporte a paginação (12 itens por página por padrão), busca por nome e filtros opcionais de localização (país, estado, cidade). Todos os filtros podem ser combinados. Inclui a contagem de grupos e iniciais de cada grupo vinculado.
Verbo
GET
URL Base
https://api.soargi.com
Endpoint
/organizations?page=1&limit=12&name=tech&country=Brasil&state=SP
Query Parameters (Opcionais)
| Parâmetro | Tipo | Descrição | Padrão |
|---|---|---|---|
| page | integer | Número da página | 1 |
| limit | integer | Itens por página (máximo: 50) | 12 |
| name | string | Busca por nome da organização | - |
| country | string | Filtra por país | - |
| state | string | Filtra por estado | - |
| city | string | Filtra por cidade | - |
Cabeçalhos
| Parâmetro | Valor |
|---|---|
| Authorization | Bearer Token |
Respostas
Sucesso - 200
{
"success": true,
"message": "Organizations loaded successfully.",
"page": 1,
"limit": 12,
"total": 25,
"data": [
{
"org_id": "36",
"org_name": "OneFactory",
"email": "contato@onefactory.com.br",
"description": "Lorem ipsum dolor sit amet verbum avec lotus...",
"phone": "",
"country": "Brasil",
"state": "SP",
"city": "São Paulo",
"address": "",
"postal_code": "",
"avatarURL": "",
"created_at": "2025-04-15 20:06:53",
"updated_at": "2025-04-15 20:06:53",
"owner_id": "6",
"group_count": 2,
"group_initials": ["GO","FS"]
},
{
"org_id": "2",
"org_name": "TechHub",
"email": "contato@techhub.io",
"description": "Loem ipsum dolor sit amet verbum avec lotus...",
"phone": "",
"country": "Brasil",
"state": "SP",
"city": "São Paulo",
"address": "",
"postal_code": "",
"avatarURL": "",
"created_at": "2025-04-15 20:06:53",
"updated_at": "2025-04-15 20:06:53",
"owner_id": "6",
"group_count": 1,
"group_initials": ["TI"]
}
]
}
Erro - 404 (No organizations found)
{
"success": false,
"message": "No organizations found."
}
Códigos de Resposta
- 200 - Lista de organizações retornada com sucesso
- 404 - No organizations found