Tasks (To Dos)
Tasks are the simple to-dos or reminders feature to keep reps organized. You can push tasks to a rep via the API to remind them of important to-dos in their organization.
Tasks can be associated to a Contact.
Rules
- Tasks create a push notification on the
due_atdate/time - Tasks associated to a Contact show up on the Contact details screen
- If a Task is marked as complete, it does not send a push notification
JSON Structure
{ "id": 12345, "company_id": 67890, "user_company_id": 11111, "contact_id": 22222, "body": "Follow up with Jane about her recent order", "due_at": "2025-01-20T14:00:00Z", "completed_at": null, "created_at": "2025-01-15T10:30:00Z", "contact": { "id": 22222, "first_name": "Jane", "last_name": "Smith", ... } }
API Endpoints
Company Scoped
Note: Company scoped endpoints will only return tasks created from their API token. Tasks created by Users directly are not accessible via the Company API.
| Verb | Endpoint | Description |
|---|---|---|
| GET | /api/company/crm/v202506/tasks | List all tasks |
| GET | /api/company/crm/v202506/tasks/:id | Get a specific task |
| POST | /api/company/crm/v202506/tasks | Create a new task |
| PATCH | /api/company/crm/v202506/tasks/:id | Update a task |
| DELETE | /api/company/crm/v202506/tasks/:id | Delete a task |
User Scoped
| Verb | Endpoint | Description |
|---|---|---|
| GET | /api/user/crm/v202506/tasks | List user's tasks |
| GET | /api/user/crm/v202506/tasks/:id | Get a specific task |
| POST | /api/user/crm/v202506/tasks | Create a new task |
| PATCH | /api/user/crm/v202506/tasks/:id | Update a task |
| DELETE | /api/user/crm/v202506/tasks/:id | Delete a task |
Next Steps
- Review the Core Elements Overview for API access patterns
- See Use Cases for examples of Tasks in workflows
- Explore the User API Reference for detailed endpoint documentation