> ## Documentation Index > Fetch the complete documentation index at: https://x-preview-mintlify-066e8699.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Namespace: Users > Reference for the Users module in the X API TypeScript SDK. Re-exported clients, types, and utilities provided by this SDK module for the X API v2. ## References ### MuteUserRequest Re-exports [MuteUserRequest](/xdks/typescript/reference/interfaces/Schemas.MuteUserRequest) ## Type Aliases ### GetByUsernamesResponse Ƭ **GetByUsernamesResponse**: [`Get2UsersByResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersByResponse) Response for getByUsernames #### Defined in [users/models.ts:18](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L18) *** ### GetRepostsOfMeResponse Ƭ **GetRepostsOfMeResponse**: [`Get2UsersRepostsOfMeResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersRepostsOfMeResponse) Response for getRepostsOfMe #### Defined in [users/models.ts:24](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L24) *** ### UnlikePostResponse Ƭ **UnlikePostResponse**: [`UsersLikesDeleteResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersLikesDeleteResponse) Response for unlikePost #### Defined in [users/models.ts:30](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L30) *** ### GetBookmarksResponse Ƭ **GetBookmarksResponse**: [`Get2UsersIdBookmarksResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdBookmarksResponse) Response for getBookmarks #### Defined in [users/models.ts:36](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L36) *** ### CreateBookmarkRequest Ƭ **CreateBookmarkRequest**: [`BookmarkAddRequest`](/xdks/typescript/reference/interfaces/Schemas.BookmarkAddRequest) Request for createBookmark #### Defined in [users/models.ts:42](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L42) *** ### CreateBookmarkResponse Ƭ **CreateBookmarkResponse**: [`BookmarkMutationResponse`](/xdks/typescript/reference/interfaces/Schemas.BookmarkMutationResponse) Response for createBookmark #### Defined in [users/models.ts:48](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L48) *** ### GetFollowersResponse Ƭ **GetFollowersResponse**: [`Get2UsersIdFollowersResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdFollowersResponse) Response for getFollowers #### Defined in [users/models.ts:54](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L54) *** ### UnpinListResponse Ƭ **UnpinListResponse**: [`ListUnpinResponse`](/xdks/typescript/reference/interfaces/Schemas.ListUnpinResponse) Response for unpinList #### Defined in [users/models.ts:60](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L60) *** ### GetByIdResponse Ƭ **GetByIdResponse**: [`Get2UsersIdResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdResponse) Response for getById #### Defined in [users/models.ts:66](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L66) *** ### GetMentionsResponse Ƭ **GetMentionsResponse**: [`Get2UsersIdMentionsResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdMentionsResponse) Response for getMentions #### Defined in [users/models.ts:72](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L72) *** ### UnrepostPostResponse Ƭ **UnrepostPostResponse**: [`UsersRetweetsDeleteResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersRetweetsDeleteResponse) Response for unrepostPost #### Defined in [users/models.ts:78](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L78) *** ### DeleteBookmarkResponse Ƭ **DeleteBookmarkResponse**: [`BookmarkMutationResponse`](/xdks/typescript/reference/interfaces/Schemas.BookmarkMutationResponse) Response for deleteBookmark #### Defined in [users/models.ts:84](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L84) *** ### UnfollowListResponse Ƭ **UnfollowListResponse**: [`ListFollowedResponse`](/xdks/typescript/reference/interfaces/Schemas.ListFollowedResponse) Response for unfollowList #### Defined in [users/models.ts:90](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L90) *** ### UnmuteUserResponse Ƭ **UnmuteUserResponse**: [`MuteUserMutationResponse`](/xdks/typescript/reference/interfaces/Schemas.MuteUserMutationResponse) Response for unmuteUser #### Defined in [users/models.ts:96](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L96) *** ### GetMeResponse Ƭ **GetMeResponse**: [`Get2UsersMeResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersMeResponse) Response for getMe #### Defined in [users/models.ts:102](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L102) *** ### GetMutingResponse Ƭ **GetMutingResponse**: [`Get2UsersIdMutingResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdMutingResponse) Response for getMuting #### Defined in [users/models.ts:108](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L108) *** ### MuteUserResponse Ƭ **MuteUserResponse**: [`MuteUserMutationResponse`](/xdks/typescript/reference/interfaces/Schemas.MuteUserMutationResponse) Response for muteUser #### Defined in [users/models.ts:121](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L121) *** ### SearchResponse Ƭ **SearchResponse**: [`Get2UsersSearchResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersSearchResponse) Response for search #### Defined in [users/models.ts:127](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L127) *** ### GetBlockingResponse Ƭ **GetBlockingResponse**: [`Get2UsersIdBlockingResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdBlockingResponse) Response for getBlocking #### Defined in [users/models.ts:133](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L133) *** ### GetByIdsResponse Ƭ **GetByIdsResponse**: [`Get2UsersResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersResponse) Response for getByIds #### Defined in [users/models.ts:139](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L139) *** ### GetFollowingResponse Ƭ **GetFollowingResponse**: [`Get2UsersIdFollowingResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdFollowingResponse) Response for getFollowing #### Defined in [users/models.ts:145](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L145) *** ### FollowUserRequest Ƭ **FollowUserRequest**: [`UsersFollowingCreateRequest`](/xdks/typescript/reference/interfaces/Schemas.UsersFollowingCreateRequest) Request for followUser #### Defined in [users/models.ts:151](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L151) *** ### FollowUserResponse Ƭ **FollowUserResponse**: [`UsersFollowingCreateResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersFollowingCreateResponse) Response for followUser #### Defined in [users/models.ts:157](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L157) *** ### LikePostRequest Ƭ **LikePostRequest**: [`UsersLikesCreateRequest`](/xdks/typescript/reference/interfaces/Schemas.UsersLikesCreateRequest) Request for likePost #### Defined in [users/models.ts:163](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L163) *** ### LikePostResponse Ƭ **LikePostResponse**: [`UsersLikesCreateResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersLikesCreateResponse) Response for likePost #### Defined in [users/models.ts:169](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L169) *** ### GetLikedPostsResponse Ƭ **GetLikedPostsResponse**: [`Get2UsersIdLikedTweetsResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdLikedTweetsResponse) Response for getLikedPosts #### Defined in [users/models.ts:175](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L175) *** ### GetPostsResponse Ƭ **GetPostsResponse**: [`Get2UsersIdTweetsResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdTweetsResponse) Response for getPosts #### Defined in [users/models.ts:181](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L181) *** ### BlockDmsResponse Ƭ **BlockDmsResponse**: [`UsersDMBlockCreateResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersDMBlockCreateResponse) Response for blockDms #### Defined in [users/models.ts:187](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L187) *** ### GetListMembershipsResponse Ƭ **GetListMembershipsResponse**: [`Get2UsersIdListMembershipsResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdListMembershipsResponse) Response for getListMemberships #### Defined in [users/models.ts:193](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L193) *** ### GetPinnedListsResponse Ƭ **GetPinnedListsResponse**: [`Get2UsersIdPinnedListsResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdPinnedListsResponse) Response for getPinnedLists #### Defined in [users/models.ts:199](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L199) *** ### PinListRequest Ƭ **PinListRequest**: [`ListPinnedRequest`](/xdks/typescript/reference/interfaces/Schemas.ListPinnedRequest) Request for pinList #### Defined in [users/models.ts:205](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L205) *** ### PinListResponse Ƭ **PinListResponse**: [`ListPinnedResponse`](/xdks/typescript/reference/interfaces/Schemas.ListPinnedResponse) Response for pinList #### Defined in [users/models.ts:211](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L211) *** ### GetByUsernameResponse Ƭ **GetByUsernameResponse**: [`Get2UsersByUsernameUsernameResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersByUsernameUsernameResponse) Response for getByUsername #### Defined in [users/models.ts:217](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L217) *** ### UnfollowUserResponse Ƭ **UnfollowUserResponse**: [`UsersFollowingDeleteResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersFollowingDeleteResponse) Response for unfollowUser #### Defined in [users/models.ts:223](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L223) *** ### GetTimelineResponse Ƭ **GetTimelineResponse**: [`Get2UsersIdTimelinesReverseChronologicalResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdTimelinesReverseChronologicalResponse) Response for getTimeline #### Defined in [users/models.ts:229](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L229) *** ### GetFollowedListsResponse Ƭ **GetFollowedListsResponse**: [`Get2UsersIdFollowedListsResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdFollowedListsResponse) Response for getFollowedLists #### Defined in [users/models.ts:235](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L235) *** ### FollowListRequest Ƭ **FollowListRequest**: [`ListFollowedRequest`](/xdks/typescript/reference/interfaces/Schemas.ListFollowedRequest) Request for followList #### Defined in [users/models.ts:241](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L241) *** ### FollowListResponse Ƭ **FollowListResponse**: [`ListFollowedResponse`](/xdks/typescript/reference/interfaces/Schemas.ListFollowedResponse) Response for followList #### Defined in [users/models.ts:247](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L247) *** ### UnblockDmsResponse Ƭ **UnblockDmsResponse**: [`UsersDMUnBlockCreateResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersDMUnBlockCreateResponse) Response for unblockDms #### Defined in [users/models.ts:253](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L253) *** ### RepostPostRequest Ƭ **RepostPostRequest**: [`UsersRetweetsCreateRequest`](/xdks/typescript/reference/interfaces/Schemas.UsersRetweetsCreateRequest) Request for repostPost #### Defined in [users/models.ts:259](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L259) *** ### RepostPostResponse Ƭ **RepostPostResponse**: [`UsersRetweetsCreateResponse`](/xdks/typescript/reference/interfaces/Schemas.UsersRetweetsCreateResponse) Response for repostPost #### Defined in [users/models.ts:265](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L265) *** ### GetBookmarkFoldersResponse Ƭ **GetBookmarkFoldersResponse**: [`BookmarkFoldersResponse`](/xdks/typescript/reference/interfaces/Schemas.BookmarkFoldersResponse) Response for getBookmarkFolders #### Defined in [users/models.ts:271](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L271) *** ### GetOwnedListsResponse Ƭ **GetOwnedListsResponse**: [`Get2UsersIdOwnedListsResponse`](/xdks/typescript/reference/interfaces/Schemas.Get2UsersIdOwnedListsResponse) Response for getOwnedLists #### Defined in [users/models.ts:277](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L277) *** ### GetBookmarksByFolderIdResponse Ƭ **GetBookmarksByFolderIdResponse**: [`BookmarkFolderPostsResponse`](/xdks/typescript/reference/interfaces/Schemas.BookmarkFolderPostsResponse) Response for getBookmarksByFolderId #### Defined in [users/models.ts:283](https://github.com/xdevplatform/xdk-typescript/blob/81aacb165e0802e188f608bdf462b60fc4e713a2/src/users/models.ts#L283)