Example

{
  "id": "c76d9cc0-7d7b-4038-b3a0-0dcc3841d88f",
  "typeId": "collaborator",
  "isActive": true,
  "isBillable": true,
  "rate": 75,
  "overrideCostRate": true,
  "costCurrency": "USD",
  "costPerHour": 50,
  "overheadCostPerHour": 50,
  "createdAt": "2022-03-15T14:59:32.607Z",
  "member": {
    "id": "ec5543de-3b0f-47a0-b8ef-a6e18dc4b885",
    "name": "John Smith"
  },
  "project": {
    "id": "095e0780-48bf-472c-8deb-2fc3ebc7d90c",
    "name": "Vendor Portal",
    "client": {
      "id": "4cacdf11-71d1-4fbb-90ee-b091803581b0",
      "name": "Joe's Shop"
    }
  },
  "roles": [
    {
      "id": "7ad5a34a-07b7-48e9-a760-bd220d52e354",
      "name": "Project Manager"
    }
  ],
  "budget": {
    "billableHours": 1000,
    "nonBillableHours": 200
  },
  "monthlyBudget": {
    "billableHours": 150,
    "nonBillableHours": 30
  }
}

Attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`typeId`	`string`	The type of project member. Can be either `"administrator"` (Project administrator) or `"collaborator"` (Project collaborator).
`isActive`	`boolean`	Flag indicating if the member is still active on the project.
`isBillable`	`boolean`	Only available if the project is not using roles, otherwise billability is assigned at the role level and this field will be `null`.
`rate`	`number`	The member's rate for the project, if assigned. Only available if the project is not using roles, otherwise the rate is assigned at the role level and this field will be `null`.
`overrideCostRate`	`boolean`	Override this project member's cost rate.
`costCurrency`	`string`	The currency code for the overridden cost rate. Returns `null` if `overrideCostRate` is `false`.
`costPerHour`	`decimal`	The overridden cost per hour. Returns `null` if `overrideCostRate` is `false`.
`overheadCostPerHour`	`decimal`	The overridden overhead cost per hour. Returns `null` if `overrideCostRate` is `false`.
`createdAt`	`timestamp`	The timestamp when the object was created.
`member`	`object`	A simple object to the related workspace member. See attributes.
`project`	`object`	A simple object to the related project. See attributes.
`roles`	`array of objects`	A list of simple objects related to the project roles. This will be `null` if the project is not using roles. See attributes.
`budget`	`object`	The member's budget for the project. Only available if the project is not using roles, the project is using a budget, and the budget mode is either `"detailed"` or `"aggregated"`. See attributes.
`monthlyBudget`	`object`	The member's monthly budget for the project. Only available if the project is not using roles, the project is using a monthly budget, and the monthly budget mode is `"detailed"`. See attributes.

Member attributes

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

Project attributes

Name	Type	Description
`id`	`uuid`	The unique identifier for the object.
`name`	`string`	The name of the project.
`client`	`object`	A simple object to the related client. See attributes.

Client attributes

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

Role attributes

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

Budget attributes

Name	Type	Description
`billableHours`	`number`	The number of billable hours for the member's budget. Only set if the project is flagged as billable.
`nonBillableHours`	`number`	The number of non-billable hours for the member's budget.