Offerings
Authorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault:
1limitnumber · nullableOptionalDefault:
10includestringOptionalExample:
account,issuer,trades,assets,disbursements,draftVersion,publishedVersion,revisions,onboardingReviewedBy,bankAccount,escrowAccount,shareClassissuerNamestringOptional
namestringOptional
accountIdstringOptionalExample:
account_01j1xgme5qeqq97gpdztd7e4a6issuerIdanyOptional
typestring · enumOptionalPossible values:
statusstring · enumOptionalPossible values:
enabledbooleanOptional
managedBystring · enumOptionalPossible values:
versioningTypestring · enumOptionalPossible values:
onboardingStatusstring · enumOptionalPossible values:
complianceReviewstring · enumOptionalPossible values:
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
get
/clients/api/v1/offeringsAuthorizations
X-API-KEYstringRequired
Body
issuerIdstringRequiredExample:
issuer_01jdq2crwke8xskjd840cj79pwshareClassIdany · nullableOptionalExample:
cap_table_share_class_01j1xgme...namestring · min: 2 · max: 150RequiredExample:
Airbnb IPOtypestring · enumRequiredExample:
REG_DPossible values: targetAmountnumber · min: 0.01 · max: 10000000000RequiredExample:
120000raiseAmountnumber · max: 10000000000OptionalExample:
200000minInvestmentnumber · max: 10000000000OptionalExample:
1000maxInvestmentnumber · max: 10000000000OptionalExample:
20000contingencyAmountnumber · max: 10000000000OptionalExample:
5000startAtstring · nullableOptionalExample:
10/20/2024endAtstring · nullableOptionalExample:
10/27/2024activebooleanOptionalExample:
truecancellationPeriodnumber · min: 1 · max: 30 · nullableOptionalExample:
4descriptionany · nullableOptional
managedBystring · enumOptionalPossible values:
assetNamestring · min: 2 · max: 50RequiredExample:
Asset nameassetTypestring · enumRequiredExample:
STOCKPossible values: pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableRequiredExample:
2000totalUnitsnumber · min: 1 · max: 10000000000 · nullableRequiredExample:
5200yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
1200durationnumber · min: 1 · max: 1000 · nullableOptionalExample:
1durationTypestring · enum · nullableOptionalExample:
DAYSPossible values: templatestring · enumOptionalDefault:
STANDARDExample: STANDARDPossible values: tiersnumber[] · nullableOptional
enableBonusbooleanOptionalDefault:
falsehasEscrowbooleanOptional
bankAccountIdany · nullableOptional
escrowAccountIdany · nullableOptional
interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample:
10warrantsEnabledbooleanOptionalDefault:
falseExample: falsetotalSharesinteger · max: 10000000000 · nullableOptionalExample:
1000warrantTermYearsinteger · max: 10000000000 · nullableOptionalExample:
10exercisePricenumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
100warrantPercentagenumber · max: 100 · nullableOptionalExample:
10calculationMethodstring · enum · nullableOptionalExample:
NONEPossible values: incrementThresholdnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
10showTotalRaisedbooleanOptionalDefault:
trueResponses
201
201
application/json
400
400
application/json
401
401
application/json
403
403
application/json
500
500
application/json
post
/clients/api/v1/offeringsAuthorizations
X-API-KEYstringRequired
Query parameters
pagenumber · nullableOptionalDefault:
1limitnumber · nullableOptionalDefault:
10accountIdstringOptionalExample:
account_01j1xgme5qeqq97gpdztd7e4a6hasPendingTradesboolean · nullableOptional
Responses
200
200
application/json
400
400
application/json
401
401
application/json
403
403
application/json
500
500
application/json
get
/clients/api/v1/offerings/summaryAuthorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Query parameters
includestringOptionalExample:
account,issuer,trades,assets,disbursements,draftVersion,publishedVersion,revisions,onboardingReviewedBy,bankAccount,escrowAccount,shareClassResponses
200
200
application/json
idstringRequiredExample:
entityprefix_01j1xgme5qeqq97gpdztd7e4a6__entitystringOptionalExample:
EntitycreatedAtone ofRequiredExample:
2026-03-27T15:47:09.539Zstring · date-timeOptional
string · date-timeOptional
updatedAtone ofRequiredExample:
2026-03-27T15:47:09.539Zstring · date-timeOptional
string · date-timeOptional
deletedAtone of · nullableRequiredExample:
2026-03-27T15:47:09.540Zstring · date-timeOptional
string · date-timeOptional
namestringRequired
tidstring · nullableRequired
typestring · enum · nullableRequiredPossible values:
descriptionstring · nullableRequired
raiseAmountnumber · nullableRequired
targetAmountnumber · nullableRequired
minInvestmentnumber · nullableRequired
maxInvestmentnumber · nullableRequired
contingencyAmountnumber · nullableRequired
startAtstring · date-time · nullableRequired
endAtstring · date-time · nullableRequired
platformstringRequired
platformSettingsstring · nullableRequired
enabledbooleanRequired
accountIdstring · nullableRequired
issuerany · nullableOptional
issuerIdstring · nullableRequired
coverArtIdany · nullableOptional
coverArtany · nullableRequired
cancellationPeriodnumber · nullableRequired
memorandumIdany · nullableOptional
subscriptionAgreementIdany · nullableOptional
managedBystring · enum · nullableRequiredPossible values:
valuationCapnumber · nullableRequired
showTotalRaisedbooleanOptional
hasEscrowbooleanOptional
escrowAgreementFileIdstring · nullableOptional
bankAccountIdstring · nullableOptional
bankAccountany · nullableOptional
escrowAccountIdstring · nullableOptional
escrowAccountany · nullableOptional
warrantsEnabledbooleanOptional
totalSharesnumber · nullableOptional
warrantTermYearsnumber · nullableOptional
exercisePricenumber · nullableOptional
warrantPercentagenumber · nullableOptional
calculationMethodstring · enum · nullableOptionalPossible values:
incrementThresholdnumber · nullableOptional
fullyDilutedSharesnumber · nullableOptional
shareClassIdstring · nullableOptional
soldOutbooleanOptional
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
get
/clients/api/v1/offerings/{id}Authorizations
X-API-KEYstringRequired
Path parameters
idstringRequired
Body
shareClassIdany · nullableOptionalExample:
cap_table_share_class_01j1xgme...namestring · min: 2 · max: 150OptionalExample:
Airbnb IPOtypestring · enumOptionalExample:
REG_DPossible values: targetAmountnumber · max: 10000000000OptionalExample:
120000minInvestmentnumber · max: 10000000000 · nullableOptionalExample:
1000maxInvestmentnumber · max: 10000000000 · nullableOptionalExample:
20000contingencyAmountnumber · max: 10000000000 · nullableOptionalExample:
5000startAtstring · nullableOptionalExample:
10/20/2024endAtstring · nullableOptionalExample:
10/27/2024cancellationPeriodnumber · min: 1 · max: 30 · nullableOptionalExample:
4descriptionany · nullableOptional
memorandumIdany · nullableOptional
subscriptionAgreementIdany · nullableOptional
coverArtIdany · nullableOptional
showTotalRaisedbooleanOptional
issuerIdstringOptionalExample:
issuer_01jdq2crwke8xskjd840cj79pwassetNamestring · min: 2 · max: 50OptionalExample:
ZassetTypestring · enumOptionalExample:
STOCKPossible values: pricePerUnitnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
2000totalUnitsnumber · min: 1 · max: 10000000000 · nullableOptionalExample:
5200yieldnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
1200durationnumber · min: 1 · max: 1000 · nullableOptionalExample:
1durationTypestring · enum · nullableOptionalExample:
DAYSPossible values: templatestring · enum · nullableOptionalDefault:
STANDARDExample: STANDARDPossible values: tiersnumber[] · nullableOptional
enabledbooleanOptional
enableBonusbooleanOptional
hasEscrowbooleanOptional
escrowAgreementFileIdany · nullableOptional
bankAccountIdany · nullableOptional
escrowAccountIdany · nullableOptional
interestRatenumber · min: 0.01 · max: 100 · nullableOptionalExample:
10warrantsEnabledbooleanOptionalExample:
falsetotalSharesinteger · max: 10000000000 · nullableOptionalExample:
1000warrantTermYearsinteger · max: 10000000000 · nullableOptionalExample:
10exercisePricenumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
100warrantPercentagenumber · max: 100 · nullableOptionalExample:
10calculationMethodstring · enum · nullableOptionalExample:
NONEPossible values: incrementThresholdnumber · min: 0.01 · max: 10000000000 · nullableOptionalExample:
10Responses
201
201
application/json
400
400
application/json
401
401
application/json
403
403
application/json
404
404
application/json
500
500
application/json
patch
/clients/api/v1/offerings/{id}Last updated