# Lista os KDS

Retorna lista os KDS.

Endpoint: GET /api/v3/kds
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Query parameters:

  - `name` (string)
    Filtra pelo nome do KDS.
    Example: "KDS Cozinha"

  - `is_active` (boolean)
    Filtra se o KDS está ativo ou não.

  - `is_expedition` (boolean)
    Filtra se a expedição está ativo ou não.

  - `kds_ids` (string)
    Filtra pelos IDs dos KDS. Pode passar mais de um ID numérico separado por virgula.
    Example: "1,2,3"

  - `page` (number)
    Indica a página da paginação.

  - `per_page` (number)
    Indica a quantidade de itens por página.

  - `updated_from` (string)
    Filtra por dados que foram atualizadas a partir de uma data. (Formato: YYYY-MM-DDThh:mm:ss+hh:mm).

  - `deleted` (string)
    Filtro para indicar se deve retornar dados apagados ou não.
    Enum: "not_include", "include", "only"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.kds` (array)
    Representa uma lista KDS

  - `data.kds.id` (integer)
    Identificador único do KDS na CPlug.
    Example: 1

  - `data.kds.name` (string)
    Nome do KDS.
    Example: "KDS Cozinha"

  - `data.kds.is_active` (boolean)
    Identificador se o KDS está ativo.
    Example: true

  - `data.kds.is_expedition` (boolean)
    Identificador se a expedição está ativo.
    Example: true

  - `data.kds.time_for_alert` (integer)
    Tempo para alerta no KDS em minutos

Se informar um valor diferente de zero, o KDS vai mostrar em vermelho os pedidos que estão em atraso conforme configurado aqui.
    Example: 5

  - `data.kds.created_at` (string)
    Data da criação do estoque.
    Example: "2020-01-01T09:00:00-03:00"

  - `data.kds.updated_at` (string)
    Data da atualização do estoque.
    Example: "2020-01-01T09:00:00-03:00"

  - `meta` (object)
    Representa as informações de Metadado da paginação da listagem.

  - `meta.current_page` (integer, required)
    Página atual na paginação.
    Example: 1

  - `meta.last_page` (integer, required)
    Quantidade total de páginas.
    Example: 10

  - `meta.per_page` (integer, required)
    Quantidade de resultados por página.
    Example: 20

  - `meta.total` (integer, required)
    Quantidade total de itens.
    Example: 200

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields