Skip to main content
POST
Get share classes

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Options for fetching share classes.

company_ids
string[] | null

Filter by company IDs.

Example:
share_class_ids
string[] | null

Filter by share class IDs.

Example:
purchase_type
enum<string> | null

Filter by purchase type: 'primary' or 'secondary'.

Available options:
primary,
secondary
Example:

"primary"

Response

200 - application/json

OK

company_id
string
required

The ID of the company this share class belongs to.

Example:

"pvYe"

financing_id
string
required

The ID of the financing round this share class belongs to.

Example:

"a2Ne"

purchase_type
enum<string>
required

Whether the purchase is a primary or secondary transaction.

Available options:
primary,
secondary
Example:

"primary"

type
enum<string>
required

The type of shares in this share class.

Available options:
common,
preferred
Example:

"preferred"

name
string
required

The name of the share class.

Example:

"Series A"

price_per_share
MoneyAmount · object
required

The price per share for this share class.

Example:
company_name
string
required

The name of the company this share class belongs to. Output only.

Example:

"Acme Corp"

id
string | null

The ID of the share class.

Example:

"a2Ne"

include_in_fair_value
boolean | null

Whether the share class is included in the fair value calculation. Defaults to True when the purchase_type is primary, otherwise False.

Example:

true