get_user_list
This call is designed to help you quickly pull metadata for all of the users in your project.
Basic parameters
Name | Type | Required | Description |
action | string | true | get_user_list |
group_id | integer | true | This designates which project the action should be applied towards. |
doc | array | true | doc should either be an empty array or include one or more of the doc parameters below. |
Doc parameters
There are a few further options which allow you to control which users are included in the return.
Name | Type | Required | Description |
with_excluded | boolean | false | Will include users who have an excluding status applied to them. |
only_excluded | boolean | false | Will only return users who have an excluding status applied to them. |
only_parents | boolean | false | In a family system, this will only return the parent users. |
only_children | boolean | false | In a family system, this will only return the child users. |
starting_position | numeric | false | This allows you to specify at which position in the list of users you would like to begin the return. See the section on pagination more information on how to handle paginated returns. |
return_families | boolean | false | Each set of children will appear as an array within the parent level. The default output is separate arrays for parent and children. |
Example
Response
There are a few important things to note in the response. First, totals is providing you project level metadata about the users you have included in the return. Second, although you are limited to 50 users per page, this refers to the parent users in a family system. This means that if I have 50 parents in my system (i.e. they fit on one page), and between all of these parents they have 63 children, then there will be 113 total records in the return. The 50 parents would appear in the array users and the children would appear in the array children. Each child is connected to a parent by connected_to, for which the value is clogin_id for the parent. So in the output below, "Miles Davis Quintet" is the parent with "clogin_id": "102670540", and "Miles Davis" is the child with "connected_to": "102670540". Note that totals at the top is only returned if starting_position is not included in the call.
