Skip to main content

CompanySearchArguments

Search criteria for filtering companies.

Provides flexible filtering options for company searches including organizational hierarchy, name matching, and access control based on user permissions.

input CompanySearchArguments {
companyIds: [Int!]
usergroupId: Int
name: String
managedCompaniesOnly: Boolean
page: Int!
offset: Int!
sort: [CompanySortInput!]
lastModifiedAt: DateSearchInput
createdAt: DateSearchInput
}

Fields

CompanySearchArguments.companyIds ● [Int!] list scalar

Filter by specific company identifiers.

Returns only companies whose IDs match the provided list. Useful for retrieving specific companies or bulk operations.

CompanySearchArguments.usergroupId ● Int scalar

Filter by parent usergroup identifier.

Returns only companies that belong to the specified usergroup in the organizational hierarchy.

CompanySearchArguments.name ● String scalar

Filter by company name.

Performs partial text matching on company names. Case-sensitive search that matches companies containing the provided text.

CompanySearchArguments.managedCompaniesOnly ● Boolean scalar

Restrict results to companies managed by the current user.

When true, returns only companies where the current user has management responsibilities. When false or not specified, returns all accessible companies based on permissions.

CompanySearchArguments.page ● Int! non-null scalar

Page number for pagination.

Specifies which page of results to return. Must be 1 or greater.

CompanySearchArguments.offset ● Int! non-null scalar

Number of items per page.

Controls how many companies are returned in each page. Must be between 1 and 100.

CompanySearchArguments.sort ● [CompanySortInput!] list input

Sorting configuration for the results.

List of sorting criteria to apply to the company results. Multiple sort fields can be specified to create complex sorting logic.

CompanySearchArguments.lastModifiedAt ● DateSearchInput input

Filter by last modification date range.

Allows filtering companies based on when they were last updated. Useful for finding recently modified companies or tracking changes.

CompanySearchArguments.createdAt ● DateSearchInput input

Filter by company creation date range.

Allows filtering companies based on when they were originally created. Useful for finding companies created within specific time periods.

Member Of

companies query