getListMembers(for_fields_expansions_paginationToken_maxResults_) - daneden/Twift GitHub Wiki

getListMembers(for:fields:expansions:paginationToken:maxResults:)

Returns a list of users who are members of the specified List.

public func getListMembers(for listId: List.ID,
                             fields: Set<User.Field> = [],
                             expansions: [User.Expansions] = [],
                             paginationToken: String? = nil,
                             maxResults: Int = 100
  )

Equivalent to GET /2/lists/:list_id/members

Parameters

  • listId: The ID of the List whose members you would like to retrieve.
  • fields: Any additional fields to include on returned objects
  • expansions: Objects and their corresponding fields that should be expanded in the includes property
  • paginationToken: When iterating over pages of results, you can pass in the nextToken from the previously-returned value to get the next page of results
  • maxResults: The maximum number of results to fetch.

Returns

A response object containing an array of Users who are members of the target list, any requested expansions, and a meta object with pagination tokens.

⚠️ **GitHub.com Fallback** ⚠️