Member Schema

Model

Member

Member = object

The member data. All members in the API will have this format.

Example

{
  "id": "members/w8ZaNn3e5ZA8EQSABtca",
  "name": "John Doe",
  "email": "john.doe@spoke.com",
  "phone": "+15555555555",
  "linkedDriverId": "drivers/w8ZaNn3e5ZA8EQSABtca",
  "displayName": "John D.",
  "active": true,
  "depots": [
    "depots/zeOCJaJCzZhpKVCVAC9o"
  ],
  "roles": [
    "dispatcher"
  ],
}

Properties

Property	Type	Description
id	MemberId	‐
name	string | null	Full user name Default null
email	string | null	User email Default null
phone	string | null	Phone number in E.164 format Default null
linkedDriverId	DriverId | null	The associated driverId if this member has the driver role. See Driver
displayName	string | null	User name for display purposes
active	boolean	If true, the member is active.
depots	DepotId[]	Depots associated with the Member. Default [] See Depot
roles	Role[]	The roles assigned to the member.

Identifier

MemberId

MemberId = `members/${string}`

A member id is a string that is unique for a team member. It is used to identify the member in the API.

Example

"members/0xBYy4MYt4piMCSQEsts"

Type Aliases

Role

Role = "owner" | "admin" | "depot-manager" | "dispatcher" | "read-only" | "driver"

A role granted to a team member.