Skip to main content
GET
Get Company Details
This endpoint provides comprehensive company information including business details, address, operational status, and the number of associated stores. It supports both retrieving all companies and fetching specific company details.

Get All Companies

Retrieves a list of all companies in the system with summary information including total counts.

Query Parameters

string
Specific company ID to retrieve details for a single company. If not provided, returns all companies.

Response - All Companies

number
Total number of stores across all companies
number
Total number of companies in the system
array
Array of company objects

Get Specific Company

When a company_id is provided, returns detailed information for that specific company.

Response - Single Company

Returns an array with a single company object containing the same structure as described above.

Response Examples

All Companies Response

Single Company Response

Usage Tips:
  • Use without parameters to get an overview of all companies and their store counts
  • Include company_id parameter to get detailed information for a specific company
  • The stores_count field helps you understand the scale of each company’s operations
  • point_of_contact field may be null if no contact person is assigned
Some companies may have null values for status or point_of_contact fields. Always check for null values when processing the response.