Querying for users

To retrieve information about a user, you can use the following endpoints:

• GET /admin/v1/users
• GET /admin/v1/users/{userId}

For example, the following is the snippet of the response payload when retrieving the information for user bc:SwJl9CwZJ3GJj_mvArObi (Aaron Applegate).

GET /admin/v1/users/bc:SwJl9CwZJ3GJj_mvArObi

{
    "data": {
        "attributes": {
            "active": true,
            "cellPhone": {
                "countryCode": {
                    "code": "US",
                    "name": "United States (1)"
                },
                "displayName": "650-333-3333",
                "number": "6503333333"
            },
            "displayName": "Aaron Applegate",
            "externalUser": false,
            "firstName": "Aaron",
            "id": "bc:SwJl9CwZJ3GJj_mvArObi",
            "lastName": "Applegate",
            "roles": [
                {
                    "displayName": "All Permissions (Deprecated)",
                    "id": "superuser",
                    "type": "Role"
                }
            ],
            "username": "aapplegate",
            "vacationStatus": {
                "code": "atwork",
                "name": "At work"
            },
            "workPhone": {
                "displayName": "213-555-8164",
                "number": "2135558164"
            }
        }
    }
}