/
CA
carbonarc
/
Carbon Arc - Client Admin API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 6h ago · Updated 2d ago
View markdown
carbonarc
Carbon Arc - Client Admin API
get
Check Username Availability
latest
OpenAPI 3.1.0
2026-08-21
866
757
1.2 MB
a8ca30023371
Admin APIs
644
Billing Webhooks
1
Integration APIs
20
Okta Event Hook
2
Portal APIs
6
Super Admin APIs
5
System
1
User APIs
184
get
Get Suspension Status
post
Authorize Product User
post
Authorize
post
Set Auth Cookie
post
Clear Auth Cookie
post
Initiate Signup
post
Verify Email Code
post
Resend Email Verification
post
Create Checkout Session
post
Create Signup Billing Portal
get
Get Signup Status
get
Is Signup Complete
get
Get Wholesale Signup Link
post
Initiate Wholesale Signup
post
Complete Wholesale Signup
get
Get Customer Portal Url
get
Get Available Plans
post
Reactivate Subscription
get
Get Latest Tou
post
Accept Tou
post
Report Tou Load Failure
get
Get Latest Privacy Policy
get
Get Featured Items
get
Get Featured Entities
get
Get Featured Insights
get
Get Tags
get
Get Client Info
get
Get User Profile
get
Check Username Availability
get
Lookup Usernames By Emails
get
Get User Features Access
get
Get User Feature Elements Access
get
Get User Provider Accesses
post
Track User Action
get
Get User Team
get
Get User Info
get
Get User Info From Id Token Endpoint
get
Get Client Users From Id Token
patch
Update User Info
patch
Update Data Collection Consent
post
Accept Sample Catalog Disclaimer
get
Get Marketing Preferences
put
Update Marketing Preferences
get
Get User Role
get
Get User Role From Id Token
put
Update User Role
put
Update User Block Role
get
Get User Interests
patch
Update User Interests
post
Regenerate User Api Tokens
post
Reset My Password
post
Reset My Password
patch
Update User Transaction Limit
patch
Update User Allocated Amount
patch
Update User Mcp Daily Limit
post
Bulk Update Mcp Daily Limit
post
Bulk Revoke Own User Mcp Access
post
Bulk Restore Own User Mcp Access
post
Revoke Own User Mcp Access
post
Restore Own User Mcp Access
post
Reset User Consumption
get
Get User Consumption Cycles
patch
Update User Group
patch
Update User Onboarding
patch
Update User Profile
post
Add User
post
Add Users
get
Get Client Users
put
Update User
put
Deactivate User
get
Get Delta Sharing
get
Get Client Provider Accesses
put
Update Client Provider Access
get
Get Client Day Lag
post
Update Client Day Lag
get
Get Row Limit
get
Get Client Unmetered Sources
get
Get Client Invoices
get
Get Recurring Token Grant Schedules
get
Get Scheduled Transactions
get
Get Roles
get
Get Client Groups
get
Get Group
delete
Delete Group
patch
Set Default Group
patch
Update Group Transaction Limit
patch
Update Group Allocated Amount
patch
Update Group Mcp Period Limit
post
Create Group
patch
Update Group Block Role
post
Revoke Own Group Mcp Access
post
Restore Own Group Mcp Access
get
Get Client Balance
get
Get Expiry Schedule With Balance
get
List Platform Transactions
get
List Mcp Transactions
get
Get Wallet Summary
get
Get Mcp Daily Window
get
Get S3 Summary
get
Get S3 Vesting Schedule
get
List S3 Transactions
get
List S3 Upcoming Invoices
post
Apply S3 Tokens
delete
Remove S3 Application
put
Set S3 Auto Apply
get
Get Token Usage Summary
post
Purchase Token Grants
get
Get User Plan
get
Get User Plans
post
Create Invoice
get
Get Customer Invoices
get
Get Failed Invoices
get
Get Invoice
post
Send Invoice Email
post
Retry Failed Payment
get
Get User Builder Favorites
post
Create Builder Favorite
put
Update Builder Favorite
delete
Delete Builder Favorite
get
Get Tickers
post
Create Cart Status
put
Update Cart Status
get
Get Notifications
get
Get Unread Count
get
Get Notification
patch
Update Notification Status
post
Mark Notification As Read
post
Archive Notification
get
List Block Datasets
get
Download Compliance Tear Sheet
get
Get Block Query Engine Credentials
post
Rotate Block Polaris Credentials
post
Register Sample Arns
post
Register Block Arns
get
List Arns
get
Get Bucket Path
delete
Deregister Arn
get
List Block Requests
post
Create Block Request
get
List Block Contracts
get
Open Block Invoice
get
List Client Block Admins
get
List Dataset Preapprovals
put
Add Dataset Preapproval
delete
Remove Dataset Preapproval
get
List Client Compliance Admins
get
Get Block Request
post
Cancel Block Request
patch
Update Block Request Recipients
post
Request Block Request Cancellation
post
Approve Block Request Cancellation
post
Reject Block Request Cancellation
post
Approve Block Request
post
Reject Block Request
post
Compliance Approve Block Request
post
Compliance Reject Block Request
get
Get Block Settings
put
Update Block Settings
get
List Distributor View Contracts
get
Get Distributor View Contract
get
List Wholesale Clients
get
Get Wholesale Client
get
List Tier Change Options
post
Apply Tier Change
get
List Distributor View Tier Changes
post
Deactivate Wholesale Client
post
Reactivate Wholesale Client
get
List Wholesale Client Users
get
List Signup Links
post
Check Signup Link Conflicts
post
Bulk Create Signup Links
post
Revoke Signup Link
post
Restore Signup Link
patch
Update Signup Link
get
Distributor View Activity
get
Distributor View Team
post
Distributor View Grant Team Access
get
Distributor View Team Candidates
post
Distributor View Create Team Users
delete
Distributor View Revoke Team Access
put
Distributor View Set Team Prompt Access
get
List Distributor Prompts
get
List Distributor Prompt Tools
get
Distributor Prompts Csv
get
Perform Healthcheck
get
Perform Healthcheck
get
Perform Healthcheck
User APIs
users
Check Username Availability
get
/api/v1/users/username-availability
Query parameters
username
string
required
Response
Successful Response
UsernameAvailabilityResponse
required
username
string
required
available
boolean
required
suggestion
string
nullable