Use API keys or OAuth tokens to securely access Contacts data from Coworks. Keep credentials secret and rotate periodically.
Grant the app the required scopes (read/write) to interact with your Contacts records via the API.
GET /contacts/:contactId — Retrieve a single contact GET /contacts/:contactId/tasks — List tasks for a contact GET /contacts/:contactId/tasks/:taskId — Get a specific task GET /contacts/:contactId/notes — List notes for a contact GET /contacts/:contactId/notes/:id — Get a note GET /contacts/:contactId/appointments — List appointments for a contact GET /contacts/ — List all contacts GET /contacts/business/:businessId — List or filter contacts by business contacts.write — Permission for write access to contacts POST /contacts/ — Create a contact PUT /contacts/:contactId — Update a contact DELETE /contacts/:contactId — Delete a contact POST /contacts/:contactId/tasks — Create a task for a contact PUT /contacts/:contactId/tasks/:taskId — Update a task PUT /contacts/:contactId/tasks/:taskId/completed — Mark a task as completed DELETE /contacts/:contactId/tasks/:taskId — Delete a task POST /contacts/:contactId/tags — Add a tag to a contact
Trigger: Retrieve a contact by ID to populate dashboards and quick-glance reports.
Actions: fetch contact data; optionally pull related tasks and notes for a fuller view.
GET /contacts/:contactId
Key fields: id, name, email, phone, status
Trigger: List tasks for a contact to monitor progress and deadlines.
Actions: create, update, or complete tasks via the API.
GET /contacts/:contactId/tasks
Fields: id, taskId, title, status, dueDate
Trigger: List notes for a contact to surface context for conversations.
Actions: fetch notes, create new notes as collaborative updates.
GET /contacts/:contactId/notes
Fields: id, content, createdAt, author
Build powerful integrations with zero coding and minimal setup.
Automate data flows between Coworks and your contact records to save time.
Scale your processes with real-time data synchronization and triggers.
A quick glossary of terms used throughout this guide: endpoints, authentication, triggers, actions, and data fields.
Application Programming Interface—the set of rules Coworks uses to access the Contacts API.
A callback mechanism to push changes from the Contacts API to Coworks in real time.
Industry-standard authorization protocol to grant limited access without sharing credentials.
Technique to fetch large result sets in segments to improve performance.
Use POST /contacts to create records when Coworks detects a new contact and sync their details automatically.
Whenever a contact is updated in Coworks, push changes to related tasks and notes via PUT and POST endpoints.
Leverage appointments endpoint to send reminders or trigger follow-ups from Coworks.
Obtain an API key or OAuth token and securely store it in Coworks.
Choose endpoints relevant to your workflow (e.g., GET /contacts/:contactId and GET /contacts/:contactId/tasks).
Run tests, monitor results, and deploy your automation to production.
No-code setups are available with Coworks using the Contacts API. You can trigger automations without writing code. For more complex needs, you can extend with custom scripts if desired.
The Contacts API supports API keys and OAuth tokens for secure access. Store credentials securely and rotate regularly.
End points like GET /contacts/:contactId and GET /contacts/:contactId/tasks are ideal for syncing core data; combine with notes and appointments for context.
Filtering by business is possible with the /contacts/business/:businessId endpoint or by applying query parameters on GET /contacts/ to segment results.
Use POST /contacts/ to create a new contact, providing essential fields such as name and email. Validate data and handle duplicates.
Update tasks with PUT /contacts/:contactId/tasks/:taskId or mark complete with PUT /contacts/:contactId/tasks/:taskId/completed. Use payloads to reflect changes.
Notes are created and retrieved via GET /contacts/:contactId/notes and POST /contacts/:contactId/notes. Store date, author, and content.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
