website logo
Documentation
Guides
Navigate through spaces
Documentation
Guides
⌘K
Overview
Important Concepts
Family Systems
Fields
Products
Calls
Paginated Requests
Basic Authentication
Users
create
create_child
login
get_user_list
get_info
add_product
update
add_email
set_status
Status
create
Webhooks
JavaScript Customization
Docs powered by archbee 
6min

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

Curl
Python
|
import requests
import json
import time
users_endpoint = https://www.regpack.com/reg/api2/users/
current_time = str(round(time.time()))
headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Api-Id": "15263",
    "Api-user": "api_admin@regpacks.com",
    "Api-Token": "cd2e514f-7gab-3cde-62fg-51abcd4e7362",
    "Timestamp": current_time
}
payload = {
    "action": "get_user_list",
    "group_id": 100909072,
    "doc": {}
}
get_user_list_json = json.dumps(payload)
get_user_list_response = requests.post(url=users_endpoint, 
                               data=get_user_list_json, 
                               headers=headers, 
                               timeout=10)


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
|
{
    "totals": {
        "total_users": 2,
        "total_order": "0.00",
        "total_paid": "0.00",
        "total_balance": "0.00",
        "records_per_page": "15",
        "balance": 0,
        "total_children": 8,
        "label": "families",
        "group_type": 1
    },
    "present_type": "families",
    "start_position": 0,
    "only_excluded": false,
    "with_excluded": false,
    "records_per_page": 50,
    "users": [
        {
            "u_name": "Miles Davis Quintet",
            "total_forms": "2",
            "completed_forms": "0",
            "total_user_forms": "2",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "2",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "75771",
            "status_name": "confirmed attending",
            "status_color": "#89bb1f",
            "application_date": "Oct 23rd 2021 20:28",
            "application_date_raw": "2021-10-23 20:28:21",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030267",
            "clogin_id": "102670540",
            "excluded": "0",
            "connected_to": "102670540",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": "5",
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Ed Bickert Trio",
            "total_forms": "2",
            "completed_forms": "0",
            "total_user_forms": "2",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "2",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:22",
            "application_date_raw": "2021-10-23 20:22:58",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030262",
            "clogin_id": "102670535",
            "excluded": "0",
            "connected_to": "102670535",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": "3",
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        }
    ],
    "children": [
        {
            "u_name": "Ed Bickert",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "0",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:23",
            "application_date_raw": "2021-10-23 20:23:34",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030263",
            "clogin_id": "102670536",
            "excluded": "0",
            "connected_to": "102670535",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Don Thompson",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:24",
            "application_date_raw": "2021-10-23 20:24:39",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030264",
            "clogin_id": "102670537",
            "excluded": "0",
            "connected_to": "102670535",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Terry Clarke",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:25",
            "application_date_raw": "2021-10-23 20:25:26",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030265",
            "clogin_id": "102670538",
            "excluded": "0",
            "connected_to": "102670535",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Miles Davis",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:28",
            "application_date_raw": "2021-10-23 20:28:59",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030268",
            "clogin_id": "102670541",
            "excluded": "0",
            "connected_to": "102670540",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Wayne Shorter",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:31",
            "application_date_raw": "2021-10-23 20:31:13",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030269",
            "clogin_id": "102670542",
            "excluded": "0",
            "connected_to": "102670540",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Herbie Hancock",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:31",
            "application_date_raw": "2021-10-23 20:31:14",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030270",
            "clogin_id": "102670543",
            "excluded": "0",
            "connected_to": "102670540",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Ron Carter",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:32",
            "application_date_raw": "2021-10-23 20:32:32",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030271",
            "clogin_id": "102670544",
            "excluded": "0",
            "connected_to": "102670540",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        },
        {
            "u_name": "Tony Williams",
            "total_forms": "7",
            "completed_forms": "0",
            "total_user_forms": "7",
            "total_completed_user_forms": "0",
            "total_user_mandatory_forms": "7",
            "total_completed_user_mandatory_forms": "0",
            "total_order": "0.00",
            "total_paid": "0.00",
            "total_balance": "0.00",
            "user_has_saved_payment_method": "-1",
            "total_items_in_cart": "-1",
            "status_id": "0",
            "status_name": null,
            "status_color": null,
            "application_date": "Oct 23rd 2021 20:33",
            "application_date_raw": "2021-10-23 20:33:10",
            "u_comments": "0",
            "group_id": "100908752",
            "uid": "4030272",
            "clogin_id": "102670545",
            "excluded": "0",
            "connected_to": "102670540",
            "total_user_tags": "0",
            "user_tag_ids": null,
            "total_non_excluded_children": null,
            "star": "0",
            "admin_initials": null,
            "admin_color": null,
            "assigned_admin_id": null
        }
    ],
    "success": true
}





Updated 03 Mar 2023
Did this page help you?
Yes
No
UP NEXT
get_info
Docs powered by archbee 
TABLE OF CONTENTS
Basic parameters
Doc parameters
Example
Response