Skip to content

SearchUsersResponse

Source code in docs_src/capo_connect/types/search_users_response.py
class SearchUsersResponse(TypedDict, closed=True):
    users: NotRequired[
        "capo_connect.types.user_search_summary_list.UserSearchSummaryList"
    ]
    """<p>Information about the users.</p>"""
    next_token: NotRequired["capo_connect.types.next_token2500.NextToken2500"]
    """<p>If there are additional results, this is the token for the next set of results.</p>"""
    approximate_total_count: NotRequired[
        "capo_connect.types.approximate_total_count.ApproximateTotalCount"
    ]
    """<p>The total number of users who matched your search query.</p>"""

approximate_total_count instance-attribute

approximate_total_count: NotRequired[ApproximateTotalCount]

The total number of users who matched your search query.

next_token instance-attribute

next_token: NotRequired[NextToken2500]

If there are additional results, this is the token for the next set of results.

users instance-attribute

users: NotRequired[UserSearchSummaryList]

Information about the users.