Workspaces
Overview
A workspace represents a filing entity (i.e. a single EIN) on the Greenshades platform. Most data stored on the platform belongs to a single workspace.
API Usage
Since most data is organized by which workspace it belongs to, most requests on the API will require you to indicate which workspace you're querying for. This is done universally via the workspaceId
query parameter.
Introspection/Security
When authenticating with Greenshades, you will be granted access to one or more workspaces. The introspection endpoint available here will provide you with the workspaces you have access to. You will then use the appropriate workspaceId
in your requests.
An attempt to make an API request with an invalid workspaceId
(or one that you do not have access to) will result in an HTTP 401
error.
Updated over 3 years ago