latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

Admin APIs
clients

Get Client

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

Path parameters

client_idstring required

Query parameters

include_deletedboolean

Response

Successful Response

keystring required
namestring required
idstring uuid4 required
client_idstring required
extra_infoobject nullable required
is_activeboolean required
tag_idsstring[] required
client_type_idstring uuid4 nullable
sectorstring nullable
is_compliance_managedboolean nullable
is_distributorboolean nullable
account_manager_emailstring email nullable
entity_idsstring[]
industry_idsstring[]
block_compliance'managed' | 'notified' | 'disabled' nullable
plan_tierstring required
transaction_limitnumber nullable
group_idsstring[] nullable
bill_to_emailstring email nullable
bill_to_namestring nullable
payment_method'card' | 'ach' | 'invoice' nullable
stripe_customer_idstring nullable
current_consumptionnumber nullable
address_line_1string nullable
address_line_2string nullable
citystring nullable
statestring nullable
zipstring nullable
countrystring nullable
data_collection_consent_restrictedboolean
mcp_provider_access_follows_apiboolean
block_sample_access_follows_liveboolean
exchange_enabledboolean
subscription_statusstring nullable
deleted_atstring date-time nullable
deletion_reasonstring nullable
created_atstring date-time required
plan_typestring nullable
distributor_client_idstring uuid4 nullable
distributor_namestring nullable