Skip to main content

GET (/users//people/avoid)

Gets the Avoid list for a user.

Remarks

If a target is given, only returns that user if they’re on the block list, or else empty if they’re not.

URI parameters

Authorization

Authorization claims used | Claim| Type| Required?| Example value| | --- | --- | --- | --- | --- | --- | --- | | Xuid| 64-bit signed integer| yes| 1234567890|

Required Request Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Authorization | string| Authentication credentials for HTTP authentication. Example value: Xauth=<authtoken>. Maximum size: none.| | Accept| string| Content-Types that are acceptable. Example value: application/json. Maximum size: none.|

HTTP status codes

The service returns one of the status codes in this section in response to a request made with this method on this resource. For a complete list of standard HTTP status codes used with XBOX Live Services, see Standard HTTP status codes. | Code| Reason phrase| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 200| OK| The session was successfully retrieved.| | 400| Bad Request| The target ID specified in the URI is not valid.| | 403| Forbidden| The owner specified in the URI is not the authenticated user.| | 404| Not Found| The owner specified in the URI does not exist.|

Required Response Headers

| Header| Type| Description| | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | Content-Type| string| The MIME type of the body of the request. Example value: application/json. Maximum size: none.| | Content-Length| string| The number of bytes being sent in the response. Example value: 34. Maximum size: none.| | Cache-Control| string| Polite request from the server to specify caching behavior. Example value: application/json. Maximum size: none.|

Response body

Sample response

See also

Parent
/users//people/avoid
Last modified on August 20, 2026