Use these endpoints to find and view tasks, and create tasks individually or for multiple contacts in your team's Apollo workspace. You can also change task details, owners, priorities, and due dates, or mark tasks as completed or skipped.
Key concepts
| Tasks and task types | Tasks track actions your team needs to take, such as calls, manual emails, LinkedIn actions, or other follow-up work. The type identifies the action. Creating or completing a task doesn't itself perform that outreach. |
| Contacts and owners | A contact ID identifies the person the task concerns. A user ID identifies the team member responsible for the task. Bulk create tasks creates a separate task for each contact using the same owner, type, due date, and other submitted details. |
| Identifying a task | Search and create responses return a task id that you can pass to retrieve, update, complete, or skip the task. Creating tasks doesn't deduplicate them, so repeating a create request can add another task for the same contact. |
| Task status | Scheduled tasks represent upcoming work. Completed tasks represent finished work; skipped tasks represent work that wasn't performed. Use the complete or skip endpoint to resolve an existing task. The fields you can update depend on its current status. |
Choose an endpoint
| I want to . . . | Use this |
|---|---|
| Find tasks in my team's Apollo workspace | Search for tasks |
| Retrieve a task's full details and associated records | Get a task |
| Create one task for a contact | Create a task |
| Create the same task for multiple contacts | Bulk create tasks |
| Mark a task as completed | Complete a task |
| Change a task's details, owner, priority, or due date | Update a task |
| Mark a task as skipped without completing it | Skip a task |
Example workflows
Schedule follow-up tasks for contacts
Assign follow-up work for a group of contacts to the team member responsible for reaching out.
- Call search for contacts to find the contacts and retain their
idvalues. - Call get a list of users and retain the ID of the intended task owner.
- Call bulk create tasks with the contact IDs in
contact_ids, the owner ID asuser_id, atype,statusset toscheduled, and adue_atdate-time. Include anoteto explain the follow-up. - Retain each task's
idfrom the returnedtasksarray to manage the tasks later.
For a call task, set type to call. Use ISO 8601 date-time values with the appropriate time zone for due_at. To create a task for one contact, use create a task with contact_id instead.
Learn more: Use the create a task and bulk create tasks references to explore task types and scheduling.
Review and manage pending tasks
Bring tasks into your system so your team can review context, adjust upcoming work, and record what was completed.
- Call search for tasks and retain the
idof each task you want to review. - Pass a task ID to get a task to review its current status, details, and associated contact or account.
- If scheduled work needs to change, pass the task ID to update a task with the changes, such as a new
due_atornote. Include the currentpriorityandcreator_idif you want to preserve them; omitting these fields resets them. - After the action is performed, pass the task ID to complete a task. If the action is no longer needed, use skip a task instead.
Check the current status before completing or skipping a task. Either action returns an error if the task is already completed or skipped.
Learn more: Use the update a task, complete a task, and skip a task references to dig in to the workflow.