displayName and email.
Endpoints
List stakeholders
Returns a cursor-paginated list of all stakeholders belonging to your organization. Filter bytype, status, or search by name and email with the q parameter.
Query parameters
string
Free-text search against
displayName and email. Case-insensitive partial match.string
Filter by stakeholder type. One of
INDIVIDUAL or INSTITUTION.string
Filter by stakeholder status. One of
CURRENT or FORMER.number
default:"25"
Maximum results per page. Capped at 100.
string
Opaque cursor from a previous response’s
nextCursor field. Omit to fetch from the beginning.Response
object[]
Array of stakeholder objects.
string | null
Pass this value as
cursor on the next request to retrieve the following page. null when you are on the last page.Create a stakeholder
Creates a new stakeholder. Supports theIdempotency-Key request header — if you retry with the same key, the API returns the previously created stakeholder instead of creating a duplicate.
Request body
string
required
Short display name. Maximum 100 characters.
object
required
Legal name object.
string
required
INDIVIDUAL or INSTITUTION.string
default:"CURRENT"
CURRENT or FORMER.string
Contact email address.
string[]
default:"[]"
Array of relationship labels. Valid values:
ADVISOR, BOARD_MEMBER, CONSULTANT, EMPLOYEE, EX_ADVISOR, EX_CONSULTANT, EX_EMPLOYEE, EXECUTIVE, FOUNDER, INVESTOR, OTHER.string
Your internal identifier for this stakeholder. Maximum 100 characters.
string
Free-text notes. Maximum 2000 characters.
string
UUID of a source document to associate with this stakeholder.
Response
Returns201 Created with the full stakeholder object and a Location header pointing to the new resource.
Get a stakeholder
404 if the stakeholder does not exist in your organization.
Update a stakeholder
Partial update — only include the fields you want to change. All body fields are optional.Request body
All fields from the create request body are accepted; all are optional forPATCH.
Returns 200 OK with the updated stakeholder object.
Delete a stakeholder
204 No Content on success.
Common errors
Use the
Idempotency-Key header on all POST requests to safely handle network retries without creating duplicate stakeholders.