workspace

The Workspace API endpoints provide an interface for getting information about Chain workspaces.

Workspace

Properties

Name	Type	Description	Restrictions
company_id	ID	The unique identifier of a resource (can be a GUID).
description	string	A description of the workspace.
external_id	ID	The unique identifier of a resource (can be a GUID).
id	ID	The unique identifier of a resource (can be a GUID).
name	string	The name of the workspace.
variables	[Variable]	A list of the workspace’s variables.

Example

{
  "company_id": "74",
  "description": "string",
  "external_id": "74",
  "id": "74",
  "name": "string",
  "variables": [
    {
      "defaultValue": "string",
      "encrypted": true,
      "key": "string",
      "label": "string",
      "value": "string"
    }
  ]
}

Variable

Properties

Name	Type	Description	Restrictions
defaultValue	string
encrypted	boolean
key	string
label	string
value	string

Example

{
  "defaultValue": "string",
  "encrypted": true,
  "key": "string",
  "label": "string",
  "value": "string"
}

WorkspaceResponse

Properties

Name	Type	Description	Restrictions
data	Workspace

Example

{
  "data": {
    "company_id": "74",
    "description": "string",
    "external_id": "74",
    "id": "74",
    "name": "string",
    "variables": [
      {
        "defaultValue": "string",
        "encrypted": true,
        "key": "string",
        "label": "string",
        "value": "string"
      }
    ]
  }
}