List Companies

GET /external/v1/external/v1/customers/companies

List companies with pagination, filtering, and search capabilities.

Parameters (Query)

Name	Type	Description	Default	Constraints / Values
page	integer	Page number for pagination.	1	Minimum: 1
page_size	integer	Items per page.	20	Minimum: 1, Maximum: 100
search	string	Search in name, email, or website.	null
status	string	Filter by company status.	null	active, prospect, on_hold, churned, lead, inactive
industry	string	Filter by industry.	null
sort_by	string	Field to sort by.	time_created
sort_order	string	Sort order.	desc	asc, desc

Successful Response (200)

{
  "data": [
    {
      "company_name": "string",
      "company_email": "[email protected]",
      "company_status": "active",
      "description": "string",
      "industry": "string",
      "website": "string",
      "phone": "string",
      "address": "string",
      "id": 0,
      "company_id": "string",
      "time_created": "2025-11-27T09:46:28.066Z",
      "time_updated": "2025-11-27T09:46:28.066Z",
      "organization_id": 0
    }
  ],
  "total": 0,
  "page": 0,
  "page_size": 0,
  "total_pages": 0,
  "has_next": true,
  "has_previous": true
}

Validation Error (422)

JSON

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}