# Lista de customizações

Retorna lista de customizações cadastradas.

Endpoint: GET /api/v3/customizations
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 da customização.
    Example: "Customização Promocional"

  - `type` (string)
    Filtra pelo tipo da customização.

- FULL_VIDEO: Vídeo em tela cheia
- BACK_VIDEO: Vídeo de fundo
- FULL_IMAGE: Imagem em tela cheia
- BACK_IMAGE: Imagem de fundo
- DYNAMIC_CATEGORY: Categoria dinâmica
    Enum: "FULL_VIDEO", "BACK_VIDEO", "FULL_IMAGE", "BACK_IMAGE", "DYNAMIC_CATEGORY"

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

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

  - `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.customizations` (array)
    Representa a lista de customizações.

  - `data.customizations.id` (integer)
    Identificador único da customização.
    Example: 123

  - `data.customizations.name` (string)
    Nome da customização.
    Example: "Customização Promocional"

  - `data.customizations.type` (string)
    Tipo da customização.

- FULL_VIDEO: Vídeo em tela cheia
- BACK_VIDEO: Vídeo de fundo
- FULL_IMAGE: Imagem em tela cheia
- BACK_IMAGE: Imagem de fundo
- DYNAMIC_CATEGORY: Categoria dinâmica
    Enum: "FULL_VIDEO", "BACK_VIDEO", "FULL_IMAGE", "BACK_IMAGE", "DYNAMIC_CATEGORY"

  - `data.customizations.transition` (null,string)
    Tipo de transição aplicada à customização.
Obrigatório para tipos FULL_IMAGE e BACK_IMAGE.

- FALL: Transição de queda
- SLIDE: Transição de deslizamento
- FADE: Transição de esmaecimento
    Enum: "FALL", "SLIDE", "FADE"

  - `data.customizations.medias` (array)
    Lista de mídias associadas à customização.

  - `data.customizations.medias.id` (integer)
    Identificador único da mídia.
    Example: 123

  - `data.customizations.medias.filename` (string)
    Nome do arquivo da mídia.
    Example: "customization_video.mp4"

  - `data.customizations.medias.type` (string)
    Tipo da mídia.

- IMAGE: Imagem (PNG, JPG, JPEG)
- VIDEO: Vídeo (MP4)
    Enum: "IMAGE", "VIDEO"

  - `data.customizations.medias.filesize` (integer)
    Tamanho do arquivo em bytes.
    Example: 1024000

  - `data.customizations.medias.url` (null,string)
    URL para acesso à mídia via CDN.
    Example: "https://cdn.example.com/customizations/customization_video.mp4"

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