Authenticate requests to the Contacts API using your API key or OAuth token. Keep credentials secure and use the least-privilege scopes to limit access to contacts, tasks, notes, and appointments.
To connect OmniFocus with the Contacts API, add the required credentials in your app connector settings. Store tokens securely and rotate them regularly.
Key endpoints used in this integration include: GET /contacts/:contactId, GET /contacts/:contactId/tasks, GET /contacts/:contactId/tasks/:taskId, GET /contacts/:contactId/notes, GET /contacts/:contactId/notes/:id, GET /contacts/:contactId/appointments, GET /contacts/, GET /contacts/business/:businessId, contacts.write, POST /contacts/, PUT /contacts/:contactId, DELETE /contacts/:contactId, POST /contacts/:contactId/tasks, PUT /contacts/:contactId/tasks/:taskId, PUT /contacts/:contactId/tasks/:taskId/completed, DELETE /contacts/:contactId/tasks/:taskId, POST /contacts/:contactId/tags.
Trigger: New or updated contact in Contacts API (via events on GET /contacts/:contactId).
Actions: Create a new OmniFocus task using contact data (name, company, email) and link it to the contact record via POST /contacts/:contactId/tasks; optionally attach notes from GET /contacts/:contactId/notes.
POST /contacts/:contactId/tasks
Key fields: contactId, taskTitle, dueDate, status
Trigger: Notes updated or added for a contact (GET /contacts/:contactId/notes).
Actions: Create or update OmniFocus notes tied to the corresponding task using PUT /contacts/:contactId/notes/:id or POST /contacts/:contactId/notes.
PUT /contacts/:contactId/notes/:id
Key fields: contactId, noteId, noteContent
Trigger: New or updated appointment for a contact (GET /contacts/:contactId/appointments).
Actions: Create OmniFocus calendar tasks with appointment date and location using POST /contacts/:contactId/tasks (or update existing task).
POST /contacts/:contactId/tasks
Key fields: contactId, appointmentId, dateTime, location
Automate repetitive work with no custom code required.
Speed up onboarding and ensure data accuracy across contacts and tasks.
Scale workflows with consistent triggers and actions across multiple contacts.
This section defines the common terms you’ll see: API Endpoint, Trigger, Action, and Authentication, plus the data fields used for mapping between Contacts API and OmniFocus.
A specific URL and HTTP method used to access or modify resources in the Contacts API.
An event that starts a workflow, such as a new contact or a notes update.
An operation performed in OmniFocus as a result of a trigger, such as creating a task or updating a note.
The method used to prove identity and authorize API requests (e.g., OAuth token, API key).
Whenever a new contact is added in Contacts API, a corresponding OmniFocus task is created with the contact name and key details populated.
As contact notes or notes updates occur, update linked OmniFocus tasks to keep everything in sync.
Convert appointment data into OmniFocus tasks or calendar entries to ensure timely follow-ups.
Obtain an API key or OAuth token for the Contacts API and define scopes for read/write access to contacts, tasks, notes, and appointments.
Define triggers (contact created/updated) and actions (create/update tasks, notes, or appointments) using the available endpoints.
Run tests to verify data integrity, ensure tasks map correctly to contacts, and deploy to production.
You can access endpoints like GET /contacts/:contactId, GET /contacts/:contactId/tasks, and POST /contacts/ to read or create data. Use the read endpoints to pull contact data and the write endpoints to create tasks or notes. The full list also includes notes, appointments, and tagging operations to support richer workflows. Refer to the Endpoint section for exact paths and methods.
Yes—this template is designed for no-code automation using an app connector. You can set triggers, actions, and data mappings without writing code. The available endpoints and fields are designed to be composed into your workflow visually.
Triggers fire when a defined event occurs, such as a new or updated contact or a notes change. In OmniFocus, map these triggers to actions like creating or updating tasks. You can often simulate triggers during testing using sample data.
Yes. You can map additional contact fields by including them in task titles, notes, or custom fields. Use the key fields section to specify which contact fields to pull (e.g., name, email, phone) and how to format them in OmniFocus.
Store credentials securely in your app connector vault or secret store. Rotate tokens regularly and apply the principle of least privilege to limit access to only the necessary endpoints and scopes.
Test by simulating new contacts and updates to verify tasks and notes are created or updated correctly. Check connector logs and OmniFocus task data to confirm correct mapping and data flow, then adjust mappings as needed.
The Endpoint list section on this page enumerates the main API calls you will use. You can copy these paths directly into your connector configuration and tailor them to your workflow.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
