User Inventories: Retrieving a Complete List of Active Users


Follow

Overview

The User Management section is useful, intuitive, and easy to manage. The interface, however, limits the number of accounts displayed and restricts the ability to retrieve a full list of a large set of users. The purpose of this article, therefore, is to provide instructions for retrieving a full list of all active users for your account.

 


 

User List Retrieval Information

To get a list of all active users for your account, you can use the FogBugz API List People option described in the Manuscript API website. This endpoint allows you to list users from the site, and the relevant information is detailed below.

 

Query Parameters

 

Parameter Default Description
fIncludeActive 1 Set to 1 to include active users, 0 to exclude them
fIncludeNormal 1 Set to 1 to include normal users, 0 to exclude them
fIncludeDeleted 0 Set to 1 to include deleted users, 0 to exclude them
fIncludeCommunity 0 Set to 1 to include community users, 0 to exclude them
fIncludeVirtual 0 Set to 1 to include virtual users, 0 to exclude them
token (required) API token

 

HTTP Request

 

POST https://apisandbox.manuscript.com/api/listPeople
{
token: nqi9dvugilleed680nanjc0o3rc3iz
}

 

curl -X "POST" "https://apisandbox.manuscript.com/api/listPeople" \
-H "Content-Type: application/json; charset=utf-8" \
-d $'{
"token": "nqi9dvugilleed680nanjc0o3rc3iz"
}'

 

IMPORTANT: Please note that you must update the API POST URL to match your instance, and provide your API token.

Back to the top


 

Confirmation

The result is a JSON (JavaScript Object Notation) list of all active users for the associated FogBugz account.

 

360010433299-1.png

 

 Back to the top