Issuer API

Below is our API that is available to Issuers with an active Issuer account and their Offering's API key. Our production base URL is: http://api.issuance.com/ Our development base URL is: http://django-dev.issuance-dev.com/

get

API endpoint displaying Investments.

Authorizations

AuthorizationstringRequired

Api Key permission with required prefix "Api-Key"

Query parameters

amountnumberOptional

amount__gtnumberOptional

amount__gtenumberOptional

amount__innumber[]Optional

Multiple values may be separated by commas.

amount__ltnumberOptional

amount__ltenumberOptional

created_atstring · date-timeOptional

created_at__date__gtestring · dateOptional

created_at__date__ltestring · dateOptional

created_at__gtestring · date-timeOptional

created_at__instring · date-time[]Optional

Multiple values may be separated by commas.

created_at__ltestring · date-timeOptional

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

investmentapproval__is_approvedbooleanOptional

investmentapproval__is_approved__inboolean[]Optional

Multiple values may be separated by commas.

investorintegerOptional

investor__entityintegerOptional

investor__entity__emailstringOptional

investor__entity__email__instring[]Optional

Multiple values may be separated by commas.

investor__entity__isnullbooleanOptional

investor__entity__kyc_statusstring · enumOptional

unverified - Unverified
processing - Processing
passed - Passed
failed - Failed

Possible values:

investor__entity__kyc_status__instring[]Optional

Multiple values may be separated by commas.

investor__ininteger[]Optional

Multiple values may be separated by commas.

investor__typestring · enumOptional

person - Person
company - Company
trust - Trust
trust_ira - Trust Ira

Possible values:

investor__type__instring[]Optional

Multiple values may be separated by commas.

investor__userintegerOptional

investor__user__emailstringOptional

investor__user__email__instring[]Optional

Multiple values may be separated by commas.

investor__user__entity__entityperson__first_namestringOptional

investor__user__entity__entityperson__first_name__instring[]Optional

Multiple values may be separated by commas.

investor__user__entity__entityperson__last_namestringOptional

investor__user__entity__entityperson__last_name__instring[]Optional

Multiple values may be separated by commas.

investor__user__ininteger[]Optional

Multiple values may be separated by commas.

offeringintegerOptional

offering__ininteger[]Optional

Multiple values may be separated by commas.

offering__namestringOptional

offering__name__instring[]Optional

Multiple values may be separated by commas.

offering__slugstringOptional

offering__slug__instring[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

payment_methodstringOptional

payment_method__instring[]Optional

Multiple values may be separated by commas.

processed_atstring · date-timeOptional

processed_at__date__gtestring · dateOptional

processed_at__date__ltestring · dateOptional

processed_at__gtestring · date-timeOptional

processed_at__instring · date-time[]Optional

Multiple values may be separated by commas.

processed_at__isnullbooleanOptional

processed_at__ltestring · date-timeOptional

processing_issue_statusesstringOptional

processing_issue_statuses__containsstringOptional

processing_issue_statuses__instring[]Optional

Multiple values may be separated by commas.

processing_issue_statuses__startswithstringOptional

quantityintegerOptional

quantity__ininteger[]Optional

Multiple values may be separated by commas.

reference_idstringOptional

reference_id__instring[]Optional

Multiple values may be separated by commas.

requested_payment_methodstring · enumOptional

card - Card
wire - Wire
ira - IRA
other - ACH
crypto - Crypto

Possible values:

requested_payment_method__instring[]Optional

Multiple values may be separated by commas.

searchstringOptional

A search term.

shares_amountnumberOptional

shares_amount__gtnumberOptional

shares_amount__gtenumberOptional

shares_amount__innumber[]Optional

Multiple values may be separated by commas.

shares_amount__ltnumberOptional

shares_amount__ltenumberOptional

statusstring · enumOptional

started - Started
not_received - Not Received
payment_failed - Payment Failed
received - Received
cancelled - Cancelled
refunded - Refunded
invested - Invested
approved - Approved
not_approved - Not Approved
accepted - Accepted
accepted_escrow_closed - Accepted Escrow Closed

Possible values:

status__instring[]Optional

Multiple values may be separated by commas.

updated_atstring · date-timeOptional

updated_at__date__gtestring · dateOptional

updated_at__date__ltestring · dateOptional

updated_at__gtestring · date-timeOptional

updated_at__instring · date-time[]Optional

Multiple values may be separated by commas.

updated_at__ltestring · date-timeOptional

watchlistentity__has_hitsbooleanOptional

watchlistentity__has_hits__inboolean[]Optional

Multiple values may be separated by commas.

Responses

200Success

application/json

get

/api/investments/

GET /api/investments/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "quantity": 1,
      "price": "text",
      "price_fees": "text",
      "price_payment_processing_fees": "text",
      "amount": "text",
      "status": "started",
      "payment_intent_id": "text",
      "offering": 1,
      "reference_id": "text",
      "investor_individual_name": "text",
      "investor": {
        "id": 1,
        "user": {
          "id": 1,
          "email": "[email protected]",
          "first_name": "text",
          "last_name": "text",
          "date_joined": "2026-02-03T22:14:10.373Z",
          "last_login": "2026-02-03T22:14:10.373Z"
        },
        "entity": {
          "id": 1,
          "email": "[email protected]",
          "phone": "text",
          "street_address_1": "text",
          "street_address_2": "text",
          "city": "text",
          "state": "AL",
          "region": "text",
          "postal_code": "text",
          "country": "US",
          "kyc_status": "unverified",
          "first_name": "text",
          "last_name": "text",
          "date_of_birth": "2026-02-03",
          "net_worth": "text",
          "annual_income": "text",
          "accredited_investor": true,
          "citizenship": "United States",
          "us_person": true,
          "exempt_from_backup_withholding": true,
          "amount_invested_in_reg_cf_offering_this_year": "text",
          "accredited_investor_type": "net_worth",
          "tax_id_number": "text"
        },
        "individual_entity": {
          "id": 1,
          "first_name": "text",
          "last_name": "text",
          "email": "[email protected]",
          "phone": "text",
          "kyc_status": "unverified"
        },
        "type": "person",
        "receive_sms": true,
        "receive_emails": true,
        "utm_parameters": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      },
      "payment_method": "text",
      "updated_at": "2026-02-03T22:14:10.373Z",
      "has_investor_signed": true,
      "accredited_investor": true,
      "net_worth": "text",
      "annual_income": "text",
      "us_person": true,
      "exempt_from_backup_withholding": true,
      "amount_invested_in_reg_cf_offering_this_year": "text",
      "user_browser_type": "text",
      "accredited_investor_type": "net_worth",
      "processed_at": "2026-02-03T22:14:10.373Z",
      "received_at": "2026-02-03T22:14:10.373Z",
      "refunded_at": "2026-02-03T22:14:10.373Z",
      "bonus_shares": 1,
      "processing_issue_statuses": "text",
      "shares_amount": "text",
      "watchlistentity_set": [
        {
          "id": 1,
          "entity": 1,
          "has_hits": true,
          "watchlist_hits": null,
          "ofac_fincen_status": "text",
          "updated_at": "2026-02-03T22:14:10.373Z",
          "aml_provider": "text"
        }
      ],
      "bonus_shares_code": "text",
      "bonus_shares_percentage_tier": "text",
      "bonus_shares_quantity_tier": "text",
      "quantity_qualified_shares": 1,
      "price_qualified_shares": "text",
      "invested_at": "2026-02-03T22:14:10.373Z"
    }
  ]
}

get

API endpoint displaying Investments.

Authorizations

AuthorizationstringRequired

Api Key permission with required prefix "Api-Key"

Path parameters

idintegerRequired

A unique integer value identifying this investment.

Responses

200Success

application/json

get

/api/investments/{id}/

GET /api/investments/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "quantity": 1,
  "price": "text",
  "price_fees": "text",
  "price_payment_processing_fees": "text",
  "amount": "text",
  "status": "started",
  "payment_intent_id": "text",
  "offering": 1,
  "reference_id": "text",
  "investor_individual_name": "text",
  "investor": {
    "id": 1,
    "user": {
      "id": 1,
      "email": "[email protected]",
      "first_name": "text",
      "last_name": "text",
      "date_joined": "2026-02-03T22:14:10.373Z",
      "last_login": "2026-02-03T22:14:10.373Z"
    },
    "entity": {
      "id": 1,
      "email": "[email protected]",
      "phone": "text",
      "street_address_1": "text",
      "street_address_2": "text",
      "city": "text",
      "state": "AL",
      "region": "text",
      "postal_code": "text",
      "country": "US",
      "kyc_status": "unverified",
      "first_name": "text",
      "last_name": "text",
      "date_of_birth": "2026-02-03",
      "net_worth": "text",
      "annual_income": "text",
      "accredited_investor": true,
      "citizenship": "United States",
      "us_person": true,
      "exempt_from_backup_withholding": true,
      "amount_invested_in_reg_cf_offering_this_year": "text",
      "accredited_investor_type": "net_worth",
      "tax_id_number": "text"
    },
    "individual_entity": {
      "id": 1,
      "first_name": "text",
      "last_name": "text",
      "email": "[email protected]",
      "phone": "text",
      "kyc_status": "unverified"
    },
    "type": "person",
    "receive_sms": true,
    "receive_emails": true,
    "utm_parameters": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "payment_method": "text",
  "updated_at": "2026-02-03T22:14:10.373Z",
  "has_investor_signed": true,
  "accredited_investor": true,
  "net_worth": "text",
  "annual_income": "text",
  "us_person": true,
  "exempt_from_backup_withholding": true,
  "amount_invested_in_reg_cf_offering_this_year": "text",
  "user_browser_type": "text",
  "accredited_investor_type": "net_worth",
  "processed_at": "2026-02-03T22:14:10.373Z",
  "received_at": "2026-02-03T22:14:10.373Z",
  "refunded_at": "2026-02-03T22:14:10.373Z",
  "bonus_shares": 1,
  "processing_issue_statuses": "text",
  "shares_amount": "text",
  "watchlistentity_set": [
    {
      "id": 1,
      "entity": 1,
      "has_hits": true,
      "watchlist_hits": null,
      "ofac_fincen_status": "text",
      "updated_at": "2026-02-03T22:14:10.373Z",
      "aml_provider": "text"
    }
  ],
  "bonus_shares_code": "text",
  "bonus_shares_percentage_tier": "text",
  "bonus_shares_quantity_tier": "text",
  "quantity_qualified_shares": 1,
  "price_qualified_shares": "text",
  "invested_at": "2026-02-03T22:14:10.373Z"
}

get

Return the investment statuses.

Example response: { "success": true, "message": "", "data": { "statuses": [ { "value": "received", "label": "Received", } ] } }

Authorizations

AuthorizationstringRequired

Api Key permission with required prefix "Api-Key"

Responses

200Success

application/json

get

/api/investments/statuses/

GET /api/investments/statuses/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "statuses": [
      {
        "value": "text",
        "label": "text"
      }
    ]
  },
  "success": true,
  "message": "text"
}

get

Return an investment summary for the provided filters.

Authorizations

AuthorizationstringOptional

Token-based authentication using Firebase ID Token

Responses

200Success

application/json

get

/api/investments/summary/

GET /api/investments/summary/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "total_amount_committed": {
    "amount": 1,
    "count": 1,
    "investor_count": 1
  },
  "total_amount_committed_today": {
    "amount": 1,
    "count": 1,
    "investor_count": 1
  },
  "total_amount_received": {
    "amount": 1,
    "count": 1,
    "investor_count": 1
  },
  "total_amount_received_today": {
    "amount": 1,
    "count": 1,
    "investor_count": 1
  },
  "total_amount_invested": {
    "amount": 1,
    "count": 1,
    "investor_count": 1
  },
  "total_amount_invested_today": {
    "amount": 1,
    "count": 1,
    "investor_count": 1
  }
}

get

List all the values of the provided fields.

Query Parameters: field: the comma-separated list of fields to query.

Authorizations

AuthorizationstringRequired

Api Key permission with required prefix "Api-Key"

Query parameters

Responses

200Success

application/json

get

/api/investments/values/

GET /api/investments/values/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "values": [
      {
        "investor_verify_process_status": "text",
        "reference_id": "text",
        "offering": 1,
        "created_at": "2026-02-03T22:14:10.373Z",
        "processing_issue_statuses": "text",
        "amount": "text",
        "updated_at": "2026-02-03T22:14:10.373Z",
        "price_payment_processing_fees": "text",
        "investor": 1,
        "price_fees": "text",
        "requested_payment_method": "card",
        "status": "started",
        "investor__type": "person",
        "id": 1
      }
    ],
    "count": 1
  },
  "success": true,
  "message": "text"
}

get

Management of Investors.

Authorizations

AuthorizationstringRequired

Token-based authentication using Firebase ID Token

Query parameters

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

typestring · enumOptional

person - Person
company - Company
trust - Trust
trust_ira - Trust Ira

Possible values:

type__instring[]Optional

Multiple values may be separated by commas.

userintegerOptional

user__ininteger[]Optional

Multiple values may be separated by commas.

user__thirdpartyissueruser__emailstringOptional

user__thirdpartyissueruser__email__instring[]Optional

Multiple values may be separated by commas.

Responses

200Success

application/json

get

/api/investors/

GET /api/investors/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "email": "[email protected]"
      },
      "entity": {
        "first_name": "text",
        "last_name": "text",
        "date_of_birth": "2026-02-03",
        "accredited_investor": true,
        "net_worth": "text",
        "annual_income": "text",
        "citizenship": "United States",
        "us_person": true,
        "exempt_from_backup_withholding": true,
        "amount_invested_in_reg_cf_offering_this_year": "text",
        "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
        "accredited_investor_type": "net_worth",
        "canadian_eligible_investor_type": "eligible_net_income",
        "household_w9": true,
        "id": 1,
        "email": "[email protected]",
        "street_address_1": "text",
        "street_address_2": "text",
        "city": "text",
        "state": "AL",
        "region": "text",
        "postal_code": "text",
        "country": "US",
        "kyc_status": "unverified"
      },
      "type": "person",
      "individual_entity": {
        "id": 1,
        "first_name": "text",
        "last_name": "text",
        "email": "[email protected]",
        "phone": "text",
        "kyc_status": "unverified"
      }
    }
  ]
}

get

Management of Investors.

Authorizations

AuthorizationstringRequired

Token-based authentication using Firebase ID Token

Path parameters

idintegerRequired

A unique integer value identifying this investor.

Responses

200Success

application/json

Responseone of

get

/api/investors/{id}/

GET /api/investors/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "user": {
    "id": 1,
    "email": "[email protected]"
  },
  "entity": {
    "first_name": "text",
    "last_name": "text",
    "date_of_birth": "2026-02-03",
    "accredited_investor": true,
    "net_worth": "text",
    "annual_income": "text",
    "citizenship": "United States",
    "us_person": true,
    "exempt_from_backup_withholding": true,
    "amount_invested_in_reg_cf_offering_this_year": "text",
    "amount_invested_in_reg_cf_offering_this_year_other_platforms": "text",
    "accredited_investor_type": "net_worth",
    "canadian_eligible_investor_type": "eligible_net_income",
    "household_w9": true,
    "id": 1,
    "email": "[email protected]",
    "street_address_1": "text",
    "street_address_2": "text",
    "city": "text",
    "state": "AL",
    "region": "text",
    "postal_code": "text",
    "country": "US",
    "kyc_status": "unverified"
  },
  "type": "person",
  "individual_entity": {
    "id": 1,
    "first_name": "text",
    "last_name": "text",
    "email": "[email protected]",
    "phone": "text",
    "kyc_status": "unverified"
  }
}

get

List all the values of the provided fields.

Query Parameters: field: the comma-separated list of fields to query.

Authorizations

AuthorizationstringRequired

Token-based authentication using Firebase ID Token

Query parameters

Responses

200Success

application/json

get

/api/investors/values/

GET /api/investors/values/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "data": {
    "values": [
      {
        "user": 1,
        "upload_document": true,
        "type": "person",
        "user__thirdpartyissueruser__email": null,
        "id": 1
      }
    ],
    "count": 1
  },
  "success": true,
  "message": "text"
}

get

Management of Offerings.

Authorizations

AuthorizationstringRequired

Api Key permission with required prefix "Api-Key"

Query parameters

archivedbooleanOptional

archived__inboolean[]Optional

Multiple values may be separated by commas.

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

issuerintegerOptional

issuer__archivedbooleanOptional

issuer__archived__inboolean[]Optional

Multiple values may be separated by commas.

issuer__ininteger[]Optional

Multiple values may be separated by commas.

namestringOptional

name__containsstringOptional

name__instring[]Optional

Multiple values may be separated by commas.

opened_atstring · date-timeOptional

opened_at__instring · date-time[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

slugstringOptional

slug__containsstringOptional

slug__instring[]Optional

Multiple values may be separated by commas.

statusstring · enumOptional

incomplete - Imcomplete
pending - Pending
opened - Opened
closed - Closed
paused - Paused

Possible values:

status__containsstringOptional

status__instring[]Optional

Multiple values may be separated by commas.

typestring · enumOptional

reg_a - Regulation A
reg_d_506b - Regulation D 506(b)
reg_d_506c - Regulation D 506(c)
reg_s - Regulation S
reg_cf - Regulation Crowdfunding
test_the_waters - Test The Waters

Possible values:

type__containsstringOptional

type__instring[]Optional

Multiple values may be separated by commas.

Responses

200Success

application/json

get

/api/offerings/

GET /api/offerings/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "issuer": 1,
      "name": "text",
      "type": "reg_a",
      "status": "incomplete",
      "description": "text",
      "security_type": "text",
      "share_or_unit": "Shares",
      "share_or_unit_details": "text",
      "warrant_per_unit": 1,
      "warrant_expiration_date_delta_year": 1,
      "warrant_expiration_date_delta_month": 1,
      "dollar_amount_investment": true,
      "unit_price": "text",
      "administrative_fees": "text",
      "administrative_fees_paid_by_investor": true,
      "number_of_shares": 1,
      "max_investment_amount": "text",
      "min_investment_amount": "text",
      "investment_increment_amount": "text",
      "minimum_wire_transfer_amount": "text",
      "contact_name": "text",
      "contact_title": "text",
      "contact_phone": "text",
      "contact_email": "[email protected]",
      "accredited_investors": true,
      "non_accredited_investors": true,
      "slug": "text",
      "logo": "https://example.com",
      "favicon": "https://example.com",
      "circular_link": "text",
      "circular_file": "https://example.com",
      "circular_type": "offering_circular",
      "display_circular": true,
      "displayed_number_of_shares": null,
      "signing_full_name": "text",
      "signing_title": "text",
      "signing_email": "text",
      "support_email": "[email protected]",
      "support_phone": "text",
      "daily_summary_emails": true,
      "daily_summary_recipients": "text",
      "weekly_summary_emails": true,
      "weekly_summary_recipients": "text",
      "wire_email_reminder_period": 1,
      "wire_email_reminder_max_sent": 1,
      "investment_email_reminder_period": 1,
      "investment_email_reminder_max_sent": 1,
      "messaging_consent_text": "text",
      "email_sender_name": "text",
      "default_timezone": "US/Pacific",
      "segment_dataset_id": "text",
      "auto_approve_investments": true,
      "auto_accept_investments": true,
      "auto_accept_max_amount": "text",
      "auto_accept_min_amount": "text",
      "email_investment_started_high_value": true,
      "email_investment_started_threshold": "text",
      "enable_test_the_waters": true,
      "displayed_test_the_waters_amounts": null,
      "accent_color": "text",
      "background_accent_color": "text",
      "activity_accent_color": "text",
      "per_investment_summary_emails": true,
      "per_investment_summary_recipients": "text",
      "user_sent_max_monitoring_emails": true,
      "user_sent_max_monitoring_recipients": "text",
      "other_platform_investment_notice": true,
      "other_platform_investment_notice_text": "text",
      "investor_phone_number_required": true,
      "minimum_amount_raised": "text",
      "reg_cf_amount_raised_tier": "text",
      "maximum_amount_raised": "text",
      "reg_cf_oversubscription": "text",
      "reg_cf_fee_percentage": "text",
      "archived": true,
      "investors_excluded_countries": [
        "US"
      ],
      "investors_included_countries": [
        "US"
      ],
      "display_logo_during_investment": "center",
      "display_logo_on_dashboard": true,
      "deadline_date": "2026-02-03",
      "created_at": "2026-02-03T22:14:10.373Z",
      "opened_at": "2026-02-03T22:14:10.373Z"
    }
  ]
}

get

Management of Offerings.

Authorizations

AuthorizationstringRequired

Api Key permission with required prefix "Api-Key"

Path parameters

idintegerRequired

A unique integer value identifying this offering.

Responses

200Success

application/json

get

/api/offerings/{id}/

GET /api/offerings/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "issuer": 1,
  "name": "text",
  "type": "reg_a",
  "status": "incomplete",
  "description": "text",
  "security_type": "text",
  "share_or_unit": "Shares",
  "share_or_unit_details": "text",
  "warrant_per_unit": 1,
  "warrant_expiration_date_delta_year": 1,
  "warrant_expiration_date_delta_month": 1,
  "dollar_amount_investment": true,
  "unit_price": "text",
  "administrative_fees": "text",
  "administrative_fees_paid_by_investor": true,
  "number_of_shares": 1,
  "max_investment_amount": "text",
  "min_investment_amount": "text",
  "investment_increment_amount": "text",
  "minimum_wire_transfer_amount": "text",
  "contact_name": "text",
  "contact_title": "text",
  "contact_phone": "text",
  "contact_email": "[email protected]",
  "accredited_investors": true,
  "non_accredited_investors": true,
  "slug": "text",
  "logo": "https://example.com",
  "favicon": "https://example.com",
  "circular_link": "text",
  "circular_file": "https://example.com",
  "circular_type": "offering_circular",
  "display_circular": true,
  "displayed_number_of_shares": null,
  "signing_full_name": "text",
  "signing_title": "text",
  "signing_email": "text",
  "support_email": "[email protected]",
  "support_phone": "text",
  "daily_summary_emails": true,
  "daily_summary_recipients": "text",
  "weekly_summary_emails": true,
  "weekly_summary_recipients": "text",
  "wire_email_reminder_period": 1,
  "wire_email_reminder_max_sent": 1,
  "investment_email_reminder_period": 1,
  "investment_email_reminder_max_sent": 1,
  "messaging_consent_text": "text",
  "email_sender_name": "text",
  "default_timezone": "US/Pacific",
  "segment_dataset_id": "text",
  "auto_approve_investments": true,
  "auto_accept_investments": true,
  "auto_accept_max_amount": "text",
  "auto_accept_min_amount": "text",
  "email_investment_started_high_value": true,
  "email_investment_started_threshold": "text",
  "enable_test_the_waters": true,
  "displayed_test_the_waters_amounts": null,
  "accent_color": "text",
  "background_accent_color": "text",
  "activity_accent_color": "text",
  "per_investment_summary_emails": true,
  "per_investment_summary_recipients": "text",
  "user_sent_max_monitoring_emails": true,
  "user_sent_max_monitoring_recipients": "text",
  "other_platform_investment_notice": true,
  "other_platform_investment_notice_text": "text",
  "investor_phone_number_required": true,
  "minimum_amount_raised": "text",
  "reg_cf_amount_raised_tier": "text",
  "maximum_amount_raised": "text",
  "reg_cf_oversubscription": "text",
  "reg_cf_fee_percentage": "text",
  "archived": true,
  "investors_excluded_countries": [
    "US"
  ],
  "investors_included_countries": [
    "US"
  ],
  "display_logo_during_investment": "center",
  "display_logo_on_dashboard": true,
  "deadline_date": "2026-02-03",
  "created_at": "2026-02-03T22:14:10.373Z",
  "opened_at": "2026-02-03T22:14:10.373Z"
}

get

Management of users.

Authorizations

AuthorizationstringRequired

Token-based authentication using Firebase ID Token

Query parameters

idintegerOptional

id__ininteger[]Optional

Multiple values may be separated by commas.

orderingstringOptional

Which field to use when ordering the results.

pageintegerOptional

A page number within the paginated result set.

page_sizeintegerOptional

Number of results to return per page.

searchstringOptional

A search term.

thirdpartyissueruser__emailstringOptional

thirdpartyissueruser__email__instring[]Optional

Multiple values may be separated by commas.

Responses

200Success

application/json

get

/api/users/

GET /api/users/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "email": "[email protected]"
    }
  ]
}

post

Management of users.

Authorizations

AuthorizationstringRequired

Token-based authentication using Firebase ID Token

Body

Management of User Creation.

idintegerRead-onlyRequired

emailstring · email · max: 255Required

passwordstringWrite-onlyRequired

Password Write-only attribute.

Responses

201Success

application/json

post

/api/users/

POST /api/users/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "email": "[email protected]",
  "password": "text"
}

201Success

{
  "id": 1,
  "email": "[email protected]"
}

get

Management of users.

Authorizations

AuthorizationstringRequired

Token-based authentication using Firebase ID Token

Path parameters

idintegerRequired

A unique integer value identifying this user.

Responses

200Success

application/json

get

/api/users/{id}/

GET /api/users/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

200Success

{
  "id": 1,
  "email": "[email protected]"
}

patch

Management of users.

Authorizations

AuthorizationstringRequired

Token-based authentication using Firebase ID Token

Path parameters

idintegerRequired

A unique integer value identifying this user.

Body

Management of User Creation.

idintegerRead-onlyOptional

emailstring · email · max: 255Optional

passwordstringWrite-onlyOptional

Password Write-only attribute.

Responses

200Success

application/json

patch

/api/users/{id}/

PATCH /api/users/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "email": "[email protected]",
  "password": "text"
}

200Success

{
  "id": 1,
  "email": "[email protected]"
}

Last updated 3 months ago