api.companies.search

POST /companies/search/v2 — ACPortal

Python

api.companies.search(*, data: CompanySearchRequest | dict) -> list[SearchCompanyResponse]

CLI

ab companies search [--data ...]

POST /companies/search/v2.

Args: data: Search filter with pagination, search text, and filters. Accepts a :class:CompanySearchRequest instance or a dict.

Request model: :class:CompanySearchRequest

Request body — CompanySearchRequest

Field	Type	Required	Description
searchText	Optional[str]	no	Free-text search query
page	Optional[int]	no	Page number (1-based)
pageSize	Optional[int]	no	Items per page
filters	Optional[dict]	no	Filter criteria

Response

Returns a list of List[SearchCompanyResponse].

Field	Type	Required	Description
id	Optional[str]	no	Company UUID
code	Optional[str]	no	Company code
companyName	Optional[str]	no	Full company name
name	Optional[str]	no	Company name
typeId	Optional[str]	no	Company type UUID
parentCompanyId	Optional[str]	no	Parent company UUID
companyType	Optional[str]	no	Company type

---

← Back to api.companies