Como consultar¶

Esta página detalha os parâmetros de consulta disponíveis e o cabeçalho de otimização X-No-Total. Para os operadores de filtro (where), veja Filtros e operadores.

Parâmetros disponíveis¶

Parâmetro	Tipo	Descrição
`offset`	`integer`	Índice inicial para paginação.
`maxSize`	`integer`	Número máximo de registros retornados.
`select` ou `attributeSelect`	`string` ou `array`	Campos a serem retornados; ex.: `"id,name"` ou `["id","name"]`.
`orderBy`	`string`	Campo para ordenação.
`order`	`asc` \| `desc`	Ordem da listagem.
`where` ou `whereGroup`	`array`	Filtros complexos. Veja Filtros e operadores.

Montando o `searchParams`¶

A forma recomendada é enviar todos os parâmetros em um único searchParams — um JSON codificado na URL.

const searchParams = {
  maxSize: 50,                                    // (1)!
  offset: 0,                                      // (2)!
  select: ["modifiedAt", "name", "sicCode"],      // (3)!
  orderBy: "modifiedAt",                          // (4)!
  order: "desc",                                  // (5)!
  where: [                                        // (6)!
    { type: "startsWith", attribute: "sicCode", value: "123" }
  ]
};

const url =
  `https://integracao.gob.com.br/api/v1/Account` +
  `?searchParams=${encodeURIComponent(JSON.stringify(searchParams))}`;

Limita a no máximo 50 registros por página.
Começa do primeiro registro (índice 0).
Retorna apenas os campos indicados — respostas menores e mais rápidas.
Ordena pelo campo modifiedAt.
Em ordem decrescente (mais recentes primeiro).
Lista de filtros — veja todos os operadores em Filtros.

Sempre codifique o JSON

Use encodeURIComponent(JSON.stringify(...)) para garantir que o JSON seja transmitido corretamente na URL.

Paginação¶

Combine offset e maxSize para percorrer grandes conjuntos de dados.

Página	`offset`	`maxSize`
1ª	`0`	`50`
2ª	`50`	`50`
3ª	`100`	`50`

// Página N (base 1), com tamanho de página fixo
const pageSize = 50;
const page = 3;
const searchParams = { maxSize: pageSize, offset: (page - 1) * pageSize };

Selecionando campos¶

Reduza o tamanho da resposta retornando apenas os campos necessários:

Como arrayComo string

{ "select": ["id", "name", "modifiedAt"] }

{ "select": "id,name,modifiedAt" }

Ordenação¶

{ "orderBy": "modifiedAt", "order": "desc" }

`order`	Resultado
`asc`	Crescente (A → Z, mais antigo → mais novo)
`desc`	Decrescente (Z → A, mais novo → mais antigo)

Cabeçalho `X-No-Total`¶

Na listagem, adicione o cabeçalho:

X-No-Total: true

Acelere consultas em tabelas grandes

Esse cabeçalho evita o retorno do total de registros, acelerando consultas em tabelas grandes. A resposta deixa de calcular a contagem total e retorna apenas a lista.

Linux / macOSWindows (PowerShell)

curl -i -H "X-Api-Key: SUA_CHAVE_AQUI" \
     -H "X-No-Total: true" \
     "https://integracao.gob.com.br/api/v1/Account?searchParams=%7B%22maxSize%22%3A50%7D"

curl.exe -i -H "X-Api-Key: SUA_CHAVE_AQUI" `
         -H "X-No-Total: true" `
         "https://integracao.gob.com.br/api/v1/Account?searchParams=%7B%22maxSize%22%3A50%7D"