get https://api.teamgridapp.com/projects
Get all projects
Field | Possible values | Description |
---|---|---|
_id | String (17 characters long) | Unique identifier |
name | String | Display name of the project |
individualId | String | Individual identifier / Project number of the project |
briefing | String | Briefing of the project. Can be formatted with markdown |
dueDate | Date | Due date of the project |
contactId | String (17 characters long) | Unique identifier of the contact to which this project is assigned to |
listId | String (17 characters long) | Unique identifier of the projects list to which this project is assigned to |
order | Number | Order in the projects list to which this project is assigned to |
managerId | String (17 characters long) | Unique identifier of the user who is the project manager |
completed | Boolean | Indicates wether this project is completed or not |
archived | Boolean | Indicates wether this project is archived or not |
billing | Object (see below for sub fields) | Billing settings |
billing.accounting | Object (see below for sub fields) | Accounting settings |
billing.accounting.type | Number | Type of the accounting configuration for this project.0 : by service1 : by person2 : by hourlyRate (see billing.accounting.hourlyRate )3 : none4 : use settings of assigned contact |
billing.accounting.hourlyRate | Number | Hourly rate for this project. Only applies if billing.accounting.type is 2 |
billing.budget | Object (see below for sub fields) | Budget settings |
billing.budget.type | Number | Type of the budget configuration of this project.0 : by hours1 : by fees4 : hours per month5 : fees per month6 : use budget of assigned contact100 : none |
billing.budget.hours | Number | Budget in hours. Only applies if billing.budget.type is 0 or 4 |
billing.budget.fees | Number | Budget in fees. Only applies if billing.budget.type is 1 or 5 |
billing.users | Object[] (see below for sub fields) | Custom accounting configuration by users |
billing.users.$.userId | String (17 characters long) | Unique identifier of the user |
billing.users.$.hourlyRate | Number | If this user create time entries assigned to the project, this hourly rate will be applied |
billing.services | Object[] (see below for sub fields) | Custom accounting configuration by services |
billing.services.$.serviceId | String (17 characters long) | Unique identifier of the service |
billing.services.$.billable | Boolean | Indicates wether time entries, assigned to the project and this service are billable |
billing.services.$.hourlyRate | Number | If a user create time entries assigned to the project and this service, this hourly rate will be applied |
info | Object (see below for sub fields) | Pre-aggregated information |
info.timeBillable | Number | Billable time in seconds |
info.timeNotBillable | Number | Not billable time in seconds |
info.totalTime | Number | Total tracked time in seconds |
info.costs | Number | Costs of tracked time |
info.revenue | Number | Revenue of tracked time |
info.profit | Number | Profit of tracked time |
info.spentBudget | Number | Spent budget |
info.remainingBudget | Number | Remaining budget |
info.tasksCompleted | Number | Amount of completed tasks |
info.tasksOpen | Number | Amount of open tasks |
info.tasksTotal | Number | Total amount of tasks in this project |
info.lastActivity | Date | Date of the latest activity in this project |
info.billedTimes | Number | Amount of billed times |
info.unbilledTimes | Number | Amount of unbilled times |
info.contactName | String | Name of the assigned customer |
info.managerName | String t | Name of the assigned manager |
createdAt | Date | When was the project created |
createdBy | String (17 characters long) | Unique identifier of the user who created this project |