`api.companies.list`

POST /companies/list — ACPortal

Python

api.companies.list(*, data: ListRequest | dict) -> list[CompanySimple]

CLI

ab companies list [--data ...]

POST /companies/list.

Args: data: List filter with pagination, sorting, and filters. Accepts a :class:ListRequest instance or a dict.

Request model: :class:ListRequest

Request body — `ListRequest`

Field	Type	Required	Description
`sortBy`	`Optional[str]`	no	Field name to sort by
`sortDir`	`Optional[bool]`	no	Sort direction (true=ascending)
`page`	`Optional[int]`	no	Page number (1-based)
`pageSize`	`Optional[int]`	no	Items per page
`filters`	`Optional[dict]`	no	Filter criteria

Returns a list of List[CompanySimple].

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