API overview
Connect your own tools to one NorthQuest workspace.
Base URL: https://app.northquest.io/api/v1
Keys
- Owners and admins make keys in Settings › API. You need to have signed in within the last 15 minutes.
- A key is shown once. Store it like a password. Every owner and admin gets an email when a key is made.
- Choose Read only or Read and write. Use read only unless you need to change things.
- A key belongs to the workspace. It keeps working when the person who made it leaves.
- It stops when revoked, when it expires (never by default; 30, 90 or 365 days if chosen), or when the workspace closes.
- Up to 10 live keys per workspace.
Send the key on every request:
Authorization: Bearer nq_…
Calls
GET /actions lists what your key can call. POST /actions/<action> with a JSON body runs one action and answers {"data": …}.
| Action | Access | Body |
|---|---|---|
campaigns.list | read | {} |
campaigns.runs | read | {} |
campaigns.pause | write | {"id":"<run id>"} |
campaigns.resume | write | {"id":"<run id>"} |
lists.list | read | {} |
lists.create | write | {"name":"Q4 prospects"} |
leads.block | write | {"contactIds":["<lead id>"]} |
inbox.list | read | {"view":"needs_reply"} |
inbox.label | write | {"id":"<conversation id>","label":"interested"} |
inbox.done | write | {"id":"<conversation id>","done":true} |
mailboxes.list | read | {} |
domains.read | read | {} |
inbox.list also takes campaign, mailbox, label, unread, q and offset. Fields may be added within v1, never renamed or removed.
Example
curl -s https://app.northquest.io/api/v1/actions/campaigns.list \
-H "Authorization: Bearer $NORTHQUEST_KEY" \
-H "Content-Type: application/json" -d '{}'
Errors
Errors answer {"error":"…"}:
400bad input401missing, wrong, expired or revoked key403not allowed (a read-only key, or the workspace has no active owner)404unknown path or id409conflict, retry413body over 100 KB429over the rate limit500server error, with arequestId. Send it to us with Send to NorthQuest support in NorthQuest AI. See Get help.
Limits and logs
- 120 calls a minute per key.
- Writes, refusals and failures show in Settings › Activity log.
Not in v1 yet: sending email, importing leads.