Pesquisa formatada por scope (CRMSearchResult)

GET

/api/v2/crm/data_imports/scope/{scope_type}/formatted

Pesquisa em texto livre dentro de um scope (customer / contact / business / catalog)
retornando os dados no formato CRMSearchResult — já paginado, já mapeado pra colunas
com label + type + value pronto pra renderização.

Diferente de POST /api/v2/crm/data/filter (que retorna array nu de campos brutos),
este vem estruturado em torno do template — útil pra telas que precisam exibir
cada campo com seu label e tipo correto sem ter que cruzar com o template separadamente.

Path param

{scope_type}: customer | contact | business | catalog

Query params

search (opcional): termo de busca — pode ser nome, CPF, CNPJ

page: número da página (a partir de qual valor depende do tenant)

size: limite de resultados por página

Requisição

Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢200OK

application/json

Estrutura CRMSearchResult — dados já formatados pelo template.

Bodyapplication/json

🟠401Não Autorizado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v2/crm/data_imports/scope/customer/formatted?search=marcus&page=1&size=20' \
--header 'api-key: {{api-key}}'

Response Example

200 - Exemplo de Sucesso

{
    "scope": "customer",
    "principal_table": "cliente",
    "template": {
        "id": "26cd301a-5c82-468b-9c23-af3c915d9720",
        "name": "Cliente",
        "table_name": "cliente"
    },
    "data": [
        [
            {
                "column": "id",
                "label": "ID",
                "type": "auto_increment",
                "field_type": "simple",
                "icon": "",
                "key": true,
                "visible": true,
                "required": true,
                "foreign_key": false,
                "value": 1
            },
            {
                "column": "nome",
                "label": "Nome",
                "type": "customer_name",
                "field_type": "simple",
                "icon": "",
                "key": false,
                "visible": true,
                "required": false,
                "foreign_key": false,
                "value": "Marcus"
            },
            {
                "column": "cpf_cnpj",
                "label": "CPF/CNPJ",
                "type": "customer_cpfcnpj",
                "field_type": "simple",
                "icon": "",
                "key": false,
                "visible": true,
                "required": true,
                "foreign_key": false,
                "value": "35191550870"
            }
        ]
    ],
    "pagination": {
        "last_page": 3,
        "first_page": 1,
        "current_page": 1,
        "page_size": 20,
        "total_rows": 42
    }
}

Modificado em 2026-11-04 02:31:07

Página anterior

Detalhe completo do template (com fields)

Próxima página

Listar tipos de relacionamento

Pesquisa formatada por scope (CRMSearchResult)

Path param#

Query params#

Requisição

Respostas

Path param

Query params