Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt

Use this file to discover all available pages before exploring further.

Todos os endpoints de listagem na Vendaze API retornam resultados paginados. Nenhum endpoint retorna uma lista ilimitada de registros.

Como funciona

Use os parâmetros page e per_page para navegar pelos resultados:
GET /v1/people?page=1&per_page=50
GET /v1/people?page=2&per_page=50

Metadados de paginação

Toda resposta de listagem inclui um objeto meta:
{
  "data": [ ... ],
  "meta": {
    "total": 234,
    "page": 2,
    "per_page": 50,
    "has_more": true
  }
}
CampoDescrição
totalTotal de registros que correspondem aos filtros atuais.
pageNúmero da página atual.
per_pageNúmero de registros por página.
has_moretrue se existem mais páginas após esta.

Parâmetros disponíveis

ParâmetroTipoPadrãoMáximoDescrição
pageinteger1-Número da página a buscar.
per_pageinteger50100Registros por página. Retorna 422 se acima de 100.
order_bystringcreated_at-Campo de ordenação.
orderstringdesc-asc ou desc.

Buscar todos os registros

Para recuperar todos os registros, itere pelas páginas até has_more ser false:
async function fetchAll(endpoint, accessToken) {
  const results = [];
  let page = 1;

  while (true) {
    const res = await fetch(`https://api.vendaze.com${endpoint}?page=${page}&per_page=100`, {
      headers: { Authorization: `Bearer ${accessToken}` },
    });
    const { data, meta } = await res.json();
    results.push(...data);
    if (!meta.has_more) break;
    page++;
  }

  return results;
}
Fique atento aos limites de taxa ao iterar sobre grandes datasets. Use filtros para estreitar o conjunto de resultados quando possível.

Ordenação disponível por recurso

RecursoCampos de ordenação
Peoplecreated_at, updated_at, full_name
Companiescreated_at, updated_at, full_name
Dealscreated_at, updated_at, name, price_cts
Taskscreated_at, updated_at, due_date
Activitiescreated_at
Productscreated_at, name