List Customers

Lists all of your existing customers who have been added as users to the GlobalPatron platform.

GET/api/restricted/partner/users
curl --request GET 'https://api.globalpatron.com/api/restricted/partner/users' \
--header 'PartnerId: {YOUR_PARTNER_ID}' \
--header 'PartnerSecret: {YOUR_PARTNER_SECRET_KEY}' \
Response 200 OK 
[
    {
        "email": "[email protected]",
        "provider_name": "partner_7268ca0f-0387-46ne-8b6g-bafc5adbeek2",
        "first_name": "John",
        "last_name": "Smith",
        "stripe_subscription_plan_original_start_date": "0001-01-01T00:00:00",
        "stripe_subscription_plan_last_payment_date": "0001-01-01T00:00:00",
        "partner_client_status": "paying_customer",
        "quota_custom_monthly_form_submissions": "25",
        "quota_custom_total_forms": "1000",
        "quota_custom_total_datalists": "50",
        "quota_custom_total_datalist_entries_per_datalist": "5000",
        "quota_custom_total_file_storage": "1000",
        "quota_custom_total_admin_collaborators": "25",
        "id": "partner_7268ca0f-0387-46ne-8b6g-bafc5adbeek2|40h234d2-2l85-4e8c-8k30-1d41dd7f8510",
        "created_date_utc": "2023-12-08T23:31:38.0310488Z",
        "modified_date_utc": "2023-12-09T01:34:39.7527809Z"
    },
    {
        "email": "[email protected]",
        "provider_name": "partner_7268ca0f-0387-46ne-8b6g-bafc5adbeek2",
        "first_name": "Henry",
        "last_name": "Kippings",
        "stripe_subscription_plan_original_start_date": "0001-01-01T00:00:00",
        "stripe_subscription_plan_last_payment_date": "0001-01-01T00:00:00",
        "partner_client_status": "free_trial",
        "quota_custom_monthly_form_submissions": "10",
        "quota_custom_total_forms": "1",
        "quota_custom_total_datalists": "1",
        "quota_custom_total_datalist_entries_per_datalist": "50",
        "quota_custom_total_file_storage": "1000",
        "quota_custom_total_admin_collaborators": "1",
        "id": "partner_7268ca0f-0387-46ne-8b6g-bafc5adbeek2|7hh424f2-8895-hemc-8x3t-lde1d37u8719",
        "created_date_utc": "2023-12-08T23:31:38.0310488Z",
        "modified_date_utc": "2023-12-09T01:34:39.7527809Z"
    }
]



Add Customer

Adds/Registers your customer as a GlobalPatron user

POST/api/restricted/partner/user
curl --request POST https://api.globalpatron.com/api/restricted/partner/user' \
--header 'Content-Type: application/json' \
--header 'PartnerId: {YOUR_PARTNER_ID}' \
--header 'PartnerSecret: {YOUR_PARTNER_SECRET_KEY}'
Payload Example:
{
    "email_address":"[email protected]",
    "first_name":"Henry",
    "last_name":"Kippings",
    "subscription_status":"free_trial",
    "monthly_form_submissions_quota":"10",
    "total_forms_quota":"1",
    "total_datalists_quota":"1",
    "total_file_storage_quota": 1000
}

Notes

  • Warning: Never create users with a subscription_status of "paying_customer" unless they are genuinely paying customers on your own platform, this is essential to protect the wider community from fraud as non-paying users are far more likely to attempt to abuse the platform and attempt to create phishing forms, for this reason their forms are only accessible to themselves in order to safely "trial" the functionality without harming the wider community.
  • "monthly_form_submissions_quota" is how many form submissions the customer is allowed per month
  • "total_forms_quota" is how many forms the customer is allowed to have in total
  • "total_datalists_quota" is how many datalists the customer is allowed to have in total
  • "total_file_storage_quota" is how many bytes of file storage the customer is allowed to store in total. e.g. 1000000 = 1MB

Response 200 OK 
{
    "id": "{USERS_ID}",
    "message": "User added successfully",
    "action_successful": true,
    "error": ""
}



Update Customer

Updates an existing customers settings

POST/api/restricted/partner/user/{customerEmailAddress}
curl --request POST 'https://api.globalpatron.com/api/restricted/partner/user/[email protected]' \
--header 'Content-Type: application/json' \
--header 'PartnerId: {YOUR_PARTNER_ID}' \
--header 'PartnerSecret: {YOUR_PARTNER_SECRET_KEY}'
Payload Example:
{    
    "first_name":"John",
    "last_name":"Smith",
    "subscription_status":"paying_customer",
    "monthly_form_submissions_quota":"25",
    "total_forms_quota":"1000",
    "total_datalists_quota":"50",
    "total_file_storage_quota": 1000
}

Notes

  • Warning: Never set subscription_status to "paying_customer" unless they are genuinely paying customers on your own platform, this is essential to protect the wider community from fraud as non-paying users are far more likely to attempt to abuse the platform and attempt to create phishing forms, for this reason their forms are only accessible to themselves in order to safely "trial" the functionality without harming the wider community.
  • "monthly_form_submissions_quota" is how many form submissions the customer is allowed per month
  • "total_forms_quota" is how many forms the customer is allowed to have in total
  • "total_datalists_quota" is how many datalists the customer is allowed to have in total
  • "total_file_storage_quota" is how many bytes of file storage the customer is allowed to store in total. e.g. 1000000 = 1MB

Response 200 OK 
{
    "id": "{USERS_ID}",
    "message": "User updated",
    "action_successful": true,
    "error": ""
}



Delete Form User

Deletes an existing form user

DELETE/api/restricted/form/{formId}/usersecurity/{userSecurityDocumentId}
curl --request DELETE 'https://api.globalpatron.com/api/restricted/form/{3b3d22e4-43a9-4a0a-a4d7-54174059ef96}/usersecurity/{3ddfb0b2-5bdb-4705-870d-ee40651ec2ec}' \
--header 'TokenId: XXXXX' \
--header 'TokenSecret: XXXXX'
Response 200 OK 
{
    "id": "",
    "message": "Form collaborator removed successfully",
    "action_successful": true,
    "error": ""
}