KWAYZER API

A predictable, REST-ful API over your revenue data. All requests use HTTPS, are authenticated with a Bearer token, and return JSON. The base URL is:

Base URL

https://www.kwayzer.com/api/v1

GET

/{resource}

List records (paginated, filterable).

GET

/{resource}/{id}

Retrieve a single record.

POST

/{resource}

Create a record.

PATCH

/{resource}/{id}

Update fields on a record.

DELETE

/{resource}/{id}

Delete a record.

Authentication

Authenticate every request with a secret API key in the Authorization header. Generate and revoke keys under Settings → API. Keys are scoped read or read-write. Never expose a secret key in client-side code.

cURL

curl https://www.kwayzer.com/api/v1/contacts \
  -H "Authorization: Bearer kwz_live_a1b2c3d4..."

Pagination & filtering

List endpoints are paginated and accept the following query parameters. Responses include page, limit and total.

Param	Description
page	Page number (default 1).
limit	Records per page (default 25, max 100).
sort	Field to sort by, e.g. created_at.
order	asc or desc (default desc).
?field=value	Filter on any returned field, e.g. ?status=open.

Rate limits

Limits scale with your plan and reset daily. Every response returns X-RateLimit-Remaining. Exceeding the limit returns 429 Too Many Requests.

Starter

1,000 requests / day

Growth

10,000 requests / day

Agency

50,000 requests / day

Scale

200,000 requests / day

Enterprise

Custom

Errors

KWAYZER uses conventional HTTP status codes. 2xx success, 4xx a problem with your request, 5xx a problem on our end. Error bodies are JSON.

401 Unauthorized

{
  "error": "invalid_api_key",
  "message": "The provided API key is invalid or revoked."
}

Contacts

People in your CRM. Create, enrich, and segment your audience.

https://www.kwayzer.com/api/v1/contacts

Fields

id	string	Unique identifier
name	string	Full name
email	string	Primary email
company_id	string	Linked company
score	number	AI lead score (0–100)

Request

curl https://www.kwayzer.com/api/v1/contacts \
  -H "Authorization: Bearer kwz_live_..." \
  -G --data-urlencode "page=1" \
     --data-urlencode "limit=25" \
     --data-urlencode "sort=created_at" \
     --data-urlencode "order=desc"

Response

{
  "data": [
    {
      "id": "con_8f2a",
      "name": "Dana Whitfield",
      "email": "dana@northwind.io",
      "company_id": "com_4b1c",
      "score": 87
    }
  ],
  "page": 1,
  "limit": 25,
  "total": 1842
}

Companies

Accounts. The organizations your contacts and deals belong to.

https://www.kwayzer.com/api/v1/companies

Fields

id	string	Unique identifier
name	string	Company name
domain	string	Primary domain
employees	number	Headcount
industry	string	Industry vertical

Request

curl https://www.kwayzer.com/api/v1/companies/com_4b1c \
  -H "Authorization: Bearer kwz_live_..."

Response

{
  "id": "com_4b1c",
  "name": "Northwind",
  "domain": "northwind.io",
  "employees": 240,
  "industry": "SaaS"
}

Deals

Opportunities moving through your pipeline.

https://www.kwayzer.com/api/v1/deals

Fields

id	string	Unique identifier
title	string	Deal name
value	number	Amount in cents
stage	string	Pipeline stage
status	string	open · won · lost

Request

curl https://www.kwayzer.com/api/v1/deals \
  -X POST \
  -H "Authorization: Bearer kwz_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Northwind — Annual",
    "value": 4800000,
    "stage": "proposal",
    "company_id": "com_4b1c"
  }'

Response

{
  "id": "deal_9c3e",
  "title": "Northwind — Annual",
  "value": 4800000,
  "stage": "proposal",
  "status": "open"
}

Campaigns

Multi-channel campaigns and their performance.

https://www.kwayzer.com/api/v1/campaigns

Fields

id	string	Unique identifier
name	string	Campaign name
channel	string	email · paid · social
status	string	draft · live · ended
spend	number	Spend in cents

Request

curl https://www.kwayzer.com/api/v1/campaigns?status=live \
  -H "Authorization: Bearer kwz_live_..."

Response

{
  "data": [
    {
      "id": "cmp_2d7f",
      "name": "Q3 Demand Gen",
      "channel": "paid",
      "status": "live",
      "spend": 1250000
    }
  ],
  "page": 1,
  "limit": 25,
  "total": 6
}

Activities

The timeline — calls, emails, notes and tasks against any record.

https://www.kwayzer.com/api/v1/activities

Fields

id	string	Unique identifier
type	string	call · email · note · task
entity_type	string	contact · deal · company
entity_id	string	Related record id
created_at	string	ISO 8601 timestamp

Request

curl https://www.kwayzer.com/api/v1/activities?entity_type=deal&entity_id=deal_9c3e \
  -H "Authorization: Bearer kwz_live_..."

Response

{
  "data": [
    {
      "id": "act_77aa",
      "type": "note",
      "entity_type": "deal",
      "entity_id": "deal_9c3e",
      "created_at": "2026-06-17T09:12:00Z"
    }
  ],
  "page": 1,
  "limit": 25,
  "total": 14
}

Metrics

Aggregated revenue, pipeline and channel metrics (read-only).

https://www.kwayzer.com/api/v1/metrics

Fields

metric	string	e.g. pipeline_value
value	number	Current value
period	string	e.g. 2026-06
delta	number	Change vs. prior period

Request

curl https://www.kwayzer.com/api/v1/metrics?metric=pipeline_value&period=2026-06 \
  -H "Authorization: Bearer kwz_live_..."

Response

{
  "metric": "pipeline_value",
  "value": 18420000,
  "period": "2026-06",
  "delta": 0.12
}