API reference

Getting started

1. Sign in and open Developer API in your menu. API access is part of plans that list "Developer API access".
2. Create a key with the read permission (add write to add leads or manage webhooks). Copy it: it is shown once.
3. Call the API:

curl https://wigrow.widevelop.us/api/v1/me \
  -H "Authorization: Bearer wg_your_key"

Authentication

Every request needs Authorization: Bearer wg_…. A key belongs to one business and only ever sees that business's data. Keys are stored as a one-way hash; if you lose one, create a new one. A missing, wrong, revoked or expired key gets 401; a key without the needed permission gets 403 insufficient_scope.

Errors

Errors always look like this, with a stable code you can program against:

{"error": {"code": "validation_failed", "message": "Some fields are not valid.", "details": {"email": ["…"]}}}

Rate limits

Each key may make a set number of requests per minute (60 by default; the exact number is in X-RateLimit-Limit). Every response has X-RateLimit-Limit and X-RateLimit-Remaining. Over the limit you get 429 with Retry-After (seconds).

Pagination

Lists take page and per_page (1–100, default 25) and return data, meta (page, per_page, total, last_page) and links (next, prev). Follow links.next until it is null.

Idempotency

Send Idempotency-Key: <any unique string> with a POST to retry it safely. Within 24 hours, the same key with the same body returns the first response again (with Idempotent-Replayed: true); the same key with a different body is refused with 409.

Versioning

The version is part of the path: /api/v1. Within v1 we may add fields and endpoints; we never remove or rename them. Ignore fields you do not know.

Webhooks

Add an endpoint (a public https:// address) in the app or with POST /webhooks. We send a JSON POST for each event you chose:

• contact.created — A lead was added (research, import, the API or by hand).
• reply.received — A lead replied to an email.
• meeting.scheduled — A meeting was confirmed in the calendar.
• opportunity.won — A deal was marked won.

Each delivery has Wi-Grow-Event, Wi-Grow-Delivery (also the id in the body; it stays the same on retries) and Wi-Grow-Signature: t=<unix time>,v1=<signature>. Verify it before trusting the body:

// PHP
[$t, $v1] = sscanf($_SERVER['HTTP_WI_GROW_SIGNATURE'], 't=%d,v1=%s');
$expected = hash_hmac('sha256', $t.'.'.file_get_contents('php://input'), $secret);
$valid = hash_equals($expected, $v1) && abs(time() - $t) < 300;

Answer with any 2xx within 10 seconds. Otherwise we retry after 1 minute, 5 minutes, 30 minutes, 2 hours and 6 hours. After 15 failed deliveries in a row the endpoint is switched off; you can switch it back on in the app.

Revoking and rotating keys

In Developer API, Revoke stops a key at once. Rotate creates a new secret with the same name and permissions and stops the old one at once, so update your systems first. Key changes appear in your account's security history.

Troubleshooting

• 401: check the header spelling (Bearer, one space) and that the key was not revoked or expired.
• 403 plan_required: your plan does not include the API; see Billing in the app.
• 404 for a record you can see in the app: contacts and companies use numbers; campaigns, conversations, deals, meetings and webhooks use the long ids from the API.
• Webhooks not arriving: open the endpoint in the app to see each delivery's status and the answer your server gave.

Account

curl https://wigrow.widevelop.us/api/v1/me \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/balances \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/usage \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/business-profile \
  -H "Authorization: Bearer wg_your_key"

Leads

curl https://wigrow.widevelop.us/api/v1/customer-profiles \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/contacts \
  -H "Authorization: Bearer wg_your_key"

curl -X POST https://wigrow.widevelop.us/api/v1/contacts \
  -H "Authorization: Bearer wg_your_key" \
  -H "Content-Type: application/json" -H "Idempotency-Key: 6f1c…" \
  -d '{"full_name":"Ana Ramdial","email":"ana@example.tt","company_name":"Coral Bay Foods","country":"TT"}'

curl https://wigrow.widevelop.us/api/v1/contacts/{contact} \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/companies \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/companies/{company} \
  -H "Authorization: Bearer wg_your_key"

Email

curl https://wigrow.widevelop.us/api/v1/campaigns \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/campaigns/{campaign} \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/conversations \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/conversations/{conversation} \
  -H "Authorization: Bearer wg_your_key"

CRM

curl https://wigrow.widevelop.us/api/v1/opportunities \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/opportunities/{opportunity} \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/meetings \
  -H "Authorization: Bearer wg_your_key"

curl https://wigrow.widevelop.us/api/v1/meetings/{meeting} \
  -H "Authorization: Bearer wg_your_key"

Webhooks

curl https://wigrow.widevelop.us/api/v1/webhooks \
  -H "Authorization: Bearer wg_your_key"

curl -X POST https://wigrow.widevelop.us/api/v1/webhooks \
  -H "Authorization: Bearer wg_your_key" \
  -H "Content-Type: application/json" -H "Idempotency-Key: 6f1c…" \
  -d '{"url":"https://example.com/hooks/wigrow","events":["contact.created"]}'

curl https://wigrow.widevelop.us/api/v1/webhooks/{webhook} \
  -H "Authorization: Bearer wg_your_key"

curl -X DELETE https://wigrow.widevelop.us/api/v1/webhooks/{webhook} \
  -H "Authorization: Bearer wg_your_key"

Objects

UsageEntry

Company

Contact

Campaign

Conversation

Opportunity

Meeting

Webhook