# Lista de periféricos

Retorna lista de periféricos.

Endpoint: GET /api/v3/peripherals
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:

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

  - `name` (string)
    Filtra pelo nome do periférico.
    Example: "Impressora 1"

  - `type` (string)
    Filtra pelo tipo do periférico.
    Example: "printer"

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

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

## Response 200 fields (application/json):

  - `data` (object)

  - `data.peripherals` (array)
    Representa a lista de periféricos

  - `data.peripherals.id` (integer)
    Identificador único do periférico.
    Example: 1

  - `data.peripherals.name` (string)
    Nome do periférico.
    Example: "Impressora 1"

  - `data.peripherals.manufacturer` (string)
    Marca do periférico.

Obrigatório caso seja passado um command_type em settings

Aceita apenas o encoded_name dos fabricantes listados no endpoint de [listagem de fabricantes](#tag/Peripherals/operation/get-peripherals-manufacturers)
    Example: "ELGIN"

  - `data.peripherals.model` (string)
    Nome do periférico no computador.
    Example: "ELGIN Model 404"

  - `data.peripherals.type` (string)
    Tipo do periférico.

Obrigatório caso seja passado um manufacturer

Caso passado um manufacturer, aceita apenas os types vinculados ao manufacturer listados no endpoint de [listagem de fabricantes](#tag/Peripherals/operation/get-peripherals-manufacturers)

- printer: Impressora.
- label_printer: Etiquetadora.
- scale: Balança.
- sat: SAT.
    Enum: "printer", "label_printer", "scale", "sat"

  - `data.peripherals.settings` (any)

  - `data.peripherals.server` (object)
    Configurações do servidor do periférico

  - `data.peripherals.server.ip` (string)
    Ip do servidor
    Example: "127.0.0.1"

  - `data.peripherals.server.port` (integer)
    Porta do servidor
    Example: 8080

  - `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