get_info
35 min
get_info is used to pull data from your users. The structure is very straightforward; simply include the fields you would like to get in the doc as true and use clogin_id and group_id to identify which user you'd like to get the information for. If you would only like to get the metadata for the user, then just send doc with no content.
Parameters
Name | Type | Required | Description |
|---|---|---|---|
action | string | true | get_info |
_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 information about UTM codes associated with the user, including campaign, content, id, medium, source, and term. |
disable_meta_calc | boolean | false | disables the calculation of user metadata, which is typically re-calculated on every get_info call. |
Fields Overview
There are two main approaches to getting field information from your applicants. The first is to ask for all fields for a user, and the second is to specifically choose which fields you would like returned. See the documentation to learn more about fields and how to reference them in the API.
_allfields
This is the default get_info call, so sending doc with no parameters will return all of the fields for the user. If you're making a call with other parameters as well, simply use _allfields: True.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_allfields":true
}
}Response
There are a few important things to note about the response. When you request all fields, you will get both the completed fields which appear on forms that the user has in their form set in doc, as well as null for fields which have not been completed (or fields which they have completed but appear on forms which they do not have access to). The incomplete fields will also appear in a separate errors section. Finally, field_index will include metadata about the fields themselves, allowing you to match the fields in your return to the forms on which they appear (via form_id).
{
"success": true,
"doc": {
"first_name": "Miles",
"last_name": "Davis",
"will_you_record_an_album_with_jimi_hendrix": "no",
"your_instrument": "trumpet",
"f_293824_4000245": {
"link": "https://www.a_hosted_link_of_your_file.com/g100908752/u102670541/f_293824_4000245_102670541.png",
"name": "Screen Shot 2022-04-12 at 1.44.25 PM.png",
"fid": "293824",
"size": 4197,
"locked": false,
"ext": "png",
"field_id": "f_293824_4000245",
"thumbnail": null,
"small": null,
"user_image": null
},
"f_251473_6251473": null,
"f_293824_4000244": null
},
"field_index": {
"first_name": {
"fieldtype": "text",
"mandatory": true,
"label": "Child First Name",
"mapped": true,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"last_name": {
"fieldtype": "text",
"mandatory": true,
"label": "Child Last Name",
"mapped": true,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"your_instrument": {
"fieldtype": "text",
"mandatory": true,
"label": "What instrument do you play?",
"mapped": false,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"will_you_record_an_album_with_jimi_hendrix": {
"fieldtype": "multiple",
"mandatory": true,
"label": "Will you record an album with Jimi Hendrix?",
"mapped": false,
"questiontype": "multiple",
"form_id": "293824",
"form_name": "Child Information"
},
"f_251473_6251473": {
"fieldtype": "text",
"mandatory": true,
"label": "Some unmapped short answer field",
"mapped": false,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"f_293824_4000244": {
"fieldtype": "widget",
"mandatory": true,
"label": "Upload your pic",
"mapped": false,
"questiontype": "_addfile",
"form_id": "293824",
"form_name": "Child Information"
},
"f_293824_4000245": {
"fieldtype": "widget",
"mandatory": true,
"label": "upload your instrument pic",
"mapped": false,
"questiontype": "_addfile",
"form_id": "293824",
"form_name": "Child Information"
}
},
"user_info": {
"clogin_id": "102670541",
"group_id": "100909072",
"connected_to": "102670540"
},
"meta_info": {
"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": "0",
"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": "100909072",
"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
},
"errors": [
{
"msg": "Field f_251473_6251473 has not been filled out by the user. It is marked in the return doc as NULL.",
"msg_type": "error",
"msg_level": "warning",
"field_id": "f_251473_6251473",
"error_type": "not_filled_out"
},
{
"msg": "Field f_293824_4000244 has not been filled out by the user. It is marked in the return doc as NULL.",
"msg_type": "error",
"msg_level": "warning",
"field_id": "f_293824_4000244",
"error_type": "not_filled_out"
}
]
}
Returning only the completed fields
By default _allfields includes the empty fields. If you would only like to return the completed fields, you can include with_empty_fields: False. Note that this parameter should be included at the top level, and not inside doc. Further you can inlcude this argument on any request for fields in order to only return completed fields.
Request
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": "[email protected]",
"Api-Token": "cd2e514f-7gab-3cde-62fg-51abcd4e7362",
}
payload = {
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"with_empty_fields": False,
"doc": {
"_allfields":True
}
}
get_info_fields_json = json.dumps(payload)
get_info_fields_response = requests.post(url=users_endpoint,
data=get_info_fields_json,
headers=headers,
timeout=10)Response
{
"success": true,
"doc": {
"first_name": "Miles",
"last_name": "Davis",
"will_you_record_an_album_with_jimi_hendrix": "no",
"your_instrument": "trumpet",
"f_293824_4000245": {
"link": "https://www.regpack.com/reg/gfiles/g100908752/u102670541/f_293824_4000245_102670541.png",
"name": "Screen Shot 2022-04-12 at 1.44.25 PM.png",
"fid": "293824",
"size": 4197,
"locked": false,
"ext": "png",
"field_id": "f_293824_4000245",
"thumbnail": null,
"small": null,
"user_image": null
}
},
"field_index": {
"first_name": {
"fieldtype": "text",
"mandatory": true,
"label": "Child First Name",
"mapped": true,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"last_name": {
"fieldtype": "text",
"mandatory": true,
"label": "Child Last Name",
"mapped": true,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"your_instrument": {
"fieldtype": "text",
"mandatory": true,
"label": "What instrument do you play?",
"mapped": false,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"will_you_record_an_album_with_jimi_hendrix": {
"fieldtype": "multiple",
"mandatory": true,
"label": "Will you record an album with Jimi Hendrix?",
"mapped": false,
"questiontype": "multiple",
"form_id": "293824",
"form_name": "Child Information"
},
"f_293824_4000245": {
"fieldtype": "widget",
"mandatory": true,
"label": "upload your instrument pic",
"mapped": false,
"questiontype": "_addfile",
"form_id": "293824",
"form_name": "Child Information"
}
},
"user_info": {
"clogin_id": "102670541",
"group_id": "100908752",
"connected_to": "102670540"
},
"meta_info": {
"u_name": "Miles Davis",
"total_forms": "7",
"completed_forms": "2",
"total_user_forms": "7",
"total_completed_user_forms": "2",
"total_user_mandatory_forms": "7",
"total_completed_user_mandatory_forms": "2",
"total_order": "100.00",
"total_paid": "12.00",
"total_balance": "88.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
}
}
Returning a list of fields
Simply provide a list in doc which specifies which fields you would like returned. The return will have a complete list of the fields which you requested, and the fields which have not been answered (or fields with answers which appear on forms that the user does not have access to) will appear as null values. This is the recommended approach if you have a small list of fields to collect.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"your_favorite_instrument": true
"f_2514_7362": true
}
}Response
{
"success": true,
"doc": {
"first_name": "Miles",
"last_name": "Davis",
"will_you_record_an_album_with_jimi_hendrix": "no",
"your_instrument": "trumpet",
"f_251473_6251473": null
},
"field_index": {
"first_name": {
"fieldtype": "text",
"mandatory": true,
"label": "Child First Name",
"mapped": true,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"last_name": {
"fieldtype": "text",
"mandatory": true,
"label": "Child Last Name",
"mapped": true,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"your_instrument": {
"fieldtype": "text",
"mandatory": true,
"label": "What instrument do you play?",
"mapped": false,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
},
"will_you_record_an_album_with_jimi_hendrix": {
"fieldtype": "multiple",
"mandatory": true,
"label": "Will you record an album with Jimi Hendrix?",
"mapped": false,
"questiontype": "multiple",
"form_id": "293824",
"form_name": "Child Information"
},
"f_251473_6251473": {
"fieldtype": "text",
"mandatory": true,
"label": "Some unmapped short answer field",
"mapped": false,
"questiontype": "shortanswer",
"form_id": "293824",
"form_name": "Child Information"
}
},
"user_info": {
"clogin_id": "102670541",
"group_id": "100908752",
"connected_to": "102670540"
},
"meta_info": {
"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": "0",
"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
},
"errors": [
{
"msg": "Field f_251473_6251473 has not been filled out by the user. It is marked in the return doc as NULL.",
"msg_type": "error",
"msg_level": "warning",
"field_id": "f_251473_6251473",
"error_type": "not_filled_out"
}
]
}
_family
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.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102670540,
"doc": {
"_family": true
}
}Response
{
"doc": {
"_family": {
"parent": [
{
"u_name": "Miles Davis",
"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",
"status_id": "0",
"status_name": null,
"status_color": null,
"application_date": "Dec 8th 2021 17:20",
"application_date_raw": "2021-12-08 17:20:08",
"u_comments": "0",
"group_id": "100909072",
"uid": "4085258",
"clogin_id": "102670540",
"excluded": "0",
"connected_to": "102670540",
"total_user_tags": "0",
"user_tag_ids": null,
"total_non_excluded_children": "1",
"star": "0",
"admin_initials": null,
"admin_color": null,
"assigned_admin_id": null
}
],
"children": [
{
"u_name": "Bill Evans",
"total_forms": "6",
"completed_forms": "0",
"total_user_forms": "6",
"total_completed_user_forms": "0",
"total_user_mandatory_forms": "6",
"total_completed_user_mandatory_forms": "0",
"total_order": "0.00",
"total_paid": "0.00",
"total_balance": "0.00",
"status_id": "0",
"status_name": null,
"status_color": null,
"application_date": "Dec 8th 2021 17:20",
"application_date_raw": "2021-12-08 17:20:08",
"u_comments": "0",
"group_id": "100909072",
"uid": "4085259",
"clogin_id": "102715755",
"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,
"user_info": {
"clogin_id": "102670540",
"group_id": "100909072",
"connected_to": "102670540"
},
"meta_info": {
"u_name": "Miles Davis",
"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",
"status_id": "0",
"status_name": null,
"status_color": null,
"application_date": "Dec 8th 2021 17:20",
"application_date_raw": "2021-12-08 17:20:08",
"u_comments": "0",
"group_id": "100909072",
"uid": "4085258",
"clogin_id": "102670540",
"excluded": "0",
"connected_to": "102670540",
"total_user_tags": "0",
"user_tag_ids": null,
"total_non_excluded_children": "1",
"star": "0",
"admin_initials": null,
"admin_color": null,
"assigned_admin_id": null
}
}
_userproducts
This returns information about the products which a user is allowed to select, and the return will indicate if they actually have the product in their cart by including cart_id.
By default, as soon as you add a product to the product page it will be viewable by your users. There are, however, a number of ways to restrict this access:
- Triggers: If a product is triggered to show or add only when the conditions are met, then users who do not meet those conditions will not see the product. Unless you have the "hide products unless triggered" option turned on (this is off by default), then un-triggered products will be available to everyone. See this article for more on how to edit a product trigger.
- Availability or expiration date: even if a user meets the trigger conditions, a product will not be available prior to its availability date or after its expiration date.
- Admin only: if you set a product to be viewable only to admins, then the only users who will see it are those who have already had it added to their cart. Note that if a product is triggered to add automatically, it will still add even if it is marked as admin only.
As final note, internalid is a helpful product property which allows you to set custom tags for products. This can help you group products according to your internal needs which falls outside the category groupings already provided. See this article for more on how to edit products and add these custom tags.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_userproducts": true
}
}
Response
{
"doc": [],
"success": true,
"user_info": {
"clogin_id": "102715754",
"group_id": "100909072",
"connected_to": "102715737"
},
"meta_info": {
"u_name": "Kenny Burrell",
"total_forms": "6",
"completed_forms": "1",
"total_user_forms": "6",
"total_completed_user_forms": "1",
"total_user_mandatory_forms": "6",
"total_completed_user_mandatory_forms": "1",
"total_order": "0.00",
"total_paid": "100.00",
"total_balance": "-100.00",
"status_id": "0",
"status_name": null,
"status_color": null,
"application_date": "Dec 8th 2021 17:07",
"application_date_raw": "2021-12-08 17:07:40",
"u_comments": "0",
"group_id": "100909072",
"uid": "4085256",
"clogin_id": "102715754",
"excluded": "0",
"connected_to": "102715737",
"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
}
}
_userforms
This returns information about the forms a user has in their form set.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_userforms": true
}
}Response
{
"doc": {
"_userforms": [
{
"form_id": "301228",
"form_name": "Child Information",
"form_link": "/reg/forms/form_html/g100909072/form_1396136142.php",
"form_admin": "0",
"form_order": "1",
"form_mandatory": "1",
"anonymous_form": "0",
"when_complete": "all_mandatory_no_view",
"lock_when_complete": "0",
"form_type": "2",
"form_start_date": null,
"form_end_date": null,
"with_form_spinner": "0",
"form_spinner_text": null,
"timebased_view": "1",
"cat_id": "28472",
"form_system_type": null,
"roadblock": "0",
"is_complete": "0",
"reviewed": "0",
"locked": "0"
},
{
"form_id": "301229",
"form_name": "Program Selection",
"form_link": "/reg/forms/form_html/g100909072/form_1628672823.php",
"form_admin": "0",
"form_order": "2",
"form_mandatory": "1",
"anonymous_form": "0",
"when_complete": "all_mandatory_no_view",
"lock_when_complete": "0",
"form_type": "2",
"form_start_date": null,
"form_end_date": null,
"with_form_spinner": "0",
"form_spinner_text": null,
"timebased_view": "1",
"cat_id": "28472",
"form_system_type": null,
"roadblock": "0",
"is_complete": "0",
"reviewed": "0",
"locked": "0"
},
{
"form_id": "301230",
"form_name": "Terms and Conditions",
"form_link": "/reg/forms/form_html/g100909072/form_1091167618.php",
"form_admin": "0",
"form_order": "3",
"form_mandatory": "1",
"anonymous_form": "0",
"when_complete": "all_mandatory_no_view",
"lock_when_complete": "1",
"form_type": "2",
"form_start_date": null,
"form_end_date": null,
"with_form_spinner": "0",
"form_spinner_text": null,
"timebased_view": "1",
"cat_id": "28472",
"form_system_type": null,
"roadblock": "0",
"is_complete": "0",
"reviewed": "0",
"locked": "0"
},
{
"form_id": "301231",
"form_name": "Confirm Selection",
"form_link": "/reg/forms/form_html/g100909072/form_470777528.php",
"form_admin": "0",
"form_order": "4",
"form_mandatory": "1",
"anonymous_form": "0",
"when_complete": "all_mandatory_no_view",
"lock_when_complete": "0",
"form_type": "2",
"form_start_date": null,
"form_end_date": null,
"with_form_spinner": "0",
"form_spinner_text": null,
"timebased_view": "1",
"cat_id": "28472",
"form_system_type": null,
"roadblock": "0",
"is_complete": "0",
"reviewed": "0",
"locked": "0"
},
{
"form_id": "301232",
"form_name": "Payment Options",
"form_link": "/reg/forms/form_html/g100909072/form_805962336.php",
"form_admin": "0",
"form_order": "5",
"form_mandatory": "1",
"anonymous_form": "0",
"when_complete": "all_mandatory_no_view",
"lock_when_complete": "0",
"form_type": "2",
"form_start_date": null,
"form_end_date": null,
"with_form_spinner": "0",
"form_spinner_text": null,
"timebased_view": "1",
"cat_id": "28472",
"form_system_type": null,
"roadblock": "0",
"is_complete": "0",
"reviewed": "0",
"locked": "0"
},
{
"form_id": "301233",
"form_name": "Checkout",
"form_link": "/reg/forms/form_html/g100909072/form_432052473.php",
"form_admin": "0",
"form_order": "6",
"form_mandatory": "1",
"anonymous_form": "0",
"when_complete": "all_mandatory_no_view",
"lock_when_complete": "0",
"form_type": "2",
"form_start_date": null,
"form_end_date": null,
"with_form_spinner": "0",
"form_spinner_text": null,
"timebased_view": "1",
"cat_id": "28472",
"form_system_type": null,
"roadblock": "0",
"is_complete": "0",
"reviewed": "0",
"locked": "0"
}
]
},
"success": true,
"user_info": {
"clogin_id": "102715754",
"group_id": "100909072",
"connected_to": "102715737"
},
"meta_info": {
"u_name": "Kenny Burrell",
"total_forms": "6",
"completed_forms": "0",
"total_user_forms": "6",
"total_completed_user_forms": "0",
"total_user_mandatory_forms": "6",
"total_completed_user_mandatory_forms": "0",
"total_order": "0.00",
"total_paid": "100.00",
"total_balance": "-100.00",
"status_id": "0",
"status_name": null,
"status_color": null,
"application_date": "Dec 8th 2021 17:07",
"application_date_raw": "2021-12-08 17:07:40",
"u_comments": "0",
"group_id": "100909072",
"uid": "4085256",
"clogin_id": "102715754",
"excluded": "0",
"connected_to": "102715737",
"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
}
}_usercart
This returns information about the proucts a user has in their cart. Note that you can either use "_usercart":True for just the cart information, or you can use "_usercart": {"with_payment_allocation":True} to include an extra section in the return that shows how the payments for that applicant have been allocated to the products in the cart.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_usercart": true
}
}Response
{
"success": true,
"doc": {
"_usercart": {
"products": [
{
"reg_id": "102670541",
"cart_id": "11893570",
"p_id": "1841075",
"is_holder_product": "1",
"parent_product": "1841075",
"session_id": null,
"is_session_product": "0",
"is_session_subproduct": "0",
"pp_protected": null,
"pp_protected_amount": "0",
"session_checkin_total_items": "0",
"cat_id": "80012",
"base_product_type": "3",
"zero_product_presentation": "0",
"product_present_text_value": "",
"allow_waitlist": "0",
"product_quota_ordered": "0",
"lock_after_paid": "1",
"lock_in_cart": "0",
"force_paid_first": "0",
"lock_once_funds_allocated": "1",
"session_start_unix": null,
"session_end_unix": null,
"disable_regsurance": "0",
"opt_in_regsurance": "0",
"location": null,
"internalid": null,
"instructor": null,
"disable_time_conflict": "0",
"discount_presented_as": null,
"p_name": "regular_session_product",
"is_recurring": "0",
"recurring_cart_parent_id": null,
"original_session_price": null,
"day_session_final_price": null,
"recurring_structure": null,
"recurring_structure_custom_num": "0",
"recurring_trigger_start": null,
"recurring_allow_user_disable": "0",
"recurring_allow_upgrade": "0",
"recurring_upgrade_text": null,
"recur_total_instances": "0",
"recur_completed_instances": "0",
"recurring_id": null,
"recurring_text": "",
"recurring_comment": "",
"recurring_pause_comment": "",
"recurring_messages": null,
"recurring_instances_left": null,
"recur_on_original": "0",
"recur_done": "0",
"is_recurring_single": "0",
"recur_allow_renew": "0",
"recurring_valid_grace": null,
"recur_autorenew_pid": "0",
"recur_autorenew_disabled": "0",
"recur_autorenew_instance": "0",
"recur_autorenew_done": "0",
"recur_user_disabled": "0",
"recur_pause_on": null,
"recur_resume_on": null,
"recur_on": "0",
"recur_end": "0",
"recur_overall_end": "0",
"session_start_date_readable": null,
"session_end_date_readable": null,
"session_days_text": null,
"auto_generated_session_name": "0",
"allow_partial_enrollment": null,
"session_remarks": null,
"original_session_product_price": null,
"selected_session_days": null,
"total_session_days": null,
"session_start_date": null,
"session_end_date": null,
"product_total_orders": "1",
"product_total_pf": "0",
"product_quota_ordered_full": "0",
"special_remarks": "",
"product_short_remarks": "",
"cart_timer": "0",
"cart_timer_expire_unix": "0",
"cart_timer_when": null,
"skip_paidfor": 0,
"q": "1",
"waitlist": "0",
"abandoned_item": "0",
"price": "0",
"price_in_cart": "0",
"total_price": "0.00",
"locked": "0",
"delivered": "0",
"delivered_on": null,
"delivered_on_ts": null,
"paid_for": "0",
"paid_for_amount": "0",
"paid_for_amount_remark": null,
"paid_for_additional_remark": null,
"pf": "0",
"paid_for_order": "0",
"cat_order": "1",
"product_order": "1",
"conn_fee": "0",
"tax_fee": "0",
"original_price": null,
"amount_paid_with_discount": "0",
"amount_paid_with_incart_discount": "0",
"paid_in_full_by_discount": "0",
"base_discount_remark": null,
"incart_discount_remark": null,
"total_discount_remark": " ",
"discount_product_in_cart": "0",
"markoff_discount": "0",
"regsurance_cart_value": "0",
"regsurance_product": "0",
"creation_date": "2022-04-21 14:43:43",
"cart_datestamp": "1650517200",
"creation_date_readable": "April 21st 2022",
"paid_on_readable": null,
"total_order": "100.00",
"total_payment": "10.00",
"total_paid_for": "0.00",
"total_delivered": "0.00",
"first_name": "Miles",
"last_name": "Davis",
"org_name": null,
"discount_remark": "",
"p_remarks": "",
"in_cart": "1",
"in_cart_waitlist": "0",
"sessions": [
{
"reg_id": "102670541",
"cart_id": "11893571",
"p_id": "1841076",
"is_holder_product": "0",
"parent_product": "1841075",
"session_id": "1841076",
"is_session_product": "1",
"is_session_subproduct": "0",
"pp_protected": null,
"pp_protected_amount": "0",
"session_checkin_total_items": "0",
"cat_id": "80012",
"base_product_type": "4",
"zero_product_presentation": "0",
"product_present_text_value": "",
"allow_waitlist": "0",
"product_quota_ordered": "0",
"lock_after_paid": "1",
"lock_in_cart": "0",
"force_paid_first": "0",
"lock_once_funds_allocated": "1",
"session_start_unix": "1898866800",
"session_end_unix": "1901052000",
"disable_regsurance": "0",
"opt_in_regsurance": "0",
"location": null,
"internalid": null,
"instructor": null,
"disable_time_conflict": "0",
"discount_presented_as": null,
"p_name": "regular_session_product: Sat, Mar 02nd, 2030 > Sun, Mar 31st, 2030",
"is_recurring": "0",
"recurring_cart_parent_id": null,
"original_session_price": null,
"day_session_final_price": null,
"recurring_structure": null,
"recurring_structure_custom_num": "0",
"recurring_trigger_start": null,
"recurring_allow_user_disable": "0",
"recurring_allow_upgrade": "0",
"recurring_upgrade_text": null,
"recur_total_instances": "0",
"recur_completed_instances": "0",
"recurring_id": null,
"recurring_text": "",
"recurring_comment": "",
"recurring_pause_comment": "",
"recurring_messages": null,
"recurring_instances_left": null,
"recur_on_original": "0",
"recur_done": "0",
"is_recurring_single": "0",
"recur_allow_renew": "0",
"recurring_valid_grace": null,
"recur_autorenew_pid": "0",
"recur_autorenew_disabled": "0",
"recur_autorenew_instance": "0",
"recur_autorenew_done": "0",
"recur_user_disabled": "0",
"recur_pause_on": null,
"recur_resume_on": null,
"recur_on": "0",
"recur_end": "0",
"recur_overall_end": "0",
"session_start_date_readable": "Sat, Mar 02nd, 2030",
"session_end_date_readable": "Sun, Mar 31st, 2030",
"session_days_text": "<div class=\"session_day_holder\"><label>Mon</label></div><div class=\"session_day_holder\"><label>Tue</label></div><div class=\"session_day_holder\"><label>Wed</label></div><div class=\"session_day_holder\"><label>Thu</label></div><div class=\"session_day_holder\"><label>Fri</label></div><div class=\"session_day_holder\"><label>» 9:00 am - 5:00 pm</label></div>",
"auto_generated_session_name": "1",
"allow_partial_enrollment": "1",
"session_remarks": null,
"original_session_product_price": null,
"selected_session_days": "20",
"total_session_days": "20",
"session_start_date": "2030-03-02",
"session_end_date": "2030-03-31",
"product_total_orders": "1",
"product_total_pf": "0",
"product_quota_ordered_full": "0",
"special_remarks": "",
"product_short_remarks": "",
"cart_timer": "0",
"cart_timer_expire_unix": "0",
"cart_timer_when": null,
"skip_paidfor": 0,
"q": "1",
"waitlist": "0",
"abandoned_item": "0",
"price": "100",
"price_in_cart": "100",
"total_price": "100.00",
"locked": "1",
"delivered": "0",
"delivered_on": null,
"delivered_on_ts": null,
"paid_for": "0",
"paid_for_amount": "10",
"paid_for_amount_remark": "$10 has been allocated to this item. Item balance: $90.",
"paid_for_additional_remark": "Payment transaction 10896147 for $10 made on April 21st 2022 was <i>allocated in full</i> to this item.",
"pf": "0",
"paid_for_order": "11",
"cat_order": "1",
"product_order": "2",
"conn_fee": "0",
"tax_fee": "0",
"original_price": null,
"amount_paid_with_discount": "0",
"amount_paid_with_incart_discount": "0",
"paid_in_full_by_discount": "0",
"base_discount_remark": null,
"incart_discount_remark": null,
"total_discount_remark": " ",
"discount_product_in_cart": "0",
"markoff_discount": "0",
"regsurance_cart_value": "0",
"regsurance_product": "0",
"creation_date": "2022-04-21 14:43:43",
"cart_datestamp": "1650517200",
"creation_date_readable": "April 21st 2022",
"paid_on_readable": null,
"total_order": "100.00",
"total_payment": "10.00",
"total_paid_for": "0.00",
"total_delivered": "0.00",
"first_name": "Miles",
"last_name": "Davis",
"org_name": null,
"discount_remark": "",
"p_remarks": "",
"in_cart": "1",
"in_cart_waitlist": "0",
"eligible_for_pp": 1,
"session_parent_cart_id": "11893570",
"allocated_payments": [
{
"amount_allocated": 10,
"payment_amount": "10",
"cart_id": "11893571",
"allocated_in_full": true,
"allocation_text": "Allocated in full to: regular_session_product: Sat, Mar 02nd, 2030 > Sun, Mar 31st, 2030 ($100)",
"payment_id": "10896147",
"transaction_id": "10896147",
"vendor": "Cash",
"payment_datestamp": "1650577595",
"full_payment_datestamp": "1650577595",
"creation_date": "2022-04-21 16:46:35"
}
]
}
],
"session_product": 1
}
],
"categories": [
{
"cat_id": "80012",
"name": "control test products",
"top_remark": "",
"bottom_remark": "",
"interchange": "0",
"mandatory_cat": "0",
"cat_order": "1"
}
]
}
},
"user_info": {
"clogin_id": "102670541",
"group_id": "100908752",
"connected_to": "102670540"
},
"meta_info": {
"u_name": "Miles Davis",
"total_forms": "7",
"completed_forms": "2",
"total_user_forms": "7",
"total_completed_user_forms": "2",
"total_user_mandatory_forms": "7",
"total_completed_user_mandatory_forms": "2",
"total_order": "100.00",
"total_paid": "10.00",
"total_balance": "90.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
}
}
_userpayments
Returns the list of payments that are associated with the user.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_userpayments": true
}
}Response
{
"doc": {
"_userpayments": {
"msg": [],
"records": [
{
"p_id": "6659419",
"trans_id": "6659419",
"final_amount": "100",
"sandbox_payment": "0",
"cc_subtype": null,
"parent_payment": "6659419",
"child_payments_num": "0",
"payment_date": "Dec 8th 2021 17:08",
"payment_date_raw": "2021-12-08 17:08:06",
"amount": "100",
"payment_status": "approved",
"actual_payment_status": null,
"issuer": "Admin, Support",
"method": "Manual | Cash",
"fee": "0",
"allocated_to_previous_order_amount": "0",
"amount_left": "100",
"curr": "USD",
"clogin_id": "102715754",
"group_id": "100909072",
"present_payment_status": "Approved"
}
]
}
},
"success": true,
"user_info": {
"clogin_id": "102715754",
"group_id": "100909072",
"connected_to": "102715737"
},
"meta_info": {
"u_name": "Kenny Burrell",
"total_forms": "6",
"completed_forms": "0",
"total_user_forms": "6",
"total_completed_user_forms": "0",
"total_user_mandatory_forms": "6",
"total_completed_user_mandatory_forms": "0",
"total_order": "0.00",
"total_paid": "100.00",
"total_balance": "-100.00",
"status_id": "0",
"status_name": null,
"status_color": null,
"application_date": "Dec 8th 2021 17:07",
"application_date_raw": "2021-12-08 17:07:40",
"u_comments": "0",
"group_id": "100909072",
"uid": "4085256",
"clogin_id": "102715754",
"excluded": "0",
"connected_to": "102715737",
"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
}
}_usercart
This returns information about the proucts a user has in their cart. Note that you can either use "_usercart":True for just the cart information, or you can use "_usercart": {"with_payment_allocation":True} to include an extra section in the return that shows how the payments for that applicant have been allocated to the products in the cart.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_usercart": true
}
}Response
{
"success": true,
"doc": {
"_usercart": {
"products": [
{
"reg_id": "102670541",
"cart_id": "11893570",
"p_id": "1841075",
"is_holder_product": "1",
"parent_product": "1841075",
"session_id": null,
"is_session_product": "0",
"is_session_subproduct": "0",
"pp_protected": null,
"pp_protected_amount": "0",
"session_checkin_total_items": "0",
"cat_id": "80012",
"base_product_type": "3",
"zero_product_presentation": "0",
"product_present_text_value": "",
"allow_waitlist": "0",
"product_quota_ordered": "0",
"lock_after_paid": "1",
"lock_in_cart": "0",
"force_paid_first": "0",
"lock_once_funds_allocated": "1",
"session_start_unix": null,
"session_end_unix": null,
"disable_regsurance": "0",
"opt_in_regsurance": "0",
"location": null,
"internalid": null,
"instructor": null,
"disable_time_conflict": "0",
"discount_presented_as": null,
"p_name": "regular_session_product",
"is_recurring": "0",
"recurring_cart_parent_id": null,
"original_session_price": null,
"day_session_final_price": null,
"recurring_structure": null,
"recurring_structure_custom_num": "0",
"recurring_trigger_start": null,
"recurring_allow_user_disable": "0",
"recurring_allow_upgrade": "0",
"recurring_upgrade_text": null,
"recur_total_instances": "0",
"recur_completed_instances": "0",
"recurring_id": null,
"recurring_text": "",
"recurring_comment": "",
"recurring_pause_comment": "",
"recurring_messages": null,
"recurring_instances_left": null,
"recur_on_original": "0",
"recur_done": "0",
"is_recurring_single": "0",
"recur_allow_renew": "0",
"recurring_valid_grace": null,
"recur_autorenew_pid": "0",
"recur_autorenew_disabled": "0",
"recur_autorenew_instance": "0",
"recur_autorenew_done": "0",
"recur_user_disabled": "0",
"recur_pause_on": null,
"recur_resume_on": null,
"recur_on": "0",
"recur_end": "0",
"recur_overall_end": "0",
"session_start_date_readable": null,
"session_end_date_readable": null,
"session_days_text": null,
"auto_generated_session_name": "0",
"allow_partial_enrollment": null,
"session_remarks": null,
"original_session_product_price": null,
"selected_session_days": null,
"total_session_days": null,
"session_start_date": null,
"session_end_date": null,
"product_total_orders": "1",
"product_total_pf": "0",
"product_quota_ordered_full": "0",
"special_remarks": "",
"product_short_remarks": "",
"cart_timer": "0",
"cart_timer_expire_unix": "0",
"cart_timer_when": null,
"skip_paidfor": 0,
"q": "1",
"waitlist": "0",
"abandoned_item": "0",
"price": "0",
"price_in_cart": "0",
"total_price": "0.00",
"locked": "0",
"delivered": "0",
"delivered_on": null,
"delivered_on_ts": null,
"paid_for": "0",
"paid_for_amount": "0",
"paid_for_amount_remark": null,
"paid_for_additional_remark": null,
"pf": "0",
"paid_for_order": "0",
"cat_order": "1",
"product_order": "1",
"conn_fee": "0",
"tax_fee": "0",
"original_price": null,
"amount_paid_with_discount": "0",
"amount_paid_with_incart_discount": "0",
"paid_in_full_by_discount": "0",
"base_discount_remark": null,
"incart_discount_remark": null,
"total_discount_remark": " ",
"discount_product_in_cart": "0",
"markoff_discount": "0",
"regsurance_cart_value": "0",
"regsurance_product": "0",
"creation_date": "2022-04-21 14:43:43",
"cart_datestamp": "1650517200",
"creation_date_readable": "April 21st 2022",
"paid_on_readable": null,
"total_order": "100.00",
"total_payment": "10.00",
"total_paid_for": "0.00",
"total_delivered": "0.00",
"first_name": "Miles",
"last_name": "Davis",
"org_name": null,
"discount_remark": "",
"p_remarks": "",
"in_cart": "1",
"in_cart_waitlist": "0",
"sessions": [
{
"reg_id": "102670541",
"cart_id": "11893571",
"p_id": "1841076",
"is_holder_product": "0",
"parent_product": "1841075",
"session_id": "1841076",
"is_session_product": "1",
"is_session_subproduct": "0",
"pp_protected": null,
"pp_protected_amount": "0",
"session_checkin_total_items": "0",
"cat_id": "80012",
"base_product_type": "4",
"zero_product_presentation": "0",
"product_present_text_value": "",
"allow_waitlist": "0",
"product_quota_ordered": "0",
"lock_after_paid": "1",
"lock_in_cart": "0",
"force_paid_first": "0",
"lock_once_funds_allocated": "1",
"session_start_unix": "1898866800",
"session_end_unix": "1901052000",
"disable_regsurance": "0",
"opt_in_regsurance": "0",
"location": null,
"internalid": null,
"instructor": null,
"disable_time_conflict": "0",
"discount_presented_as": null,
"p_name": "regular_session_product: Sat, Mar 02nd, 2030 > Sun, Mar 31st, 2030",
"is_recurring": "0",
"recurring_cart_parent_id": null,
"original_session_price": null,
"day_session_final_price": null,
"recurring_structure": null,
"recurring_structure_custom_num": "0",
"recurring_trigger_start": null,
"recurring_allow_user_disable": "0",
"recurring_allow_upgrade": "0",
"recurring_upgrade_text": null,
"recur_total_instances": "0",
"recur_completed_instances": "0",
"recurring_id": null,
"recurring_text": "",
"recurring_comment": "",
"recurring_pause_comment": "",
"recurring_messages": null,
"recurring_instances_left": null,
"recur_on_original": "0",
"recur_done": "0",
"is_recurring_single": "0",
"recur_allow_renew": "0",
"recurring_valid_grace": null,
"recur_autorenew_pid": "0",
"recur_autorenew_disabled": "0",
"recur_autorenew_instance": "0",
"recur_autorenew_done": "0",
"recur_user_disabled": "0",
"recur_pause_on": null,
"recur_resume_on": null,
"recur_on": "0",
"recur_end": "0",
"recur_overall_end": "0",
"session_start_date_readable": "Sat, Mar 02nd, 2030",
"session_end_date_readable": "Sun, Mar 31st, 2030",
"session_days_text": "<div class=\"session_day_holder\"><label>Mon</label></div><div class=\"session_day_holder\"><label>Tue</label></div><div class=\"session_day_holder\"><label>Wed</label></div><div class=\"session_day_holder\"><label>Thu</label></div><div class=\"session_day_holder\"><label>Fri</label></div><div class=\"session_day_holder\"><label>» 9:00 am - 5:00 pm</label></div>",
"auto_generated_session_name": "1",
"allow_partial_enrollment": "1",
"session_remarks": null,
"original_session_product_price": null,
"selected_session_days": "20",
"total_session_days": "20",
"session_start_date": "2030-03-02",
"session_end_date": "2030-03-31",
"product_total_orders": "1",
"product_total_pf": "0",
"product_quota_ordered_full": "0",
"special_remarks": "",
"product_short_remarks": "",
"cart_timer": "0",
"cart_timer_expire_unix": "0",
"cart_timer_when": null,
"skip_paidfor": 0,
"q": "1",
"waitlist": "0",
"abandoned_item": "0",
"price": "100",
"price_in_cart": "100",
"total_price": "100.00",
"locked": "1",
"delivered": "0",
"delivered_on": null,
"delivered_on_ts": null,
"paid_for": "0",
"paid_for_amount": "10",
"paid_for_amount_remark": "$10 has been allocated to this item. Item balance: $90.",
"paid_for_additional_remark": "Payment transaction 10896147 for $10 made on April 21st 2022 was <i>allocated in full</i> to this item.",
"pf": "0",
"paid_for_order": "11",
"cat_order": "1",
"product_order": "2",
"conn_fee": "0",
"tax_fee": "0",
"original_price": null,
"amount_paid_with_discount": "0",
"amount_paid_with_incart_discount": "0",
"paid_in_full_by_discount": "0",
"base_discount_remark": null,
"incart_discount_remark": null,
"total_discount_remark": " ",
"discount_product_in_cart": "0",
"markoff_discount": "0",
"regsurance_cart_value": "0",
"regsurance_product": "0",
"creation_date": "2022-04-21 14:43:43",
"cart_datestamp": "1650517200",
"creation_date_readable": "April 21st 2022",
"paid_on_readable": null,
"total_order": "100.00",
"total_payment": "10.00",
"total_paid_for": "0.00",
"total_delivered": "0.00",
"first_name": "Miles",
"last_name": "Davis",
"org_name": null,
"discount_remark": "",
"p_remarks": "",
"in_cart": "1",
"in_cart_waitlist": "0",
"eligible_for_pp": 1,
"session_parent_cart_id": "11893570",
"allocated_payments": [
{
"amount_allocated": 10,
"payment_amount": "10",
"cart_id": "11893571",
"allocated_in_full": true,
"allocation_text": "Allocated in full to: regular_session_product: Sat, Mar 02nd, 2030 > Sun, Mar 31st, 2030 ($100)",
"payment_id": "10896147",
"transaction_id": "10896147",
"vendor": "Cash",
"payment_datestamp": "1650577595",
"full_payment_datestamp": "1650577595",
"creation_date": "2022-04-21 16:46:35"
}
]
}
],
"session_product": 1
}
],
"categories": [
{
"cat_id": "80012",
"name": "control test products",
"top_remark": "",
"bottom_remark": "",
"interchange": "0",
"mandatory_cat": "0",
"cat_order": "1"
}
]
}
},
"user_info": {
"clogin_id": "102670541",
"group_id": "100908752",
"connected_to": "102670540"
},
"meta_info": {
"u_name": "Miles Davis",
"total_forms": "7",
"completed_forms": "2",
"total_user_forms": "7",
"total_completed_user_forms": "2",
"total_user_mandatory_forms": "7",
"total_completed_user_mandatory_forms": "2",
"total_order": "100.00",
"total_paid": "10.00",
"total_balance": "90.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
}
}
_utm
Returns information about your UTM codes. If a UTM parameter is not available or provided, it will appear as an error in the errors block of the return.
Request
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: [email protected]" \
-H "Api-Token: cd2e514f-7gab-3cde-62fg-51abcd4e7362" \
-d '{
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_utm": true
}
}Response
{
"success": true,
"doc": {
"_first_touch_utm_campaign": "2511625_ABCD_marketing_stuff_ABAC",
"_first_touch_utm_medium": "cost_per_click",
"_first_touch_utm_source": "google",
"_first_touch_utm_content": null,
"_first_touch_utm_id": null,
"_first_touch_utm_term": null
},
"user_info": {
"clogin_id": "102715754",
"group_id": "100909072",
"connected_to": "102715737"
},
"meta_info": {
"meta_info": {
"u_name": "Miles Davis",
"total_forms": "7",
"completed_forms": "2",
"total_user_forms": "7",
"total_completed_user_forms": "2",
"total_user_mandatory_forms": "7",
"total_completed_user_mandatory_forms": "2",
"total_order": "100.00",
"total_paid": "10.00",
"total_balance": "90.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
},
"errors": [
{
"msg": "Field _first_touch_utm_content has not been filled out by the user. It is marked in the return doc as NULL.",
"msg_type": "error",
"msg_level": "warning",
"field_id": "_first_touch_utm_content",
"error_type": "not_filled_out"
},
{
"msg": "Field _first_touch_utm_id has not been filled out by the user. It is marked in the return doc as NULL.",
"msg_type": "error",
"msg_level": "warning",
"field_id": "_first_touch_utm_id",
"error_type": "not_filled_out"
},
{
"msg": "Field _first_touch_utm_term has not been filled out by the user. It is marked in the return doc as NULL.",
"msg_type": "error",
"msg_level": "warning",
"field_id": "_first_touch_utm_term",
"error_type": "not_filled_out"
}
]
}Batch mode — fetching multiple users in one call
By default, get_info fetches data for a single user identified by a numeric clogin_id. If you need information for a specific set of users, you can pass clogin_id as an array of numeric ids instead. The API returns a full get_info-style response for each user in a single round-trip.
This is the recommended approach when you have a known list of users and need rich per-user data such as cart contents, payments, or form status. If you need field data across all users in your project without knowing their ids in advance, use get_user_list instead.
Note on connected_to: In single-user mode you supply connected_to to identify the family context. In batch mode this parameter is ignored — the API resolves each user's connected_to automatically from the database.
Request
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": "[email protected]",
"api-token": "cd2e514f-7gab-3cde-62fg-51abcd4e7362",
}
payload = {
"action": "get_info",
"group_id": 100909072,
"clogin_id": [102670541, 102715754, 102670540],
"doc": {
"main_email": True,
"_usercart": True,
}
}
get_info_batch_json = json.dumps(payload)
get_info_batch_response = requests.post(
url=users_endpoint,
data=get_info_batch_json,
headers=headers,
timeout=10
)Response
The response contains a users object keyed by string clogin_id. Each slot has the same shape as a standard single-user get_info response. Note that the top-level doc and meta_info fields present in single-user mode are absent here — they appear inside each user's slot instead.
Important: The top-level success: true means the batch call itself succeeded — it does not mean every individual user was found. Always check the success field inside each user's slot.
{
"success": true,
"users": {
"102670541": {
"success": true,
"doc": { "main_email": "[email protected]", "_usercart": { ... } },
"user_info": { "clogin_id": "102670541", "group_id": "100909072", "connected_to": "102670540" },
"meta_info": { "u_name": "Miles Davis", "total_order": "100.00", ... }
},
"102715754": {
"success": true,
"doc": { "main_email": "[email protected]", "_usercart": { ... } },
"user_info": { "clogin_id": "102715754", "group_id": "100909072", "connected_to": "102715737" },
"meta_info": { "u_name": "Kenny Burrell", "total_order": "0.00", ... }
},
"102670540": {
"success": false,
"errors": [ { "msg": "user not found", "msg_type": "error" } ]
}
}
}If the batch call cannot run at all — for example, if an empty array is passed or group_id is missing — the response is:
{
"success": false,
"users": {},
"errors": [ { "msg": "no valid clogin_ids provided", "msg_type": "error", "msg_level": "fatal" } ]
}To iterate over the response:
response_json = get_info_batch_response.json()
if response_json.get("success") and "users" in response_json:
for clogin_id, user_resp in response_json["users"].items():
if user_resp["success"]:
main_email = user_resp["doc"]["main_email"]
user_cart = user_resp["doc"]["_usercart"]
else:
print(f"Failed to fetch user {clogin_id}: {user_resp['errors']}")There are a few additional things to note about batch mode behavior. Duplicate clogin_id values in the array are deduplicated — each user is returned once. Non-numeric or zero ids are silently dropped. Passing an empty array produces a batch-level failure with success: false at the top level. There is no batch size limit enforced at the API layer, so callers are responsible for keeping list sizes reasonable. Finally, doc fields are shared across the whole batch — you cannot request different fields for different users in the same call; make separate calls if you need that.
disable_meta_calc — skipping meta recalculation
By default, get_info recalculates meta_info on every call. For read-only use cases where you only need raw field data — such as cart contents or email addresses — and don't need freshly computed totals, you can skip this step by passing "disable_meta_calc": true at the top level of the request alongside action, group_id, and clogin_id.
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": "[email protected]",
"api-token": "cd2e514f-7gab-3cde-62fg-51abcd4e7362",
}
payload = {
"action": "get_info",
"group_id": 100909072,
"clogin_id": 102715754,
"connected_to": 102715737,
"doc": {
"_usercart": True,
},
"disable_meta_calc": True,
}
get_info_json = json.dumps(payload)
get_info_response = requests.post(
url=users_endpoint,
data=get_info_json,
headers=headers,
timeout=10
)meta_info is still returned in the response, but reflects the last cached state rather than a fresh calculation. The response shape is otherwise identical to a standard get_info call.
Do not use this flag if the caller needs up-to-date balance totals or relies on side effects that recalculation produces. The flag must be the boolean true — string values like "true" or the integer 1 are ignored and the recalculation will run as normal.
Note: In batch mode, meta recalculation is already skipped automatically. Passing disable_meta_calc: true alongside an array clogin_id is harmless but redundant.