companies
List companies for this workspace with filtering and conformity context, newest first.
Each row is a Company. Use companyDetail for one
record, companyCounts for aggregate counts, or
companiesAdd to create one.
Auth · x-app-token · required permission showCompanies
Related: companyDetail, companyCounts, companiesAdd, Authentication
companies(page: Int, perPage: Int, tag: String, ids: [String], excludeIds: Boolean, searchValue: String, autoCompletion: Boolean, autoCompletionType: String, sortField: String, sortDirection: SortDirection, dateFilters: String, conformityMainType: String, conformityMainTypeId: String, conformityRelType: String, conformityIsRelated: Boolean, conformityIsSaved: Boolean): CompaniesListResponseArguments
1-based page index. Default: 1. See Pagination.
Page size. Default: 20. See Pagination.
Filter by Tag id — only companies carrying that tag.
Restrict results to these specific company ids.
When true, invert ids to exclude those companies instead of including them.
Case-insensitive partial match across name/email/phone fields.
When true, run a lighter-weight query suited for search-as-you-type UIs.
Field to autocomplete against when autoCompletion is true.
Field name to sort by.
Sort direction paired with sortField.
Additional date-range filters as a JSON-encoded string.
Content type owning the relation (e.g. "customer"). Used with conformityMainTypeId to scope results to companies related to a Customer or other entity.
Id of the related record identified by conformityMainType.
Content type on this side of the relation (defaults to "company").
When true, only return companies related to the given main type/id.
When true, only return companies already saved against the relation.
Returns
Standard pagination metadata: totalCount, currentPage, totalPages,
hasNextPage, hasPreviousPage, perPage.