Para as requisições de listagem, trabalhamos com uma estrutura padrão de resposta que é a seguinte:

JSON

{
    "data": [
        {}, {}, ... // Objetos retornados
    ],
    "limit": 100,
    "start": 0,
    "size": 100,
    "parameters": {},
    "next": "/v2/leads?limit=100&start=100"
}

Estrutura da resposta:

  • data: lista com os objetos retornados de acordo com a requisição
  • limit: limite de objetos por requisição
  • start: início do ponteiro da paginação (veja mais em Paginação)
  • size: tamanho da lista retornada
  • parameters: parâmetros enviados na requisição
  • next: endereço para a requisição da próxima página de resultados. Se não houver próxima página de resultados o valor virá null.