Member object

A person that belongs to your workspace.

Example

Member

{
  "id": "3f3df320-dd95-4a42-8eae-99243fb2ea86",
  "name": "Brian Lockett",
  "email": "[email protected]",
  "isActive": true,
  "isBillable": true,
  "loginEnabled": true,
  "invitationStatusId": "accepted",
  "employmentTypeId": "employee",
  "costMethodId": "fixed",
  "activeStartDate": "2020-08-03",
  "activeEndDate": "2022-02-01",
  "timeOffAllowed": true,
  "timeOffApprovalMode": "member",
  "receiveMissingTimeReminders": true,
  "unsubmittedTimesheetReminders": true,
  "forbidTimesheetSubmissionWhenBelowCapacity": false,
  "internalId": "12345",
  "internalNotes": "Primary location: Atlanta, GA",
  "createdAt": "2020-08-03T21:00:16.370Z",
  "securityRole": {
    "id": "e31c9f7e-98cb-4ce7-81df-cc46bd9eb94f",
    "name": "Workspace Admin"
  },
  "jobTitle": {
    "id": "5a2537bd-7fc6-4d68-b639-4ec79a7fda58",
    "name": "HTML Developer"
  },
  "discipline": {
    "id": "996bf40b-d856-4c8c-b14a-f41b3a015c5b",
    "name": "Software Engineering"
  },
  "practice": {
    "id": "400a0c5c-32f1-41f5-a51d-e90807254965",
    "name": "Retail"
  },
  "manager": {
    "id": "5de6d319-ae80-4484-8b3d-0a9ff9580292",
    "name": "Steven Rodriguez"
  },
  "timeOffApprover": {
    "id": "b6816355-8945-40aa-b798-b0d6fd89e437",
    "name": "Edna Blumer"
  },
  "holidaySchedule": {
    "id": "321c155b-147e-4bd2-8aab-b9c3a3afeab1",
    "name": "U.S. Holidays"
  },
  "tags": [
    {
      "id": "4c8d3f42-6efd-4a7e-85ca-d43164db0ab2",
      "name": "Atlanta Office"
    },
    {
      "id": "5533897a-450f-42b0-a419-aa3142dd9aad",
      "name": "Buenos Aires Office"
    }
  ],
  "skills": [
    {
      "id": "802c3214-59b4-4f9b-9eb1-4da2674becc3",
      "name": "JavaScript"
    },
    {
      "id": "efae4ed9-6967-4f76-9946-7b9b1008fe5e",
      "name": "HTML"
    },
    {
      "id": "828f3a35-1317-49fb-acad-419a62f74d44",
      "name": "CSS"
    }
  ],
  "availabilityPeriods": [
    {
      "id": "6675130f-d975-45ab-9971-4405062a9e92",
      "start": "2020-08-03",
      "end": "2022-02-01",
      "hoursPerDay": [
        8,
        8,
        8,
        8,
        8,
        0,
        0
      ]
    }
  ],
  "costPeriods": [
    {
      "id": "ae7268fd-2836-4437-b592-86289333e205",
      "start": "2020-08-03",
      "end": "2022-02-01",
      "currency": "USD",
      "costPerHour": 65,
      "overheadCostPerHour": 20,
      "totalCostPerHour": 85
    }
  ],
  "utilizationTargetPeriods": [
    {
      "id": "f77df409-f68b-4a98-a6c6-0fa97d523e20",
      "start": "2020-08-03",
      "end": "2022-02-01",
      "targetPercentage": 80
    }
  ]
}

Attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the member.
email	string	The email address of the member.
isActive	boolean	A flag to indicate if the member is active in the system.
isBillable	boolean	A flag to indicate if the member can bill their time.
loginEnabled	boolean	A flag to indicate if the member can log into the workspace.
invitationStatusId	string	The invitation status for the member. Can be either "not_invited" (Not invited), "invited" (Invited), or "accepted" (Accepted).
employmentTypeId	string	The type of employment for this member. Can be either "employee" (Employee), "contractor" (Contractor), or "other" (Other).
costMethodId	string	The cost method for the member. Can be either "hourly" (Hourly labor cost) or "fixed" (Fixed labor cost).
activeStartDate	date	The start date for when the member is active in the workspace. Will be in the form YYYY-MM-DD, if set.
activeEndDate	date	The end date for when the member is active in the workspace. Will be in the form YYYY-MM-DD, if set.
timeOffAllowed	boolean	A flag to indicate if the member is allowed to create time-off time entries.
timeOffApprovalMode	string	The approval mode for time-off time entries. Can be either "auto" (Time off is automatically approved), "manager" (Time off is approved by this member's manager), or "member" (Time off is approved by the selected member).
receiveMissingTimeReminders	boolean	A flag to indicate if the member should receive missing time reminders described in the workspace settings.
unsubmittedTimesheetReminders	boolean	A flag to indicate if the member should receive reminders if their timesheets have not been submitted.
forbidTimesheetSubmissionWhenBelowCapacity	boolean	A flag to indicate if the member should not be allowed to submit a timesheet when below their capacity for the period.
internalId	string	An extra identifier field for tracking this member against other systems.
internalNotes	string	An area to store extra notes about the member.
createdAt	timestamp	The timestamp when the object was created.
securityRole	object	A simple object to the related security role of the member. See attributes.
jobTitle	object	A simple object to the related job title of the member. See attributes.
discipline	object	A simple object to the related discipline of the member. See attributes.
practice	object	A simple object to the related practice of the member. See attributes.
manager	object	A simple object to the related manager of the member. See attributes.
timeOffApprover	object	A simple object to the related time-off approver of the member. See attributes.
holidaySchedule	object	A simple object to the related holiday schedule of the member. See attributes.
tags	array of objects	The list of associated tags. See attributes.
skills	array of objects	The list of associated skills. See attributes.
availabilityPeriods	array of objects	The list of associated availability periods, also called capacity periods. See attributes.
costPeriods	array of objects	The list of associated cost periods. See attributes.
utilizationTargetPeriods	array of objects	The list of associated utilization target periods. See attributes.

Security role attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the security role.

Job title attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the job title.

Discipline attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the discipline.

Practice attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the practice.

Member attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the parent member.

Holiday schedule attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the holiday schedule.

Tag attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the tag.

Skill attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
name	string	The name of the skill.

Availability period attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
start	date	The start date for the period. Will be in the form YYYY-MM-DD.
end	date	The end date for the period. Will be in the form YYYY-MM-DD.
hoursPerDay	array of numbers	A list of hours for each day of the week. The array size should always be 7. The first value represents Monday.

Cost period attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
start	date	The start date for the period. Will be in the form YYYY-MM-DD.
end	date	The end date for the period. Will be in the form YYYY-MM-DD.
currency	string	The currency code for the cost period.
costPerHour	number	The labor cost per hour.
overheadCostPerHour	number	The overhead cost per hour.
totalCostPerHour	number	The total cost per hour. A calculated field that's the total of costPerHour and overheadCostPerHour.

Utilization target period attributes

Name	Type	Description
id	uuid	The unique identifier for the object.
start	date	The start date for the period. Will be in the form YYYY-MM-DD.
end	date	The end date for the period. Will be in the form YYYY-MM-DD.
targetPercentage	number	The target billable utilization percentage for this period.