Listar todos os status
GET https://.account-name.krzlabs.io/api/v1/status
Realiza a busca de todos os status.
Request
Entenda como aplicar paginação e ordenação na sua listagem
Entenda como aplicar filtros na sua listagem
Entenda como expandir entidades relacionadas nos documentos da listagem
Response
Resposta de sucesso
200
| Field | Type | Description | Optional | Searchable |
|---|---|---|---|---|
| name | string | Nome descritivo do item | not required | true |
| code | string | Código único de identificação do item | required | true |
| color | string | Cor associada ao item (ex.: código HEX ou nome da cor) | not required | false |
| enabled | boolean | Indica se o item está ativo | not required | false |
| notify | boolean | Indica se o item deve disparar notificações | not required | false |
| tags | Array(string) | Lista de tags ou palavras-chave associadas ao item | not required | false |
| outcome | enum(StatusOutcomeEnum) | Resultado ou status associado ao item (padrão: void) Possíveis opções: 'void' = 'void', 'cancel' = 'cancel', 'done' = 'done' | not required | false |
| step_code | string | Código do passo associado ao status. | Not required | false |
Exemplo de resposta em JSON
{
"page": 1,
"skip": 0,
"limit": 10,
"sort": {
"campo": "asc"
},
"pages": 5,
"total": 50,
"next": true,
"previous": "2",
"nextUrl": "https://api.exemplo.com?page=2",
"previousUrl": false,
"filters": {
"status": "ativo"
},
"data": [{
"name": "Processamento",
"code": "PRC001",
"color": "#00FF00",
"enabled": true,
"notify": false,
"tags": ["prioridade", "interno"],
"outcome": "void",
"step_code": "STEP_01"
}]
}
Resposta de erro
400
| Field | Type | Description |
|---|---|---|
| code | Number | Código da resposta http |
| kind | String | Tipo de mensagem |
| name | String | Nome da exceção lançada pela plataforma |
| title | String | Titulo do erro lançado pela plataforma |
| message | String | Mensagem indicando o probloma ocorrido |
| solution | String | Mensagem indicando uma possível solução para o problema |
Copyright © 2025 kruzer | All Rights Reserved