Type Alias GetInstalledLocationsParams

GetInstalledLocationsParams: {
    companyId: string;
    appId: string;
    isInstalled?: boolean;
    limit?: string;
    onTrial?: boolean;
    planId?: string;
    query?: string;
    skip?: string;
}

Type declaration

  • companyId: string

    Filters out location which are installed for specified app under the specified companyId

    Example

    true
  • appId: string

    Parameter to search by the appId

    Example

    tDtDnQdgm2LXpyiqYvZ6
  • OptionalisInstalled?: boolean

    Filters out location which are installed for specified app under the specified company

    Example

    true
  • Optionallimit?: string

    Parameter to limit the number installed locations

    Example

    10

    Default

    20
  • OptionalonTrial?: boolean

    Filters out locations which are installed for specified app in trial mode

    Example

    true
  • OptionalplanId?: string

    Filters out location which are installed for specified app under the specified planId

    Example

    true
  • Optionalquery?: string

    Parameter to search for the installed location by name

    Example

    location name
  • Optionalskip?: string

    Parameter to skip the number installed locations

    Example

    1

    Default

    0

Settings

Member Visibility