HeyReach icon

HeyReach

Interact with HeyReach API

List → Get Companies

AI-generated

Summary

Retrieve a list of companies associated with a specified list ID.

Inputs

  • listId (required) — The ID of the list to get companies from.
  • returnAll — Whether to return all results or only up to a given limit.
  • limit — Max number of results to return, applicable only if 'returnAll' is false.

Output shape

a list of companies

Returns all companies if 'returnAll' is true; otherwise, it returns up to the specified 'limit'. If no companies are found, an empty array is returned.

Examples

Example 1: Get all companies associated with a specific list.

Set 'listId' to the desired list's ID and 'returnAll' to true.

Discussion