List corporate actions
Returns a cursor-paginated list of corporate actions for your organization, ordered most-recent first.GET /api/v1/corporate-actions
Requires role: VIEWER.
string
Corporate action type. One of:
Stock Split, Reverse Split, Option Pool Change, Financing Round, Instrument Conversion, Termination.string
Current status. One of:
Draft, In Review, Approved, Finalized.string
Date the corporate action takes effect (
YYYY-MM-DD).object | null
Optional supplementary data:
boardApprovalDate, stockholderApprovalDate, documentIds, and free-text notes.Create a corporate action
Records a new corporate action. New records start in Draft status by default unless you explicitly setstatus to another value.
POST /api/v1/corporate-actions
Requires role: EDITOR. Idempotent with an Idempotency-Key header.
string
required
Corporate action type. One of:
Stock Split, Reverse Split, Option Pool Change, Financing Round, Instrument Conversion, Termination.string
required
Short descriptive title (e.g.
"2-for-1 forward split — Series A close"). Maximum 200 characters.string
required
Date the action takes effect (
YYYY-MM-DD).string
Longer description of the action. Maximum 2000 characters.
string
Initial status. One of
Draft, In Review, Approved, Finalized. Defaults to Draft.object
Optional supplementary data.
201 Created
Location response header points to GET /api/v1/corporate-actions/{id}.
Get a corporate action
Retrieves a single corporate action by ID.GET /api/v1/corporate-actions/{id}
Requires role: VIEWER.
Update a corporate action
Updates any field of an existing corporate action. All fields are optional — only the fields you include are changed.PATCH /api/v1/corporate-actions/{id}
Requires role: EDITOR. Idempotent with an Idempotency-Key header.
string
Updated type.
string
Updated title. Maximum 200 characters.
string
Updated summary. Maximum 2000 characters.
string
Updated effective date (
YYYY-MM-DD).string
Updated status. One of
Draft, In Review, Approved, Finalized.object
Updated metadata. Replaces the existing metadata object.
200 OK
Returns the full updated corporate action object.
Delete a corporate action
Permanently deletes a corporate action. Use this to remove draft records created in error.DELETE /api/v1/corporate-actions/{id}
Requires role: EDITOR.
204 No Content