Smokeball · Schema

Smokeball Tag

Represents a tag with an identifier, name, and type.

LegalLaw FirmPractice ManagementMattersContactsDocumentsBillingTrust AccountingTime Tracking

Properties

Name Type Description
id string Identifier of the tag. Role tags do not have an identifier.
name string Name of tag.
type string Type of tag. Accepted values are 'Role' or 'Custom'
View JSON Schema on GitHub

JSON Schema

smokeball-tag.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/smokeball/json-schema/smokeball-tag.json",
  "title": "Smokeball Tag",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Identifier of the tag. Role tags do not have an identifier.",
      "nullable": true
    },
    "name": {
      "type": "string",
      "description": "Name of tag.",
      "nullable": true
    },
    "type": {
      "type": "string",
      "description": "Type of tag. Accepted values are 'Role' or 'Custom'",
      "example": "Custom"
    }
  },
  "additionalProperties": false,
  "description": "Represents a tag with an identifier, name, and type."
}