Calls
User

get_user_list

7min

This call is designed to help you quickly pull data 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. Including fields in the doc will return these fields doc in addition to the metadata.

Doc parameters

There are also some 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.

Further Doc Parameters

Finally, the parameters below can be included in the doc on a get_user_list call. Doing so will return an additional nested doc in each user's metadata with the values requested.

Name

Type

Required

Description

_allfields

boolean

false

Returns all of the fields for the applicant, field_index (provides field metadata, see _allfields section for more), and an error section for incomplete fields.

fields

boolean

false

These are the fields present in your forms. They are referenced by field id or by mapped name (fields are covered more here).

_family

boolean

false

This returns meta_info for both the parent and any associated children. The return information will include the key parent and it's value will be their meta_info, and the key children as an array of meta_info for each child.

_userproducts

boolean

false

This returns information about the products which a user is allowed to select. The return will indicate if they have the product in their cart by including cart_id.

_userforms

boolean

false

This returns information about the forms a user has in their form set.

_usercart

boolean, dictionary

false

This returns information about the products that a user has in their cart.

_userpayments

boolean

false

Returns the list of payments that are associated with the user.

_utm

boolean

false

Returns infromation about UTM codes associated with the user, including campaign, content, id, medium, source, and term.

Basic Example

Curl
Python


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.

JSON


Expanded Example

This example includes the doc with values included. Additionally, this is a paginated call. Because get_user_list includes all users and their values, it is necessary to paginate these calls.

Curl
Python


Response

JS




Updated 31 Jul 2024
Doc contributor
Did this page help you?