{
  "opencollection": "1.0.0",
  "info": {
    "name": "Shareworks Admin REST Authentication Token Read Access API",
    "version": "1.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Read Access",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "POST Auth Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://shareworks.solium.com/rest/admin/v1/auth/tokens"
          },
          "docs": "Create a JWT authentication request and retrieve an access token"
        },
        {
          "info": {
            "name": "POST Refresh Auth Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://shareworks.solium.com/rest/admin/v1/refresh/tokens",
            "headers": [
              {
                "name": "Shareworks-Request-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a JWT authentication request and get a new access token"
        },
        {
          "info": {
            "name": "POST Terminate Token",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://shareworks.solium.com/rest/admin/v1/terminate/tokens",
            "headers": [
              {
                "name": "Shareworks-Request-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Revoke access to the token "
        },
        {
          "info": {
            "name": "GET Authorized Capital",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/authorized-capital",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the top-level calculated cap table information for the company"
        },
        {
          "info": {
            "name": "GET Authorized Capital Plan",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/authorized-capital/plan/:planId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "planId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve an in-depth calculated summary for the specified plan"
        },
        {
          "info": {
            "name": "GET Authorized Capital Class",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/authorized-capital/securities/:classOfSecurities",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "classOfSecurities",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve an in-depth calculated summary for the specified class of securities"
        },
        {
          "info": {
            "name": "GET 409A Valuations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/authorized-capital/409a",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a list of the 409A valuations for all funds within a company"
        },
        {
          "info": {
            "name": "GET Stock Designations (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/authorized-capital/designations",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a list of all stock designations within a company"
        },
        {
          "info": {
            "name": "GET Award Type (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/award-type",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve a list of all award types assigned to the specified company"
        },
        {
          "info": {
            "name": "POST Company Integration Key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/integration",
            "headers": [
              {
                "name": "Shareworks-Request-Id",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Verifies and Activates a Company Integration Key"
        },
        {
          "info": {
            "name": "GET Company (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company",
            "params": [
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 50. Maximum is 250"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ]
          },
          "docs": "Retrieve the details of all managed companies"
        },
        {
          "info": {
            "name": "GET Company (Single)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the specified company"
        },
        {
          "info": {
            "name": "GET Stock Certificate (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/:stakeholderId/stock-certificate",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "stakeholderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 50. Maximum is 250"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ]
          },
          "docs": "Retrieve the details of all stock certificates belonging to the specified stakeholder"
        },
        {
          "info": {
            "name": "GET Stock Certificate (Single)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/stock-certificate/:stockCertificateId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "stockCertificateId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the specified stock certificates"
        },
        {
          "info": {
            "name": "GET Stock Filing (Latest)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/authorized-capital/stock-filing/latest",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the company's most recent stock filing"
        },
        {
          "info": {
            "name": "GET Vesting Schedule (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/vesting-schedule",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 50. Maximum is 250"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ]
          },
          "docs": "Retrieve the details of all vesting schedules for the specified company"
        },
        {
          "info": {
            "name": "GET Manual Vesting Schedules (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/vesting-schedule/manual",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of all manual vesting schedules for the specified company"
        },
        {
          "info": {
            "name": "GET Vesting Schedule (Single)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/vesting-schedule/:vestingScheduleId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "vestingScheduleId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the specified vesting schedule"
        },
        {
          "info": {
            "name": "GET Company Board",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/board",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the company board for officer/director tracking, including details of the company board appointments"
        },
        {
          "info": {
            "name": "GET Company Board Appointment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/board/appointment/:appointmentId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "appointmentId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the specified company board assignment"
        },
        {
          "info": {
            "name": "GET Grant (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/:stakeholderId/grant",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "stakeholderId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 50. Maximum is 250"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ]
          },
          "docs": "Retrieve the details of all grants belonging to the specified stakeholder"
        },
        {
          "info": {
            "name": "GET Grant (Single)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/grant/:grantId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "grantId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the specified grant"
        },
        {
          "info": {
            "name": "GET Holdings (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/holdings",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the calculated summary of the holding for all stakeholders in the company. This includes the calculated breakdown for all individual stock certificates and grants"
        },
        {
          "info": {
            "name": "GET Holdings (Single)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/holdings/:stakeholderId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "stakeholderId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the calculated summary of the holding for a single stakeholder. This includes the calculated breakdown for all individual stock certificates and grants"
        },
        {
          "info": {
            "name": "GET Entity Stakeholder (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/entity",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 100. Maximum is 500"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ]
          },
          "docs": "Retrieve the details for all entity stakeholders in the company"
        },
        {
          "info": {
            "name": "GET Individual Stakeholder (All)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/individual",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 100. Maximum is 500"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ]
          },
          "docs": "Retrieve the details of all individual stakeholders in the company"
        },
        {
          "info": {
            "name": "GET Entity Stakeholder (Single)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/entity/:stakeholderId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "stakeholderId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the specified entity stakeholder"
        },
        {
          "info": {
            "name": "GET Individual Stakeholder (Single)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/individual/:stakeholderId",
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "stakeholderId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Retrieve the details of the specified individual stakeholder"
        },
        {
          "info": {
            "name": "POST Entity Search",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/entity/search",
            "headers": [
              {
                "name": "Shareworks-Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 100. Maximum is 500"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a search and retrieve a list of entity stakeholders matching the criteria"
        },
        {
          "info": {
            "name": "POST Individual Search",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://shareworks.solium.com/rest/admin/v1/company/:companyId/stakeholder/individual/search",
            "headers": [
              {
                "name": "Shareworks-Request-Id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "companyId",
                "value": "",
                "type": "path"
              },
              {
                "name": "pageSize",
                "value": "",
                "type": "query",
                "description": "Number of items to return per page. Default is 100. Maximum is 500"
              },
              {
                "name": "pageNumber",
                "value": "",
                "type": "query",
                "description": "Which page of the data set to fetch. Default is 1."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a search and retrieve a list of individual stakeholders matching the criteria"
        }
      ]
    }
  ],
  "bundled": true
}