# Lista de etiquetas

Retorna lista de etiquetas para impressão.

Endpoint: GET /api/v3/labels
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)
    Filtro pelo nome da etiqueta.
    Example: "Etiqueta Produtos"

  - `type` (string)
    Filtra pelo tipo de etiqueta.

- PDF: Etiqueta em formato PDF.
- PPLA: Etiqueta em formato PPLA (linguagem de impressora).
- BPLB: Etiqueta em formato BPLB (linguagem de impressora).
    Enum: "PDF", "PPLA", "BPLB"

  - `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.labels` (array)
    Representa a lista de etiquetas

  - `data.labels.id` (integer)
    Identificador único da etiqueta.
    Example: 123

  - `data.labels.name` (string)
    Nome da etiqueta.
    Example: "Etiqueta Produtos"

  - `data.labels.code` (string)
    Código identificador da etiqueta.
    Example: "ETQ001"

  - `data.labels.type` (string)
    Tipo da etiqueta.

- PDF: Etiqueta em formato PDF.
- PPLA: Etiqueta em formato PPLA (linguagem de impressora).
- BPLB: Etiqueta em formato BPLB (linguagem de impressora).
    Enum: "PDF", "PPLA", "BPLB"

  - `data.labels.sheet_width` (number)
    Largura da folha da etiqueta em milímetros.
    Example: 210

  - `data.labels.sheet_height` (number)
    Altura da folha da etiqueta em milímetros.
    Example: 297

  - `data.labels.columns_amount` (integer)
    Quantidade de colunas na etiqueta.
    Example: 3

  - `data.labels.row_amount` (integer)
    Quantidade de linhas na etiqueta.
    Example: 8

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