Skip to main content

Documentation Index

Fetch the complete documentation index at: https://help.withallo.com/llms.txt

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

All list and search endpoints return paginated results.

Parameters

ParameterTypeDefaultMaxDescription
pageinteger1Page number (1-indexed)
sizeinteger20100Results per page
For GET endpoints, pass as query params. For POST search endpoints, include in the request body.

Response format

Every paginated response includes a pagination object:
{
  "data": [
    { "id": "cll_abc123", "type": "call", "..." : "..." },
    { "id": "msg_def456", "type": "sms", "..." : "..." }
  ],
  "pagination": {
    "page": 1,
    "size": 20,
    "total_count": 156,
    "total_pages": 8,
    "has_more": true
  }
}
FieldDescription
pageCurrent page number
sizeResults per page
total_countTotal matching results across all pages
total_pagesTotal number of pages
has_moretrue if there are more pages after this one

Iterating through pages

let page = 1;
let hasMore = true;

while (hasMore) {
  const response = await fetch(
    `https://api.withallo.com/v2/api/conversations?page=${page}&size=100`,
    { headers: { "Authorization": "Api-Key ak_live_your_key" } }
  );

  const { data, pagination } = await response.json();
  // Process data...

  hasMore = pagination.has_more;
  page++;
}