IDB2B API icon

IDB2B API

AI Agents that turn conversations into customers for WhatsApp, Instagram & TikTok

Company → Get All

AI-generated

Summary

Retrieve a list of companies from the IDB2B API with optional pagination, field filtering, and additional query parameters.

Inputs

  • Limit — Maximum number of companies to return; defaults to 50 if not set.
  • Page — Page number to retrieve; defaults to 1 if not set.
  • Fields to Return — Choose specific company fields to include in the response; if left empty, all fields are returned.
  • Query Parameters — Add extra query parameters as key-value pairs to filter or modify the request.

Output shape

A single JSON object containing an array of company records under the data property, each record optionally filtered to contain only requested fields.

Supports pagination via limit and page parameters. When Fields to Return is specified, each company object in data will include only those fields. Additional query parameters allow further filtering or customization. Errors are returned with standardized messages if Continue On Fail is enabled; otherwise, errors raise exceptions to halt execution.

Examples

Example 1: Retrieve first 20 companies with only ID and Name fields

Set Limit to 20, leave Page at default 1, select ID and Name under Fields to Return.

Example 2: Fetch companies with a custom query parameter `industry_id`

Add a query parameter with name industry_id and the desired value to filter companies by industry.

Links

Discussion