Smokeball · Schema

Smokeball StaffDto

LegalLaw FirmPractice ManagementMattersContactsDocumentsBillingTrust AccountingTime Tracking

Properties

Name	Type	Description
userId	string	Unique identifier of the associated user. Used to map staff member to the specified user id and ignored if left blank. Use the FirmUsers API to remove a staff/user mapping.
title	string	Staff member's title.
firstName	string	Staff member's first name.
middleName	string	Staff member's middle name (if applicable).
lastName	string	Staff member's last name.
initials	string	Staff member's initials.
phone	object	Staff member's phone number.
cell	object	Staff member's cell number.
email	string	Staff member's email address.
role	string	Staff member's role.
avatar	string	Staff member's avatar.
former	boolean	Whether he/she is a former member. Caution: Setting a staff member to former staff will also deregister them from the firm.
colorFill	string	Staff member's fill color hex code.
colorStroke	string	Staff member's stroke color hex code.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/smokeball/json-schema/smokeball-staffdto.json",
  "title": "Smokeball StaffDto",
  "type": "object",
  "properties": {
    "userId": {
      "type": "string",
      "description": "Unique identifier of the associated user. Used to map staff member to the specified user id and ignored if left blank.\r\nUse the FirmUsers API to remove a staff/user mapping.",
      "nullable": true,
      "example": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2"
    },
    "title": {
      "type": "string",
      "description": "Staff member's title.",
      "nullable": true,
      "example": "Mr"
    },
    "firstName": {
      "type": "string",
      "description": "Staff member's first name.",
      "nullable": true,
      "example": "John"
    },
    "middleName": {
      "type": "string",
      "description": "Staff member's middle name (if applicable).",
      "nullable": true,
      "example": ""
    },
    "lastName": {
      "type": "string",
      "description": "Staff member's last name.",
      "nullable": true,
      "example": "Smith"
    },
    "initials": {
      "type": "string",
      "description": "Staff member's initials.",
      "nullable": true,
      "example": "JS"
    },
    "phone": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PhoneNumberDto"
        }
      ],
      "description": "Staff member's phone number.",
      "nullable": true
    },
    "cell": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PhoneNumberDto"
        }
      ],
      "description": "Staff member's cell number.",
      "nullable": true
    },
    "email": {
      "type": "string",
      "description": "Staff member's email address.",
      "nullable": true,
      "example": "[email protected]"
    },
    "role": {
      "type": "string",
      "description": "Staff member's role.",
      "nullable": true,
      "example": "Bookkeeper"
    },
    "avatar": {
      "type": "string",
      "description": "Staff member's avatar.",
      "nullable": true,
      "example": "https://example-avatar-url.com/image"
    },
    "former": {
      "type": "boolean",
      "description": "Whether he/she is a former member. \r\n\r\nCaution: Setting a staff member to former staff will also deregister them from the firm.",
      "nullable": true,
      "example": false
    },
    "colorFill": {
      "type": "string",
      "description": "Staff member's fill color hex code.",
      "nullable": true,
      "example": "#797d85"
    },
    "colorStroke": {
      "type": "string",
      "description": "Staff member's stroke color hex code.",
      "nullable": true,
      "example": "#64666a"
    }
  },
  "additionalProperties": false
}