get_user_list

this call is designed to help you quickly pull data for all of the users in your project choosing between get user list and get info batch mode get user list and get info both support returning data for multiple users in a single call, but they serve different purposes use get user list when you want field data across your whole project (or a paginated slice of it) and don't know in advance which specific users you need it returns metadata and form field values for all users, paginated at 50 parents per page use get info batch mode when you already have a specific list of clogin id values and need richer per user data — such as cart contents ( usercart ), payments ( userpayments ), or form status ( userforms ) — that get user list does not return pass clogin id as an array and the api returns a full get info style response for each user in a single round trip see the get info documentation for details 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 https //api regpack com/docs/paginated requests 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 https //api regpack com/docs/fields ) 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 x post "https //www regpack com/reg/api2/users/" \\ h "content type application/json" \\ h "accept application/json" \\ h "api id 15263" \\ h "api user api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get user list", "group id" 100909072, "doc" {} }import requests import json users endpoint = https //www regpack com/reg/api2/users/ headers = { "content type" "application/json", "accept" "application/json", "api id" "15263", "api user" "api admin\@regpacks com", "api token" "cd2e514f 7gab 3cde 62fg 51abcd4e7362", } 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 { "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 } expanded example this example includes the doc with values included additionally, this is a paginated call https //api regpack com/docs/paginated requests because get user list includes all users and their values, it is necessary to paginate these calls curl x post "https //www regpack com/reg/api2/users/" \\ h "content type application/json" \\ h "accept application/json" \\ h "api id 15263" \\ h "api user api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ h "timestamp 2514736251" \\ d '{ "action" "get user list", "group id" 100909072, "doc" {} }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" { "starting position" 1, "your instrument" true, } } total users = 222 records per page = 50 calls required to get complete list = total users // records per page + 1 # // is the floor division operator pages = range(1, calls required to get complete list+1) # range's in python are exclusive, so add one parent users = \[] child users = \[] final return = {} for page in pages if page == 1 payload\["doc"]\["starting position"] = 0 if page != 1 payload\["doc"]\["starting position"] = payload\["doc"]\["starting position"] + records per page 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) json results = get user list response json() if "users" in json results keys() parent users extend(json results\["users"]) if "children" in json results keys() child users extend(json results\["children"]) final return update({"users" parent users, "children" child users}) print(json dumps(final return, indent=4)) response { "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, "doc" { "your instrument" "guitar" } }, { "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, "doc" { "your instrument" "bass" } }, { "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, "doc" { "your instrument" "drums" } }, { "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, "doc" { "your instrument" "trumpet" } }, { "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, "doc" { "your instrument" "saxophone" } }, { "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, "doc" { "your instrument" "piano" } }, { "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, "doc" { "your instrument" "bass" } }, { "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, "doc" { "your instrument" "drums" } } ] }