How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shareworks Company Board API

The Company Board API from Shareworks — 3 operation(s) for company board.

Shareworks Company Board API is one of 15 APIs that Shareworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Company Board. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 6 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://shareworks.solium.com/rest/admin, https://sum-qa02.shareworks.com/rest/admin.

6 operations 3 paths 8 schemas 2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://shareworks-api.solium.com/
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Shareworks Company Board API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (accessToken). By default, every request must be authenticated.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Company Board 6
POST
/v1/company/{companyId}/board/appointment
POST Company Board Appointment (Create)
createAppointment 2 params body → 201400401403422500
GET
/v1/company/{companyId}/board
GET Company Board
getCompanyBoard 1 param → 200400401403422500
PUT
/v1/company/{companyId}/board
PUT Company Board (Update)
updateCompanyBoard 1 param body → 200400401403422500
POST
/v1/company/{companyId}/board
POST Company Board (Create)
createCompanyBoard 2 params body → 201400401403422500
GET
/v1/company/{companyId}/board/appointment/{appointmentId}
GET Company Board Appointment
getBoardAppointment 2 params → 200400401403422500
PUT
/v1/company/{companyId}/board/appointment/{appointmentId}
PUT Company Board Appointment (Update)
updateAppointment 2 params body → 200400401403422500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are CompanyBoardAppointmentDetails (13 properties), CompanyBoardAppointmentCreateCrudRequest (9 properties), CompanyBoardAppointmentUpdateCrudRequest (8 properties), CompanyBoardDetailsWithAppointments (6 properties). Each schema is shown below with its type and property counts.

CompanyBoardDetails
object
5 properties 4 required
RestApiErrorResponse
object
4 properties 3 required
CompanyBoardDetailsWithAppointments
object
6 properties 5 required
CompanyBoardCrudRequest
object
4 properties 3 required
ErrorWithCode
object
2 properties 2 required
CompanyBoardAppointmentUpdateCrudRequest
object
8 properties 5 required
CompanyBoardAppointmentDetails
object
13 properties 10 required
CompanyBoardAppointmentCreateCrudRequest
object
9 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shareworks-company-board-api-openapi.yml Raw ↑

Other APIs Shareworks publishes across the network.

Shareworks Public API
Shareworks Authentication Token API
Shareworks Authorized Capital API
Shareworks Award Type API
Shareworks Company API
Shareworks Company Integration API
Shareworks Entity Stakeholder API
Shareworks Grant API
Shareworks Holdings API
Shareworks Individual Stakeholder API
Shareworks Plan API
Shareworks Stock Certificate API
Where this information came from

This is an independent, third-party profile of Shareworks Company Board API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.