@makehq/sdk
    Preparing search index...

    Type Alias ListCustomPropertyStructureItemsOptions<C>

    Options for listing custom property structure items.

    type ListCustomPropertyStructureItemsOptions<
        C extends Exclude<keyof CustomPropertyStructureItem, "options"> = never,
    > = {
        cols?: C[] | ["*"];
        description?: string;
        id?: number;
        label?: string;
        name?: string;
        pg?: Partial<Pagination<Omit<CustomPropertyStructureItem, "options">>>;
        required?: boolean;
        type?: CustomPropertyStructureItemType;
    }

    Type Parameters

    • C extends Exclude<keyof CustomPropertyStructureItem, "options"> = never

      Keys of the CustomPropertyStructureItem type to include in the response

    Index

    Properties

    cols? description? id? label? name? pg? required? type?

    Properties

    cols?: C[] | ["*"]

    Specific columns/fields to include in the response. options can't be selected here — PickColumns would incorrectly type it as always-present, when it's legitimately absent for non-dropdown/multiselect items; request ['*'] to get it.

    description?: string

    Filter items by description (matched as a case-insensitive regular expression by the API)

    id?: number

    Filter items by exact ID

    label?: string

    Filter items by label (matched as a case-insensitive regular expression by the API)

    name?: string

    Filter items by name (matched as a case-insensitive regular expression by the API)

    pg?: Partial<Pagination<Omit<CustomPropertyStructureItem, "options">>>

    Pagination options (the API does not support sorting by options)

    required?: boolean

    Filter items by whether they are required

    type?: CustomPropertyStructureItemType

    Filter items by exact data type

    Settings

    Member Visibility

    On This Page

    Properties