# Lista de aplicativos

Retorna lista dos aplicativos disponíveis.

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

  - `apps_id` (number)
    Filtra pelos IDs dos aplicativos. Pode passar mais de um ID numérico separado por virgula.
    Example: 123

  - `name` (string)
    Filtra pelo nome do aplicativo.
    Example: "App Name"

  - `type` (string)
    Filtra pelo tipo do aplicativo.
    Enum: "totem", "terminal", "server", "ordersheet-check", "pos-a", "mobile-app", "store", "digital-menu"

  - `filter_type` (string)
    Define o tipo de filtro aplicado no type.

- only: Retorna apenas os aplicativos que possuem o tipo informado.
- not_include: Retorna os aplicativos que não possuem o tipo informado.

Default: only
    Enum: "only", "not_include"

  - `search` (string)
    Filtra pelo nome, tipo ou nome do terminal ou nome do aparelho.
    Example: "PDV00001"

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

## Response 200 fields (application/json):

  - `data` (object)

  - `data.apps` (array)
    Representa a lista de aplicativos

  - `data.apps.id` (integer)
    Identificador único do aplicativo.
    Example: 123

  - `data.apps.name` (string, required)
    Nome do aplicativo.
    Example: "Totem"

  - `data.apps.type` (string)
    Tipo do aplicativo.
    Enum: "totem", "terminal", "server", "ordersheet-check", "pos-a", "mobile-app", "store", "digital-menu"

  - `data.apps.image_url` (null,string)
    URL da imagem principal do aplicativo. Essa imagem é utilizada como Logo do aplicativo.
    Example: "https://images.connectplug.com.br/4f01c1252eea.jpg"

  - `data.apps.domain` (null,string)
    Domínio do aplicativo. Válido apenas para aplicativos tipo store.
    Example: "minhaloja.connectplug.com.br"

  - `data.apps.settings` (any)

  - `data.apps.categories` (array)
    Categorias vinculadas no Aplicativo

  - `data.apps.categories.category` (object)
    Categoria vinculada com o Aplicativo.

  - `data.apps.categories.category.id` (integer)
    Id da categoria vinculada com o Aplicativo.
    Example: 1

  - `data.apps.categories.category.name` (string)
    Nome da categoria vinculada com o Aplicativo.
    Example: "Categoria 1"

  - `data.apps.categories.category.subcategories` (array)
    Categorias vinculadas no Aplicativo

  - `data.apps.categories.preparation_time` (integer)
    Tempo adicional em minutos para o preparo de items desta categoria. Esse valor será adicionado ao tempo da área de entrega no caso de pedidos via Delivery.
    Example: 10

  - `data.apps.card_contracts` (array)
    Contrato de Cartão vinculado no Aplicativo

  - `data.apps.card_contracts.id` (integer)
    Id do contrato de cartão
    Example: 1

  - `data.apps.card_contracts.title` (string)
    Titulo do Contrato de Cartão.
    Example: "Cielo"

  - `data.apps.card_contracts.code` (string,null)
    Código do Contrato
    Example: "CODE-1"

  - `data.apps.card_contracts.status` (string)
    Status do Contrato
    Example: "active"

  - `data.apps.terminal` (null,string)
    Nome do terminal.
    Example: "PDV00001"

  - `data.apps.device` (null,object)

  - `data.apps.device.model` (string)
    Modelo do aparelho.
    Example: "iPhone 13"

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