API Documentation

The Workably API lets you read and write data to your Workably account programmatically. Use it to build Zapier automations, integrate with third-party tools, or build custom workflows.

Authentication

The Workably API uses personal API keys. Every user can generate their own key from Settings → Integrations → Zapier → Generate API Key.

Include your API key in the Authorization header of every request:

API keys are scoped to your organisation. They only return data belonging to your account — no cross-account access is possible. If a key is compromised, you can regenerate it instantly from Settings.

Generate your API key

Base URL

All API endpoints are available at:

All requests must use HTTPS. Requests over HTTP will be rejected.

Triggers — Read Data

Use these endpoints to read data from Workably. All return a JSON array ordered by most recently created first (up to 10 records).

Get Contacts

Returns the 10 most recently created contacts in your organisation.

Field	Type	Description
id	uuid	Unique contact ID
name	string	Contact full name
email	string	Email address
phone	string	Phone number
company	string	Company name
created_at	timestamp	When the contact was created

Get Deals

Returns the 10 most recently created deals in your pipeline.

Field	Type	Description
id	uuid	Unique deal ID
title	string	Deal title
value	number	Deal value
stage	string	Current pipeline stage
probability	number	Win probability (0–100)
expected_close_date	date	Expected close date
created_at	timestamp	When the deal was created

Get Tasks

Returns the 10 most recently created tasks.

Field	Type	Description
id	uuid	Unique task ID
title	string	Task title
due_date	timestamp	Due date
priority	string	low / medium / high
is_complete	boolean	Whether the task is complete
created_at	timestamp	When the task was created

Get Email Logs

Returns the 10 most recent email logs (sent and received).

Field	Type	Description
id	uuid	Unique log ID
from_email	string	Sender email address
to_email	string	Recipient email address
subject	string	Email subject line
body_snippet	string	First 2,000 characters of body
source	string	sent / received / bcc
logged_at	timestamp	When the email was logged

Actions — Write Data

Use these endpoints to create records in Workably. All POST requests require a JSON body and Content-Type: application/json.

Create Contact

Field	Required	Type	Description
name	required	string	Contact full name
email	optional	string	Email address
phone	optional	string	Phone number
company	optional	string	Company name

Create Deal

Field	Required	Type	Description
title	required	string	Deal title
value	optional	number	Deal value
stage	optional	string	Pipeline stage (defaults to "Lead")
expected_close_date	optional	date	Expected close date (YYYY-MM-DD)
contact_id	optional	uuid	Associated contact ID

Create Task

Field	Required	Type	Description
title	required	string	Task title
due_date	optional	timestamp	Due date (ISO 8601)
priority	optional	string	low / medium / high (defaults to "medium")
contact_id	optional	uuid	Associated contact ID

Native Zapier Integration

Workably has a native Zapier integration that connects to 5,000+ apps without writing any code. Search for "Workably" in Zapier to get started.

Trigger	Description
New Contact	Fires when a new contact is created in Workably
New Deal	Fires when a new deal is created in your pipeline
New Task	Fires when a new task is created
New Email	Fires when an email is sent or received

Action	Description
Create Contact	Creates a new contact in Workably
Create Deal	Creates a new deal in your pipeline
Create Task	Creates a new task

Error Codes

Status	Meaning
200	Success
201	Record created successfully
400	Bad request — missing required fields
401	Unauthorized — invalid or missing API key
500	Internal server error

Support

Need help with the API or Zapier integration? Email us at support@workably.app and we'll get back to you within 24 hours.