Skip to main content

companies

Search and retrieve companies with advanced filtering, sorting, and pagination capabilities.

Key Features:

  • Advanced filtering by business attributes, contact information, and organizational data
  • Flexible sorting options for business intelligence and reporting
  • Pagination support for large result sets
  • Federation support for cross-service data access

Business Rules:

  • Search results respect user permissions and access controls
  • Filtering supports multiple criteria with AND/OR logic
  • Sorting can be applied to multiple fields simultaneously
  • Pagination limits prevent system overload

Error Scenarios:

  • SEARCH_ERROR: When search parameters are invalid or system fails
  • ACCESS_DENIED_ERROR: When user lacks permission to search companies
  • VALIDATION_ERROR: When search criteria contain invalid values

Use Cases:

  • Business directory and company discovery
  • Reporting and analytics
  • Administrative management
  • Integration with other business systems

AUTH: Role=[user.OWNER,user.EDITOR,user.VIEWER]

companies(
input: CompanySearchArguments
): CompaniesResponse!

Arguments

companies.input ● CompanySearchArguments input

Search criteria and pagination options

Type

CompaniesResponse object