Integrate CyberHoot into your tech stack

Example:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/ \
-u <API_KEY>: \
-d customer_id=1000 \
-G

Response Fields:

[id] => INTEGER (id of user)
[parent_user_id] => INTEGER (DEPRECATED)
[new_user_id] => INTEGER (DEPRECATED)
[date_created] => INTEGER (UNIX timestamp)
[customer_id] => INTEGER
[compliant] => STRING (yes or no)
[first_name] => STRING
[last_name] => STRING
[email_address] => STRING
[manager_id] => INTEGER
[user_type] => STRING
[external_id] => STRING
[onboarding_email_sent] => INTEGER (1 = sent, 0 = not sent)
[onboarding_email_sent_date] => INTEGER (UNIX timestamp)
[phishing_difficulty] => STRING
[reset_phishing_difficulty] => STRING
[hoot_score] => INTEGER (will send ‘n/a’ when not applicable)
[video_score] => INTEGER (will send ‘n/a’ when not applicable)
[phishing_score] => INTEGER (will send ‘n/a’ when not applicable)
[policy_score] => INTEGER (will send ‘n/a’ when not applicable)
[optional_score] => INTEGER (will send ‘n/a’ when not applicable)
[completed_assignments] => INTEGER
[num_attempts] => INTEGER (attempts to complete assignments)
[hoot_rank] => STRING
[archived_date] =>  INTEGER (UNIX timestamp)
[active] => INTEGER (1 = active in system, 0 = not active)
[manager_first_name] => STRING (DEPRECATED)
[manager_last_name] => STRING (DEPRECATED)
[manager_email_address] => STRING (DEPRECATED)
[error] => STRING
[complianceInfo] => ARRAY (
[compliantCount] => INTEGER
)
[assignments] => ARRAY (
[active] => ARRAY (

            [0] => ARRAY (
[id] => INTEGER
[name] => STRING
[type] => STRING
[completed_date] => INTEGER (UNIX timestamp)
)

)

)
[pending] => ARRAY (

             [0] => ARRAY (
[id] => INTEGER
[name] => STRING
[type] => STRING
[completed_date] => INTEGER (UNIX timestamp)
)

)

    [archived] => ARRAY (
[0] => ARRAY (
[id] => INTEGER
[name] => STRING
[type] => STRING
[completed_date] => INTEGER (UNIX timestamp)
)
)

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/ \
-u <API_KEY>: \

  -d customer_id=1000 \
-d id=1001 \
-G

Response Fields:

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/hoot-ranks/user/ \
-u <API_KEY>: \
-G

Response Fields:

[
“hoot rank ID”: {
“id”: STRING (ID of HootRank),
“jsonFile”: STRING (Location of information file),
“name”: STRING (Name of HootRank),
“training_threshold”: STRING (Amount of assignments user must complete to achieve this HootRank),
“training_threshold_desc”: STRING (Description of amount of assignments users must complete to achieve this HootRank),
“score_threshold”: STRING (Score user must have to achieve this HootRank),
“score_threshold_desc”: STRING (Description of how scoring works to achieve this HootRank),
“description”: STRING (Description of this HootRank),
“image”: STRING (Path to HootRank owl image),
“image_icon”: STRING (Path to HootRank owl icon image),
“color”: STRING (bootstrap color of badge),
“contrast_color”: STRING (contrast color)
}
]

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/hoot-ranks/users/user-hoot-rank.php \
-u <API_KEY>: \

  -d customer_id=1000 \
-d user_id=1001 \
-G

Response Fields:

{
“hootRank”: STRING (ID of HootRank),
“hootScore”: INT (Current HootScore),
“videoScore”: INT (Current video score),
“phishingScore”: INT (Current Phishing score),
“policyScore”: INT (Current policy score),
“badgeImage”: STRING (Path to HootRank owl image),
“badgeIcon”: STRING (Path to HootRank owl icon image),
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/logs/email-logs.php \
-u <API_KEY>: \

  -d customer_id=1000 \
-d user_id=1001 \
-G

Response Fields:

{
“sent_time”: INTEGER (UNIX timestamp of when email was sent),
“status”: STRING (DELIVERED or BOUNCED),
“email_subject”: STRING (Subject of email),
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/groups/ \
-u <API_KEY>: \
-d customer_id=1000 \
-G

Response Fields:

[id] => INTEGER (id of group)
[name] => STRING
[hr_first_name] => STRING
[hr_last_name] => STRING
[hr_email] => STRING
[group_type] => STRING
[external_id] => STRING
[users] => ARRAY (
[45] => ARRAY (
[id] => INTEGER (id of user in group)
[name] => STRING
[email] => STRING

)

[assignments] => ARRAY (
[active] => ARRAY (
[772] => ARRAY (
[id] => INTEGER (id of training)
[name] => STRING
[type] => STRING
)
)

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/groups/ \
-u <API_KEY>: \

  -d customer_id=1000 \
-d id=1001 \
-G

Response Fields:

Same as the Get Groups request.

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/assignments/ \
-u <API_KEY>: \
-d customer_id=1000 \
-G

Response Fields:

[id] => INTEGER (id of assignment)
[policy_name] => STRING
[policy_type] => STRING
[is_optional] => INTEGER (1 = optional, 0 = required)
[effective_start] => INTEGER (Date format:  YYYYMMDD)
[effective_end] => INTEGER (Date format:  YYYYMMDD)
[policy_file_name] => STRING (could be a file name or URL)
[policy_file_type] => STRING
[public] => INTEGER (1 = public, 0 = not public)
[archived] => INTEGER (1 = archived, 0 = not archived)
[groups] => ARRAY (
[1] => ARRAY (
[group_id] => INTEGER
[group_name] => STRING
)
)

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/assignments/ \
-u <API_KEY>: \

  -d customer_id=1000 \
-d id=1001 \
-G

Response Fields:

Same as the Get Assignments request.

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/reports/training-history/ \
-u <API_KEY>: \

  -d customer_id=1000 \
-d archived=1 \
-G

Response Fields:

{
“policyId”: {
“policyName”: Training name,
“policyType”: Type of policy this is (policy, video, or phishing),
“effectiveStart”: INTEGER (Date format YYYYMMDD),
“effectiveEnd”: INTEGER (Date format YYYYMMDD),
“overallCompliance”: INTEGER (compliance score for this policy)
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/reports/training-history/training-users-compliance.php \
-u <API_KEY>: \

  -d customer_id=1000 \
-d policy_id=10 \
-G

Response Fields:

{
“policyName”: Training Name,
“users”: [
{
“compliant”: STRING (user compliance status),
“userFirstName”: STRING (user first name),
“userLastName”: STRING (user last name),
“managerId”: INTEGER (ID of manager),
“managerFullName”: STRING (manager full name),
“score”: INTEGER (Users score on this training),
“attempts”: INTEGER (Number of attempts user has taken on this training),
“dateLastSent”: STRING (Last email notification date/time),
“dateResponded”: STRING (When user responded date/time),
},
],
“overview”: {
“percentCompliant”: INTEGER (Overall compliance percentage of all users for this training),
“percentResponded”: INTEGER (Percent of assigned users who have responded to this training),
“percentNotResponded”: INTEGER (Percent of assigned users who have not responded to this training)
}
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/policy-response/training-history.php \
-u <API_KEY>: \

  -d customer_id=1000 \
-d user_id=10 \
-G

Response Fields:

[
“user policy response ID”: {
“id”: INT (ID of the user’s policy response),
“policyId”: INT (ID of the policy),
“policyType”: STRING (type of training: policy, video or phishing),
“dateLastSent”: STRING (Date of last email sent to user for this policy – YYYY-MM-DD, h:ia format),
“userFirstOpenedDate”: STRING (Date user first opened email for this policy – YYYY-MM-DD, h:ia format),
“dateResponded”: STRING (Date user responded to this policy – YYYY-MM-DD, h:ia format),
“fourthEmailSentDate”: STRING (Date HR email was sent – YYYY-MM-DD, h:ia format),
“thirdEmailSentDate”: STRING (Date manager email was sent – YYYY-MM-DD, h:ia format),
“secondEmailSentDate”: STRING (Date reminder email was sent – YYYY-MM-DD, h:ia format),
“firstEmailSentDate STRING (Date initial was sent – YYYY-MM-DD, h:ia format),
“accepted”: INT (1 if user has accepted the policy, otherwise 0),
“firstEmailNeeded”: STRING (Yes or no),
“secondEmailNeeded”: STRING (Yes or no),
“thirdEmailNeeded”: STRING (Yes or no),
“fourthEmailNeeded”: STRING (Yes or no),
“notificationNeeded”: STRING (Yes or no),
“whichNotification”: INT (Which notification is needed, 1-4),
“questionScore”: STRING (serialized data of user scoring details),
“quizResults”: STRING (serialized data of user quiz results details),
“userGroupName”: STRING (Name of group user is a part of that is assigned to this policy),
“policyName”: STRING (Policy name),
“isOptional”: INT (1 if policy is optional, otherwise 0),
“questionEnabled”: INT (1 if quiz is enabled, otherwise 0),
“policyStatus”: STRING (Active, Pending, or Archived),
“emailExpiresDate”: “20240405”,
“effectiveStart”: INT (Date policy starts, YYYYMMDD format),
“effectiveEnd”: INT (Date policy ends, YYYYMMDD format),
“firstNotifyDate”: INT (Date initial email gets sent, YYYYMMDD format),
“secondNotifyDate”: INT (Date reminder email gets sent, YYYYMMDD format),
“thirdNotifyDate”: INT (Date manager email gets sent, YYYYMMDD format),
“fourthNotifyDate”: INT (Date HR email gets sent, YYYYMMDD format),
“notificationName”: STRING (Current notification that is needed),
“status”: STRING (users current status/step in the policy response),
},
]

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/policy-response/training-history-details.php \
-u <API_KEY>: \

  -d customer_id=1000 \
-d user_id=10 \

 -d policy_id=100 \
-G

Response Fields:

{
“dateLastSent”: STRING (Date of last email sent to user for this policy – YYYY-MM-DD, h:ia format),
“userFirstOpenedDate”: STRING (Date user first opened email for this policy – YYYY-MM-DD, h:ia format),
“dateResponded”: STRING (Date user responded to this policy – YYYY-MM-DD, h:ia format),
“fourthEmailSentDate”: STRING (Date HR email was sent – YYYY-MM-DD, h:ia format),
“thirdEmailSentDate”: STRING (Date manager email was sent – YYYY-MM-DD, h:ia format),
“secondEmailSentDate”: STRING (Date reminder email was sent – YYYY-MM-DD, h:ia format),
“firstEmailSentDate STRING (Date initial was sent – YYYY-MM-DD, h:ia format),
“accepted”: INT (1 if user has accepted the policy, otherwise 0),
“firstEmailNeeded”: STRING (Yes or no),
“secondEmailNeeded”: STRING (Yes or no),
“thirdEmailNeeded”: STRING (Yes or no),
“fourthEmailNeeded”: STRING (Yes or no),
“notificationNeeded”: STRING (Yes or no),
“whichNotification”: INT (Which notification is needed, 1-4),
“questionScore”: STRING (serialized data of user scoring details),
“userGroupName”: STRING (name of group user is a part of that is assigned to this policy)
“policyName”: STRING (Policy name),
“questionEnabled”: INT (1 if quiz is enabled, otherwise 0),
“policyType”: STRING (Type of training: Video, Policy or Phishing),
“effectiveStart”: STRING (Date policy starts),
“effectiveEnd”: STRING (Date policy ends),
“firstNotifyDate”: STRING (Date initial email is sent),
“secondNotifyDate”: STRING (Date reminder email is sent),
“thirdNotifyDate”: STRING (Date manager email is sent),
“fourthNotifyDate”: STRING (Date HR email is sent)
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/exposed-users/exposed-users-all.php/ \
-u <API_KEY>: \
-d customer_id=1000 \
-G

[test@example.com] => ARRAY (
[userId] => INTEGER (if field is not returned, the email is not attached to a user in the system)
[name] => STRING
[firstBreachDate] => INTEGER (Date format:  YYYYMMDD)
[latestBreachDate] => INTEGER (Date format:  YYYYMMDD)
[unacknowledgedExposures] => INTEGER
[breachCount] => INTEGER
)

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/exposed-users/exposed-user.php/ \
-u <API_KEY>: \

  -d customer_id=1000 \
-d user_id=1001 \
-G

[userName] => STRING
[userEmail] => STRING
[pwnedBreaches] => ARRAY (
[1] => ARRAY (
[breachDate] => INTEGER (Date format:  YYYYMMDD)
[dateFound] => INTEGER (Date format:  YYYYMMDD)
[breachId] => INTEGER
[logoPath] => STRING (URL of logo)
[title] => STRING
[description] => STRING
[affected] => STRING (number of people affected with commas)
[dataClasses] => STRING (comma-delimited list of affected data)
[acknowledged] => INTGER (1 = yes, 0 = no)
[breachJoinId] => INTEGER
)
)
[dehashedBreaches] => ARRAY (
[3] => ARRAY (
[error] => STRING
[id] => INTEGER
[dehashed_id] => INTEGER
[email] => STRING
[ip_address] => STRING
[username] => STRING
[password] => STRING
[hashed_password] => STRING
[name] => STRING
[vin] => STRING
[address] => STRING
[phone] => STRING
[database_name] => STRING
[acknowledged] => INTEGER (1 = yes, 0 = no)
[date_found] => INTEGER (Date format:  YYYYMMDD)
[active] => INTGER (1 = active, 0 = inactive)
)

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/exposed-users/notify-all.php/ \
-u <API_KEY>: \

  -d customer_id=1000 \
-d message=’Example Message’ \
-P

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/users/exposed-users/notify.php/ \
-u <API_KEY>: \

  -d customer_id=1000 \

  -d user_id=1001 \
-d message=’Example Message’ \

 – d emails=’test@example.com,test2@example.com’
-P

Response Fields:

Example:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/administrators/ \
-u <API_KEY>: \
-G

[id] => INTEGER (id of administrator)
[first_name] => STRING
[last_name] => STRING
[email_address] => STRING
[phone_number] => STRING
[password] => STRING
[force_pw_change] => INTEGER (1 = force, 0 = no force)
[tos_accept_date] => INTEGER (UNIX timestamp)
[last_login_date] => INTEGER (UNIX timestamp)
[site_admin] => INTEGER (1 = is site admin, 0 = is not site admin)
[customer_id] => INTEGER
[primary_customer_Id] => INTEGER
[date_created] => INTEGER (UNIX timestamp)
[reset_password_hash] => STRING
[reset_password_timestamp] =>  INTEGER (UNIX timestamp)
[verified] => INTEGER
[verify_hash] => STRING
[row_limit] => INTEGER
[browser_version] => STRING
[timezone] => STRING
[2fa_token] => STRING
[2fa_token_expiration_date] =>  INTEGER (UNIX timestamp)
[authentication_method] => STRING
[authenticator_app_secret_key] => STRING
[link_auth] => STRING
[2fa_bypass_token] => STRING
[2fa_bypass_token_expiration] => INTEGER (UNIX timestamp)
[active] => INTEGER (1 = active, 0 = not active)

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/administrators/ \
-u <API_KEY>: \
-d id=1000 \
-G

Response Fields:

Same as the Get Administrators request.

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/training/ \
-u <API_KEY>: \
-d customer_id=1000 \
-G

[trainings] => ARRAY (
[1] => ARRAY (
[id] => INTEGER (id of training)
[parent_policy_id] => INTEGER
[renewed_policy_id] => INTEGER
[customer_id] => INTEGER
[effective_start] => INTEGER (Date format: YYYYMMDD)
[effective_end] => INTEGER (Date format: YYYYMMDD)
[effective_duration_value] => INTEGER
[effective_duration_type] => STRING
[enable_renew_date] => INTEGER (1 = yes, 0 = no)
[renew_date] => INTEGER (Date format: YYYYMMDD)
[renew_warning_days] => INTEGER
[acceptance_window] => INTEGER
[beginning_of_acceptance_window] => INTEGER (Date format: YYYYMMDD)
[warning_notification_days] => INTEGER
[hr_notification_days] => INTEGER
[policy_name] => STRING
[policy_file_name] => STRING (could be a file name or URL)
[policy_file_type] => STRING
[policy_message] => STRING
[end_user_refusal_message] => STRING
[first_notice_subject] => STRING
[warning_notice_subject] => STRING
[expiration_notice_subject] => STRING
[hr_notice_subject] => STRING
[hr_notice_email] => STRING
[first_notice_email] => STRING
[warning_notice_email] => STRING
[expiration_notice_email] => STRING
[send_first_notice_email] => INTEGER ( 1 = yes, 0 = no)
[send_warning_notice_email] => INTEGER ( 1 = yes, 0 = no)
[send_expiration_notice_email] => INTEGER ( 1 = yes, 0 = no)
[send_hr_notice_email] => INTEGER ( 1 = yes, 0 = no)
[fixed_acceptance_date] => INTEGER ( 1 = yes, 0 = no)
[policy_type] => STRING
[public] => INTEGER ( 1 = yes, 0 = no)
[report_admin_csv] => STRING
[report_email_csv] => STRING
[question_enabled] => INTEGER ( 1 = yes, 0 = no)
[question_passing_score] => DECIMAL
[is_optional] => INTEGER ( 1 = yes, 0 = no)
[archived] => INTEGER ( 1 = yes, 0 = no)
[training_program_id] => INTEGER
[training_program_instance_id] => INTEGER
[library_id] => INTEGER
[library_type] => STRING
[library_version] => INTEGER
[version] => INTEGER
[retake_override] => INTEGER ( 1 = yes, 0 = no)
[phishing_difficulty] => STRING
[overall_compliance] => INTEGER
[deployment] => DEPRECATED
[groupsArr] => STRING
[error] => STRING
[active] => INTEGER ( 1 = active, 0 = inactive)
)

[compliance] => ARRAY (
[1] => ARRAY (
[policyName] => STRING
[policyType] => STRING
[overallCompliance] => INTEGER
)
)

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/automated-training/foundational.php \
-u <API_KEY>: \
-d customer_id=1000 \
-G

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/automated-training/ \
-u <API_KEY>: \
-d customer_id=1000 \
-G

Response Fields:

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/automated-phishing/ \
-u <API_KEY>: \
-d customer_id=1000 \
-G

Response Fields:

Same as the Get Training Schedule request.

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/partner/settings/ \
-u <API_KEY>: \
-G

Response Fields:

[id] => INTEGER
[full_name] => STRING
[short_name] => STRING
[contact_email] => STRING
[contact_phone] => STRING
[website] => STRING
[service_name] => STRING
[sales_module_report_msg] => STRING
[sales_enabled] => INTEGER (1 = yes, 0 = no)
[whitelabel_certificate_of_completion] => INTEGER (1 = yes, 0 = no)
[primary_color] => HEX Color
[secondary_color] =>HEX Color
[ch_color_override] => INTEGER (1 = yes, 0 = no)
[show_wizard] => INTEGER (1 = yes, 0 = no)
[api_key] => STRING
[timezone] => STRING
[cust_id] => INTEGER

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/customers/reports/training-history/index.php / \ -u <API_KEY>: \ -d type=msp-marketing \ -G

Response Fields:

{
“downloadUrl”: URL to download the generated .zip file
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/languages/ \
-u <API_KEY>: \
-G

Response Fields:

{
“language ID”: {
“error”: BOOL (True if error, otherwise null),
“id”: INT (ID of language),
“language”: STRING,
“language_code”: STRING,
“active”: INT
}
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/partner/subscription/ \
-u <API_KEY>: \
-G

Response Fields:

[spawCustomerId] => INTEGER
[subscriptionId] => STRING (Stripe subscription ID)
[billingCustomerId] => STRING (Stripe customer ID)
[customerInfoArray] => ARRAY (
[id] => STRING (Stripe customer ID)
[object] => STRING
[account_balance] => INTEGER
[address] => ARRAY (
[city] => STRING
[country] => STRING
[line1] => STRING
[line2] => STRING
[postal_code] => STRING
[state] => STRING
)
[balance] => INTEGER
[created] => INTEGER (UNIX timestamp)
[currency] => STRING
[default_currency] => STRING
[default_source] => STRING
[delinquent] => STRING
[description] => STRING
[discount] => STRING
[email] => STRING
[invoice_prefix] => STRING
[invoice_settings] => ARRAY (
[custom_fields] => STRING
[default_payment_method] => STRING
[footer] => STRING
[rendering_options] => STRING
)
[livemode] => STRING
[metadata] => Array
(
)
[name] => STRING
[next_invoice_sequence] => INTEGER
[phone] => STRING
[preferred_locales] => Array
(
[0] => STRING
)
[shipping] => STRING
[sources] => ARRAY (
[object] => STRING
[data] => ARRAY (
)
[has_more] => STRING
[total_count] => INTEGER
[url] => STRING
)
[subscriptions] => ARRAY (
[object] => STRING
[data] => ARRAY (
)
[has_more] => STRING
[total_count] => INTEGER
[url] => STRING
)
[tax_exempt] => STRING
[tax_ids] => ARRAY (
[object] => STRING
[data] => ARRAY (
)
[has_more] => STRING
[total_count] => INTEGER
[url] => STRING
)
[tax_info] => STRING
[tax_info_verification] => STRING
[test_clock] => STRING
[subscription] => ARRAY (
[id] => STRING
[object] => STRING
[application] => STRING
[application_fee_percent] => DECIMAL
[automatic_tax] => ARRAY (
[enabled] => STRING
[liability] => STRING
)
[billing] => STRING
[billing_cycle_anchor] => STRING
[billing_cycle_anchor_config] => STRING
[billing_thresholds] => STRING
[cancel_at] => INTEGER (UNIX timestamp)
[cancel_at_period_end] => INTEGER (UNIX timestamp)
[canceled_at] => INTEGER (UNIX timestamp)
[cancellation_details] => ARRAY (
[comment] => STRING
[feedback] => STRING
[reason] => STRING
)
[collection_method] => STRING
[created] => INTEGER (UNIX timestamp)
[currency] => STRING
[current_period_end] => INTEGER (UNIX timestamp)
[current_period_start] => INTEGER (UNIX timestamp)
[customer] => STRING
[days_until_due] => INTEGER
[default_payment_method] => STRING
[default_source] => STRING
[default_tax_rates] => ARRAY(
)
[description] => STRING
[discount] => STRING
[ended_at] => INTEGER (UNIX timestamp)
[invoice_customer_balance_settings] => ARRAY (
[consume_applied_balance_on_void] => INTEGER
)
[invoice_settings] => ARRAY (
[account_tax_ids] => STRING
[issuer] => ARRAY (
[type] => STRING
)
)
[items] => ARRAY (
[object] => STRING
[data] => ARRAY (
[0] => ARRAY (
[id] => STRING
[object] => STRING
[billing_thresholds] => STRING
[created] => INTEGER (UNIX timestamp)
[metadata] => ARRAY (
)
[plan] => ARRAY (
[id] => STRING
[object] => STRING
[active] => INTEGER
[aggregate_usage] => STRING
[amount] => INTEGER
[amount_decimal] => DECIMAL
[billing_scheme] => STRING
[created] => INTEGER (UNIX timestamp)
[currency] => STRING
[interval] => STRING
[interval_count] => INTEGER
[livemode] => STRING
[metadata] => ARRAY (
)
[nickname] => STRING
[product] => STRING
[tiers] => STRING
[tiers_mode] => STRING
[transform_usage] => STRING
[trial_period_days] => INTEGER
[usage_type] => STRING
)
[price] => ARRAY (
[id] => STRING
[object] => STRING
[active] => INTEGER
[billing_scheme] => STRING
[created] => INTEGER (UNIX timestamp)
[currency] => STRING
[custom_unit_amount] => INTEGER
[livemode] => STRING
[lookup_key] => STRING
[metadata] => ARRAY (
)
[nickname] => STRING
[product] => STRING
[recurring] => ARRAY (
[aggregate_usage] => STRING
[interval] => STRING
[interval_count] => INTEGER
[trial_period_days] => INTEGER
[usage_type] => STRING
)
[tax_behavior] => STRING
[tiers_mode] => STRING
[transform_quantity] => INTEGER
[type] => STRING
[unit_amount] => INTEGER
[unit_amount_decimal] => DECIMAL
)
[quantity] => INTEGER
[subscription] => STRING
[tax_rates] => ARRAY (
)
)
)
[has_more] => STRING
[total_count] => INTEGER
[url] => STRING
)
[latest_invoice] => STRING
[livemode] => STRING
[metadata] => ARRAY (
)
[next_pending_invoice_item_invoice] => STRING
[on_behalf_of] => STRING
[pause_collection] => STRING
[payment_settings] => ARRAY (
[payment_method_options] => STRING
[payment_method_types] => STRING
[save_default_payment_method] => STRING
)
[pending_invoice_item_interval] => STRING
[pending_setup_intent] => STRING
[pending_update] => STRING
[plan] => ARRAY (
[id] => STRING
[object] => STRING
[active] => INTEGER
[aggregate_usage] => STRING
[amount] => INTEGER
[amount_decimal] => DECIMAL
[billing_scheme] => STRING
[created] => INTEGER (UNIX timestamp)
[currency] => STRING
[interval] => STRING
[interval_count] => INTEGER
[livemode] => STRING
[metadata] => ARRAY (
)

[nickname] => STRING
[product] => STRING
[tiers] => STRING
[tiers_mode] => STRING
[transform_usage] => STRING
[trial_period_days] => STRING
[usage_type] => STRING
[quantity] => INTEGER
[schedule] => STRING
[start] => INTEGER (UNIX timestamp)
[start_date] => INTEGER (UNIX timestamp)
[status] => STRING
[tax_percent] => DECIMAL
[test_clock] => STRING
[transfer_data] => STRING
[trial_end] => INTEGER (UNIX timestamp)
[trial_settings] => ARRAY (
[end_behavior] => ARRAY (
[missing_payment_method] => STRING
)
)
[trial_start] => INTEGER
[referral_info] => STRING
[isReseller] => INTEGER
[cancelFeedback] => STRING
[primaryCustomerId] => INTEGER
[nextInvoiceAmount] => DECIMAL

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/partner/email-logs/delivered/ \

-u <API_KEY>: \

-G

Response Fields:

{
‘totalRecords’ : INT (The total number of records available in the table)
‘totalFiltered’: INT (The total number of records found in the search)
‘data’ : [record ID] => [
{
‘toEmail’ : STRING (The email address delivered to)
‘emailSubject’: STRING (Subject of email)
‘sentTime’: INT (Unix timestamp of when email was sent)
}
]
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/partner/email-logs/bounced/ \

-u <API_KEY>: \

-G

Response Fields:

{
‘totalRecords’ : INT (The total number of records available in the table)
‘totalFiltered’: INT (The total number of records found in the search)
‘data’ : [record ID] => [
{
‘toEmail’ : STRING (The email address delivered to),
‘fromEmail’: STRING (The email address sent from),
‘bounceType’ STRING (Type of bounce, complaint or bounce),
‘emailSubject’: STRING (Subject of email),
‘sentTime’: INT (Unix timestamp of when email was sent)
}
]
}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/partner/email-logs/complaints/ \

-u <API_KEY>: \

-G

Response Fields:

{
“entryId”: {
“toEmail”: STRING (email address that email was delivered to),
“fromEmail”: STRING (email address that email was sent from),
“emailSubject”: STRING (email subject),
“emailSources”: STRING (comma separated list of where this email address can be found in customers),
“customers”: STRING (comma separated list of where this email address can be found across customers),
“complaintFeedbackType”: STRING (What type of complaint this is),
“complaintSubType”: STRING (Sub Type of complaint),
“userAgent”: STRING (User Agent),
“sentTime”: STRING (unix timestamp of when the email was sent),
}

}

Example Request:

curl https://<DEPLOYMENT_SUBDOMAIN>.cyberhoot.com/api/partner/email-logs/suppressed/ \

-u <API_KEY>: \

-G

Response Fields:

{
“entryId”: {
“email”: STRING (email address of the suppressed email),
“suppressionReason”: STRING (Reason email address is undeliverable),
“emailSources”: STRING (comma separated list of where this email address can be found in customers),
“customers”: STRING (comma separated list of where this email address can be found across customers),
“addedTime”: STRING (unix timestamp of when the email was added to the list),
}

}