admin

Admin Client Detail

Everything an admin needs in one round-trip for the client-detail page.

Returns 404 if the client doesn't exist.

get/api/v1/admin/clients/{client_id}

Request

  • Base URL: https://api.nudgelink.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.nudgelink.co/api/v1/admin/clients/{client_id}
  • Auth: HTTP bearer

Path parameters

client_idstring uuid required

Response

Successful Response

idstring uuid required
emailstring required
company_namestring required
industrystring required
rolestring required
subscription_planstring nullable required
plan_compedboolean required
guarantee_statusstring required
pilot_start_atstring date-time nullable required
pilot_expires_atstring date-time nullable required
created_atstring date-time required
email_verifiedboolean required
totp_enabledboolean required
google_substring nullable required
microsoft_substring nullable required
disabledboolean required
campaign_first_uxboolean
credits_balanceinteger required
credits_includedinteger required
credits_used_this_cycleinteger required
billing_cycle_startstring date-time nullable required
outreach_auto_sendboolean required
languagesstring[] nullable required
calibration_anchorsobject[] nullable
icp_summarystring nullable
icp_criteriastring[]
icp_keywordsstring[]
icp_industriesstring[]
icp_skillsstring[]
icp_locationsstring[]
extra_accounts_countinteger required
avg_deal_size_usdnumber nullable required
has_stripe_subscriptionboolean required
total_paid_usdnumber required
total_refunded_usdnumber required
comped_credits_totalinteger required
net_revenue_usdnumber required
lead_countinteger required
sequence_countsobject required
account_countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.