Schema: Workspace

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
id	Yes	string
companyName	Yes	string
displayName	Yes	string
nit	Yes	string
verificationDigit	Yes	string
environment	Yes	WorkspaceEnvironment
isActive	Yes	boolean
role	Yes	string

JSON definition

The JSON retains the source contract descriptions. Do not translate property names or enum values.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "companyName": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "nit": {
      "type": "string"
    },
    "verificationDigit": {
      "type": "string"
    },
    "environment": {
      "$ref": "#/components/schemas/WorkspaceEnvironment"
    },
    "isActive": {
      "type": "boolean"
    },
    "role": {
      "type": "string",
      "description": "Rol del usuario en el espacio."
    }
  },
  "required": [
    "id",
    "companyName",
    "displayName",
    "nit",
    "verificationDigit",
    "environment",
    "isActive",
    "role"
  ]
}