@izak0s/spacebring-api - v7.1.0
    Preparing search index...

    Interface GetMembershipsQuery

    Query parameters for sb.community.memberships.list().

    interface GetMembershipsQuery {
        companyRef?: string;
        locationRef: string;
        limit?: number;
        nextPageToken?: string;
        userEmail?: string;
        userRef?: string;
        status?: "requested";
        types?: "member" | "nonmember";
    }
    Index
    companyRef? locationRef limit? nextPageToken? userEmail? userRef? status? types?
    companyRef?: string

    Filter by company reference

    locationRef: string

    The id of the location.

    limit?: number

    The number of items to return

    nextPageToken?: string

    Token to retrieve the next page of results.

    userEmail?: string

    Filter by user's email

    userRef?: string

    The id of the user

    status?: "requested"

    use requested to get all membership requests

    types?: "member" | "nonmember"

    Filter by types. Pass them as comma separated values.

    Settings
    Member Visibility

    On This Page
    Properties