# Lista de integrações

Retorna lista de integrações disponíveis no sistema e seu status para o usuário.

O sistema suporta múltiplos tipos de integração (delivery, tapp, ERP, general) com dezenas de fornecedores diferentes. Cada integração pode ter status ativo ou inativo conforme a configuração do usuário.

Endpoint: GET /api/v3/integrations
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 integração.
    Example: "Accon"

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

- delivery integrações de delivery (Epadoca, Delivery Direto, iFood, Rappi, etc.)
- tapp integrações de tapp/chopp (EasyChopp, Beerpass, ITap, Enjoy, etc.)
- general integrações gerais (Fidelidade, CRM & Bonus, Todo Cartões, etc.)
- erp integrações de ERP (Tray, etc.)
    Enum: "delivery", "tapp", "general", "erp"

  - `status` (string)
    Filtra pelo status da integração.

- active integração ativa
- inactive integração inativa
    Enum: "active", "inactive"

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

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

  - `data.integrations.id` (integer, required)
    Identificador único da integração.
    Example: 8

  - `data.integrations.name` (string, required)
    Nome da integração.
    Example: "Accon Delivery"

  - `data.integrations.key` (string, required)
    Chave identificadora da integração.
    Example: "accon_delivery"

  - `data.integrations.type` (string, required)
    Tipo da integração.

- delivery integração de delivery
- tapp integração de tapp
- general integração geral
- erp integração de ERP
    Enum: "delivery", "tapp", "general", "erp"

  - `data.integrations.image` (string, required)
    URL da imagem da integração
    Example: "https://images.connectplug.com.br/ifood-logo.png"

  - `data.integrations.status` (string, required)
    Status da integração.

- active integração ativa
- inactive integração inativa
    Enum: "active", "inactive"

  - `data.integrations.deleted` (boolean, required)
    Informa se o registro está excluído.

  - `data.integrations.created_at` (string, required)
    Data da última criação.
    Example: "2025-06-18T17:37:40.000000Z"

  - `data.integrations.updated_at` (string, required)
    Data da última atualização.
    Example: "2025-06-18T17:37:40.000000Z"

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