Trello.js - API library
    Preparing search index...

    Interface GetEnterprise

    interface GetEnterprise {
        fields?: string;
        id: string;
        member?: {
            count?: number;
            fields?: "username" | "avatarHash" | "fullName" | "initials";
            filter?: string;
            sort?: string;
            startIndex?: number;
        };
        memberCount?: number;
        memberFields?: string;
        memberFilter?: string;
        members?: string;
        memberSort?: string;
        memberSortBy?: string;
        memberSortOrder?: string;
        memberStartIndex?: number;
        organization?: {
            fields?: string;
            memberships?: | "normal"
            | "active"
            | "me"
            | "admin"
            | "deactivated"
            | ("normal" | "active" | "me" | "admin" | "deactivated")[];
            paidAccounts?: boolean;
        };
        organizationFields?: string;
        organizationMemberships?: string;
        organizationPaidAccounts?: boolean;
        organizations?: string;
    }
    Index

    Properties

    fields? id member? memberCount? memberFields? memberFilter? members? memberSort? memberSortBy? memberSortOrder? memberStartIndex? organization? organizationFields? organizationMemberships? organizationPaidAccounts? organizations?

    Properties

    fields?: string

    Comma-separated list of: id, name, displayName, prefs, ssoActivationFailed, idAdmins, idMembers (Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data. Read the SCIM documentation here for more information on filtering), idOrganizations, products, userTypes, idMembers, idOrganizations

    id: string

    ID of the enterprise to retrieve.

    member?: {
        count?: number;
        fields?: "username" | "avatarHash" | "fullName" | "initials";
        filter?: string;
        sort?: string;
        startIndex?: number;
    }

    Type declaration

    • Optionalcount?: number

      0 to 100

    • Optionalfields?: "username" | "avatarHash" | "fullName" | "initials"

      One of: avatarHash, fullName, initials, username

    • Optionalfilter?: string

      Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the member_* args are set, the member array will be paginated.

    • Optionalsort?: string

      This parameter expects a SCIM-style sorting value prefixed by a - to sort descending. If no - is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.

    • OptionalstartIndex?: number

      Any integer between 0 and 100.

    memberCount?: number

    Use member.count instead.

    0 to 100

    memberFields?: string

    Use member.fields instead.

    One of: avatarHash, fullName, initials, username

    memberFilter?: string

    Use member.filter instead.

    Pass a SCIM-style query to filter members. This takes precedence over the all/normal/admins value of members. If any of the member_* args are set, the member array will be paginated.

    members?: string

    One of: none, normal, admins, owners, all

    memberSort?: string

    Use member.sort instead.

    This parameter expects a SCIM-style sorting value prefixed by a - to sort descending. If no - is prefixed, it will be sorted ascending. Note that the members array returned will be paginated if members is 'normal' or 'admins'. Pagination can be controlled with member_startIndex, etc, but the API response will not contain the total available result count or pagination status data.

    memberSortBy?: string

    Deprecated: Please use member_sort. This parameter expects a SCIM-style sorting value. Note that the members array returned will be paginated if members is normal or admins. Pagination can be controlled with member_startIndex, etc, and the API response's header will contain the total count and pagination state.

    memberSortOrder?: string

    Deprecated: Please use member_sort. One of: ascending, descending, asc, desc

    memberStartIndex?: number

    Use member.startIndex instead.

    Any integer between 0 and 100.

    organization?: {
        fields?: string;
        memberships?:
            | "normal"
            | "active"
            | "me"
            | "admin"
            | "deactivated"
            | ("normal" | "active" | "me" | "admin" | "deactivated")[];
        paidAccounts?: boolean;
    }

    Type declaration

    • Optionalfields?: string

      Any valid value that the nested organization field resource accepts.

    • Optionalmemberships?:
          | "normal"
          | "active"
          | "me"
          | "admin"
          | "deactivated"
          | ("normal" | "active" | "me" | "admin" | "deactivated")[]

      Comma-seperated list of: me, normal, admin, active, deactivated

    • OptionalpaidAccounts?: boolean
    organizationFields?: string

    Use organization.fields instead.

    Any valid value that the nested organization field resource accepts.

    organizationMemberships?: string

    Use organization.memberships instead.

    Comma-seperated list of: me, normal, admin, active, deactivated

    organizationPaidAccounts?: boolean

    Use organization.paidAccount instead.

    organizations?: string

    One of: none, members, public, all

    Settings

    Member Visibility

    On This Page

    Properties