get_info

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 chil dren 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 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " allfields"\ true } }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 info", "group id" 100909072, "clogin id" 102670541, "connected to" 102670540, "doc" { } } 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 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 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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "with empty fields" false, "doc" { " allfields"\ true } }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 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 api admin\@regpacks com" \\ 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 } }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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { "first name"\ true, "last name"\ true, "will you record an album with jimi hendrix"\ true, "your instrument"\ true, "f 251473 6251473" 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 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 chil dren 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102670540, "doc" { " family" true } }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 info", "group id" 100909072, "clogin id" 102670540, "doc" { " family" true } } get info family json = json dumps(payload) get info family response = requests post(url=users endpoint, data=get info family json, headers=headers, timeout=10) 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " userproducts" true } }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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " userproducts" true } } get info userproducts json = json dumps(payload) get info userproducts response = requests post(url=users endpoint, data=get info userproducts json, headers=headers, timeout=10) 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " userforms" true } }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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " userforms" true } } get info userforms json = json dumps(payload) get info userforms response = requests post(url=users endpoint, data=get info userforms json, headers=headers, timeout=10) 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " usercart" true } }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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " usercart" {"with payment allocation"\ true} } } get info usercart json = json dumps(payload) get info usercart response = requests post(url=users endpoint, data=get info usercart json, headers=headers, timeout=10) 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>\&#xbb; 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " userpayments" true } }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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " userpayments" true } } get info userpayments json = json dumps(payload) get info userpayments response = requests post(url=users endpoint, data=get info userpayments json, headers=headers, timeout=10) 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " usercart" true } }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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " usercart" {"with payment allocation"\ true} } } get info usercart json = json dumps(payload) get info usercart response = requests post(url=users endpoint, data=get info usercart json, headers=headers, timeout=10) 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>\&#xbb; 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 api admin\@regpacks com" \\ h "api token cd2e514f 7gab 3cde 62fg 51abcd4e7362" \\ d '{ "action" "get info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " utm" true } }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 info", "group id" 100909072, "clogin id" 102715754, "connected to" 102715737, "doc" { " utm" true } } get info userpayments json = json dumps(payload) get info userpayments response = requests post(url=users endpoint, data=get info userpayments json, headers=headers, timeout=10) 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" } ] }