Docs
Get Collaborator Dashboard
GET /collaborators/{collaboratorId}/dashboard
GET
/collaborators/{collaboratorId}/dashboardRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
Returns a summary dashboard for a collaborator, including contacts, scheduled activities, deliverables, incomplete crew, and tasks.
Path Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| collaboratorId | Guid | Required | The ID of the collaborator. |
Response
| Field | Type | Description |
|---|---|---|
| contacts | Contact[] | Key contacts associated with the collaborator. |
| contacts[].id | Guid | Contact ID. |
| contacts[].firstName | string | First name. |
| contacts[].lastName | string | Last name. |
| contacts[].title | string | Job title. |
| contacts[].email | string | Email address. |
| contacts[].phoneNumber | string | Phone number. |
| activities | Activity[] | Scheduled activities for the collaborator. |
| activities[].id | Guid | Activity ID. |
| activities[].name | string | Activity name. |
| activities[].startDateTime | DateTime | Start date/time. |
| activities[].endDateTime | DateTime | End date/time. |
| deliverables | Deliverable[] | Pending deliverables. |
| deliverables[].id | Guid | Deliverable ID. |
| deliverables[].partitionKey | Guid | Partition key. |
| deliverables[].name | string | Deliverable name. |
| deliverables[].dueDate | DateTime | Due date. |
| deliverables[].status | string | Current status. |
| incompleteCrew | Contact[] | Crew members with incomplete profiles. Same shape as `contacts`. |
| tasks | Task[] | Tasks assigned to or involving this collaborator. |
| tasks[].id | Guid | Task ID. |
| tasks[].name | string | Task name. |
| tasks[].statusId | Guid| null | Current status ID. |
| tasks[].startDateTime | DateTime| null | Start date/time. |
| tasks[].endDateTime | DateTime| null | End date/time. |
| tasks[].description | string | Task description. |
| tasks[].priority | string | Priority level. |
| tasks[].index | int | Sort index. |
| tasks[].parentId | Guid| null | Parent task ID if nested. |
| tasks[].phaseId | Guid| null | Phase ID. |
| tasks[].assignees | object | Assigned users and collaborators. |
| tasks[].assignees.users | User[] | Assigned users (`{ id }`). |
| tasks[].assignees.collaborators | Collab[] | Assigned collaborators (`{ id }`). |
| tasks[].reviewers | User[] | Reviewer users (`{ id }`). |
| tasks[].attributes | Attribute[] | Custom attribute values (`{ attributeId, value }`). |
| tasks[].dependents | Guid[] | IDs of tasks that depend on this one. |
| tasks[].dependsOn | Guid[] | IDs of tasks this one depends on. |