Share via

PeopleList (JSON)

Collection of Person objects.

PeopleList

The PeopleList object has the following specification.

Member Type Description
people array of Person The Person objects that make up the people list.
totalCount 32-bit unsigned integer Total number of Person objects available in the set. This value can be used by clients for paging because it represents the size of the whole set, not just the most recent response. Example value: 680.

Sample JSON syntax

{
    "people": [
        {
            "xuid": "2603643534573573",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573572",
            "isFavorite": true,
            "isFollowingCaller": false,
            "socialNetworks": ["LegacyXboxLive"]
        },
        {
            "xuid": "2603643534573577",
            "isFavorite": false,
            "isFollowingCaller": false
        },
    ],
    "totalCount": 3
}

See also

Parent

JavaScript Object Notation (JSON) Object Reference

Reference

GET (/users/{ownerId}/people)

POST (/users/{ownerId}/people/xuids)

  • Last updated on