The Weesify API
Create links and QR codes, keep contacts in sync, and read your bio pages, forms, orders, courses, bookings, events and analytics from your own code. JSON over HTTPS, version 1.
Read or write, per resource. A token never does more than the person who made it.
Per-token and per-plan rate limits, reported in headers on every answer.
HMAC-SHA256 with a timestamp, retried with backoff, with a delivery log you can resend from.
One document, generated from the same source as this page. Import it into any client.
Authentication
Make a token in your workspace under Settings → Developers (owners and admins). It’s shown once, so keep it in your server’s secrets, never in a web page or an app people download. Send it in the Authorization header:
curl https://weesify.com/api/v1/workspace \
-H "Authorization: Bearer wsy_your_token"
A token belongs to one workspace. At every call it can do only what its scopes allow and what the person who made it can still do: if they leave or their role changes, the token follows. Revoke a token any time; it stops working straight away.
Coming from the old Weesify API? Your old API key keeps working here, as a bearer token, for 90 days after the move, with the same reach the old API had. Make a new token before then; Settings → Developers shows when your old key ends.
Quickstart
Any HTTP client works. Three calls cover the basics: read, create safely, and check your allowance.
# 1. Your newest links
curl "https://weesify.com/api/v1/links?limit=5" \
-H "Authorization: Bearer $WEESIFY_TOKEN"
# 2. Make one (a retry with the same key never makes two)
curl -X POST https://weesify.com/api/v1/links \
-H "Authorization: Bearer $WEESIFY_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: signup-2026-1042" \
-d '{"destination_url": "https://example.com/offer"}'
# 3. See the rate-limit headers
curl -i https://weesify.com/api/v1/workspace -H "Authorization: Bearer $WEESIFY_TOKEN"
Every answer is JSON. One thing comes as {"data": {…}}; a list as {"data": […], "meta": {…}}.
Scopes
| Scope | Lets the token |
|---|---|
| links:read | Short links and their click counts |
| links:write | Create, change and delete short links |
| qr:read | QR codes and their scans |
| qr:write | Create, change and delete QR codes |
| contacts:read | Contacts, their tags and details |
| contacts:write | Add, update, tag and delete contacts |
| forms:read | Forms and what people submitted |
| store:read | Products and orders (with buyers’ details) |
| sites:read | Your pages, HTML websites, their files, deployments, domains and usage |
| sites:write | Create HTML websites, upload and change files, settings and custom domains |
| sites:deploy | Publish HTML websites and roll them back |
| analytics:read | Clicks and views over time |
| events:read | Events, dates, ticket types, agenda, speakers, sponsors, exhibitors and venues |
| events:write | Create and change events and move them through their lifecycle |
| events:attendees | Registrations, attendees, tickets and ticket orders (with people’s details) |
| events:checkin | Scan tickets and read check-ins |
| bookings:read | Bookable services and bookings (with people’s details) |
| courses:read | Courses and their students’ enrolments and progress |
| webhooks:read | Webhook endpoints and their delivery log |
| webhooks:write | Add, change, test and remove webhook endpoints, and send deliveries again |
| blog:read | Blog posts (drafts included) and categories |
Requests and pages
- Send JSON bodies with
Content-Type: application/json. Times are ISO 8601 in UTC. ids are 26-character strings. - Lists come newest first as
{"data": [...], "meta": {"limit": 25, "next_cursor": "…"}}. Pass?cursor=to get the next page and?limit=(1–100, default 25). - Money is in the smallest unit (cents) with its currency.
Errors
Errors use RFC 7807 (application/problem+json). Validation errors list each field under errors.
{
"type": "https://weesify.com/developers#errors",
"title": "Invalid request",
"status": 422,
"detail": "Some fields need attention.",
"errors": { "destination_url": ["Enter a web address."] }
}
| Status | Means |
|---|---|
| 401 | No token, or it’s wrong, expired or revoked |
| 402 | The workspace is read-only until a plan is chosen, or a plan limit is reached |
| 403 | The token doesn’t have the scope, the person who made it can’t do this, or API access isn’t in the plan |
| 404 | Not found in this workspace, or that feature is switched off |
| 400 | The Idempotency-Key isn’t in the right format |
| 409 | The same Idempotency-Key is still being worked on, or was used for a different request |
| 422 | Something in the request isn’t right |
| 429 | Too many requests: wait for Retry-After seconds |
Rate limits
Each token may make 120 requests a minute and each workspace 600, counted in one-minute windows. Enterprise and Custom plans allow more. Past the limit you get a 429 with Retry-After: wait that many seconds and try again.
| Header | Means |
|---|---|
| X-RateLimit-Limit | Requests a minute this token may make |
| X-RateLimit-Remaining | Requests left this minute |
| X-RateLimit-Reset | Unix time when the minute resets |
| RateLimit | IETF form: limit, remaining, reset (seconds) |
| RateLimit-Policy | The policy, e.g. 120;w=60 |
| X-Request-Id | This request’s id, as shown in your request log |
Your workspace’s request log and usage against your plan are in Settings → Developers → Usage & logs, matched by X-Request-Id.
Retries
Send an Idempotency-Key header (1–80 letters, digits, dashes, dots, colons or underscores) with a POST. If the network drops and you retry with the same key, path and body within 24 hours, you get the original answer again (marked Idempotent-Replayed: true) and nothing runs twice. Keys belong to the token that sent them. The same key with another path or body gets a 409.
Weesify CLI
Deploy a folder to an HTML website from your computer or CI, pull it back, compare and roll back. One Node.js 18+ file with no packages: download it and run it.
curl -fsSLo weesify.mjs https://weesify.com/developers/cli/weesify.mjs && node weesify.mjs login
node weesify.mjs init
node weesify.mjs deploy -m "First version"
SHA-256 of the current file: e98494277685934e20bdfb05c7f9fe5087db5db66d80b2365a4d3f74ed51c8af
Install on macOS, Linux or Windows, every command, CI and exit codes →
Webhooks
Add an endpoint in Settings → Developers → Webhooks (or with POST /webhooks) and choose events. Weesify POSTs JSON to it as things happen, retries failures 6 times over about 21 hours, and keeps a 30-day delivery log you can send again from. After 5 events in a row can’t be delivered, the endpoint is switched off and the workspace’s admins are told. Answer with any 2xx within 5 seconds; redirects aren’t followed.
{
"id": "evt_01j…",
"event": "order.paid",
"created_at": "2026-10-31T09:30:00+00:00",
"workspace": { "id": "01j…" },
"data": {
"contact": { "id": "01j…", "email": "ada@example.com", "name": "Ada", "subscribed": true, "tags": [] },
"details": { "order": "W-1042", "product": "Preset pack" }
}
}
Check the signature. The X-Weesify-Signature header is t=<unix time>,v1=<hex>. Compute HMAC-SHA256 of t + "." + raw body with your endpoint’s signing secret and compare it (in constant time) with any v1: for a day after you rotate the secret there are two. Reject anything older than five minutes. The event id stays the same on retries, so you can ignore repeats.
// PHP
$body = file_get_contents('php://input');
parse_str(str_replace(',', '&', $_SERVER['HTTP_X_WEESIFY_SIGNATURE']), $sig);
$expected = hash_hmac('sha256', $sig['t'].'.'.$body, getenv('WEESIFY_WEBHOOK_SECRET'));
if (abs(time() - (int) $sig['t']) > 300 || ! hash_equals($expected, $sig['v1'] ?? '')) {
http_response_code(400); exit;
}
| Event | When |
|---|---|
| contact.created | New contact |
| contact.updated | Contact details changed |
| contact.subscribed | Subscribed |
| contact.unsubscribed | Unsubscribed |
| contact.tagged | Tag added |
| contact.untagged | Tag removed |
| contact.stage_changed | Stage changed |
| form.submitted | Form answered |
| order.paid | Order paid |
| order.refunded | Order refunded |
| booking.created | New booking |
| booking.cancelled | Booking cancelled |
| course.enrolled | Student enrolled |
| course.completed | Course completed |
| community.joined | Joined a community |
| event.created | Event created |
| event.published | Event published |
| event.updated | Event details changed |
| event.cancelled | Event cancelled |
| event.postponed | Event postponed |
| event.completed | Event completed |
| registration.created | Registration started |
| registration.confirmed | Registration confirmed |
| registration.cancelled | Registration cancelled |
| ticket.purchased | Ticket bought |
| payment.completed | Ticket payment completed |
| payment.failed | Ticket payment failed |
| ticket.refunded | Ticket refunded |
| attendee.checked_in | Attendee checked in |
| session.attended | Session attended |
| waitlist.joined | Joined a waitlist |
| feedback.submitted | Feedback submitted |
| post.published | Post published |
| post.failed | Post failed to publish |
| site.deployed | Website published |
| site.deploy_failed | Website failed to publish |
Workspace 1 endpoint
GET/workspaceThe workspace this token belongs to, and the token’s scopes
The workspace this token belongs to, and the token’s scopes.
curl -X GET https://weesify.com/api/v1/workspace \
-H "Authorization: Bearer wsy_…"
Links 6 endpoints
GET/linksList short links, newest first
List short links, newest first. Scope: links:read.
| Query | |
|---|---|
| search | Matches the back-half, destination or title |
| status | active (default), archived or all |
curl -X GET https://weesify.com/api/v1/links \
-H "Authorization: Bearer wsy_…"
POST/linksCreate a short link
Create a short link. Scope: links:write.
| Body | |
|---|---|
| destination_url * | Where it goes (https) |
| alias | The back-half; random if empty |
| title | Only you see it |
| domain_id | One of your domains; weesify.com if empty |
| redirect_status | 301, 302, 307 or 308 |
| starts_at | ISO 8601 |
| ends_at | ISO 8601 |
| click_limit | Integer |
| utm | {source, medium, campaign, term, content} |
| forward_query | Boolean |
curl -X POST https://weesify.com/api/v1/links \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"destination_url":"\u2026"}'
GET/links/{id}One short link
One short link. Scope: links:read.
curl -X GET https://weesify.com/api/v1/links/01j… \
-H "Authorization: Bearer wsy_…"
PATCH/links/{id}Change a short link (send only what changes); archived: true archives it
Change a short link (send only what changes); archived: true archives it. Scope: links:write.
| Body | |
|---|---|
| destination_url | |
| alias | |
| title | |
| archived | Boolean |
curl -X PATCH https://weesify.com/api/v1/links/01j… \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"destination_url":"\u2026"}'
DELETE/links/{id}Delete a short link (its address can be claimed again)
Delete a short link (its address can be claimed again). Scope: links:write.
curl -X DELETE https://weesify.com/api/v1/links/01j… \
-H "Authorization: Bearer wsy_…"
GET/links/{id}/statsClicks per day, top countries and referrers
Clicks per day, top countries and referrers. Scope: links:read + analytics:read.
| Query | |
|---|---|
| days | 7-90 (30) |
curl -X GET https://weesify.com/api/v1/links/01j…/stats \
-H "Authorization: Bearer wsy_…"
QR codes 5 endpoints
GET/qr-codesList QR codes
List QR codes. Scope: qr:read.
| Query | |
|---|---|
| campaign | Only this campaign |
curl -X GET https://weesify.com/api/v1/qr-codes \
-H "Authorization: Bearer wsy_…"
POST/qr-codesCreate a QR code
Create a QR code. Scope: qr:write.
| Body | |
|---|---|
| name * | |
| type | dynamic (default), url, text, email, phone, sms, wifi, vcard… |
| target | {type: short_link|site, id} for dynamic codes |
| payload | Content for static types, e.g. {url} |
| campaign | |
| placement | Where it’s printed |
curl -X POST https://weesify.com/api/v1/qr-codes \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
GET/qr-codes/{id}One QR code, with SVG and PNG download links
One QR code, with SVG and PNG download links. Scope: qr:read.
curl -X GET https://weesify.com/api/v1/qr-codes/01j… \
-H "Authorization: Bearer wsy_…"
PATCH/qr-codes/{id}Change a QR code
Change a QR code. Scope: qr:write.
| Body | |
|---|---|
| name | |
| target | |
| campaign | |
| placement |
curl -X PATCH https://weesify.com/api/v1/qr-codes/01j… \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
DELETE/qr-codes/{id}Delete a QR code
Delete a QR code. Scope: qr:write.
curl -X DELETE https://weesify.com/api/v1/qr-codes/01j… \
-H "Authorization: Bearer wsy_…"
Contacts 8 endpoints
GET/contactsList contacts
List contacts. Scope: contacts:read.
| Query | |
|---|---|
| Exact address | |
| tag | A tag id |
| updated_since | ISO 8601 |
curl -X GET https://weesify.com/api/v1/contacts \
-H "Authorization: Bearer wsy_…"
POST/contactsAdd a contact
Add a contact. Scope: contacts:write.
| Body | |
|---|---|
| email * | |
| name | |
| phone | |
| company | |
| stage | subscriber, lead, customer, student, member |
| subscribed | true only with the person’s consent (it is recorded) |
| tags | Tag names |
| fields | Custom fields by key |
curl -X POST https://weesify.com/api/v1/contacts \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"email":"\u2026"}'
GET/contacts/{id}One contact
One contact. Scope: contacts:read.
curl -X GET https://weesify.com/api/v1/contacts/01j… \
-H "Authorization: Bearer wsy_…"
PATCH/contacts/{id}Change a contact; subscribed: false unsubscribes
Change a contact; subscribed: false unsubscribes. Scope: contacts:write.
| Body | |
|---|---|
| name | |
| stage | |
| subscribed | false only |
| tags | |
| fields |
curl -X PATCH https://weesify.com/api/v1/contacts/01j… \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"email":"\u2026"}'
DELETE/contacts/{id}Delete a contact and their history
Delete a contact and their history. Scope: contacts:write.
curl -X DELETE https://weesify.com/api/v1/contacts/01j… \
-H "Authorization: Bearer wsy_…"
POST/contacts/{id}/tagsTag a contact
Tag a contact. Scope: contacts:write.
| Body | |
|---|---|
| tag * | A tag name (made if new) |
curl -X POST https://weesify.com/api/v1/contacts/01j…/tags \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"tag":"\u2026"}'
DELETE/contacts/{id}/tags/{tag}Remove a tag
Remove a tag. Scope: contacts:write.
curl -X DELETE https://weesify.com/api/v1/contacts/01j…/tags/01j… \
-H "Authorization: Bearer wsy_…"
GET/tagsList tags
List tags. Scope: contacts:read.
curl -X GET https://weesify.com/api/v1/tags \
-H "Authorization: Bearer wsy_…"
Forms 3 endpoints
GET/formsList forms
List forms. Scope: forms:read.
curl -X GET https://weesify.com/api/v1/forms \
-H "Authorization: Bearer wsy_…"
GET/forms/{id}One form
One form. Scope: forms:read.
curl -X GET https://weesify.com/api/v1/forms/01j… \
-H "Authorization: Bearer wsy_…"
GET/forms/{id}/submissionsWhat people submitted
What people submitted. Scope: forms:read.
| Query | |
|---|---|
| since | ISO 8601 |
curl -X GET https://weesify.com/api/v1/forms/01j…/submissions \
-H "Authorization: Bearer wsy_…"
Store 4 endpoints
GET/productsList products
List products. Scope: store:read.
curl -X GET https://weesify.com/api/v1/products \
-H "Authorization: Bearer wsy_…"
GET/products/{id}One product
One product. Scope: store:read.
curl -X GET https://weesify.com/api/v1/products/01j… \
-H "Authorization: Bearer wsy_…"
GET/ordersList orders, newest first
List orders, newest first. Scope: store:read.
| Query | |
|---|---|
| status | paid, pending, failed, refunded, cancelled |
| since | ISO 8601 |
curl -X GET https://weesify.com/api/v1/orders \
-H "Authorization: Bearer wsy_…"
GET/orders/{id}One order with its items
One order with its items. Scope: store:read.
curl -X GET https://weesify.com/api/v1/orders/01j… \
-H "Authorization: Bearer wsy_…"
Bio pages & sites 2 endpoints
GET/sitesList bio pages and sites
List bio pages and sites. Scope: sites:read.
curl -X GET https://weesify.com/api/v1/sites \
-H "Authorization: Bearer wsy_…"
GET/sites/{id}One bio page or site
One bio page or site. Scope: sites:read.
curl -X GET https://weesify.com/api/v1/sites/01j… \
-H "Authorization: Bearer wsy_…"
Events 23 endpoints
GET/eventsList events, newest first
List events, newest first. Scope: events:read.
| Query | |
|---|---|
| status | draft, published, registration_open, … |
| starts_after | ISO 8601 |
| q | Name contains |
curl -X GET https://weesify.com/api/v1/events \
-H "Authorization: Bearer wsy_…"
POST/eventsCreate an event (a draft) with its first date and tickets
Create an event (a draft) with its first date and tickets. Scope: events:write.
| Body | |
|---|---|
| name * | |
| timezone * | IANA zone, e.g. Europe/London |
| starts_local * | Wall clock in the zone: 2026-11-14T18:30 |
| ends_local * | Wall clock in the zone |
| format | in_person, virtual or hybrid |
| visibility | public, unlisted, private |
| registration_mode | open, approval, rsvp, invite, external, none |
| capacity | Integer |
| currency | ISO 4217 |
| type | An event type key |
| venue_id | One of your venues |
| recurrence | {rule: RRULE} |
| tickets | [{name, kind, price_minor, quantity}] |
curl -X POST https://weesify.com/api/v1/events \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026","timezone":"\u2026","starts_local":"\u2026","ends_local":"\u2026"}'
GET/events/{id}One event
One event. Scope: events:read.
curl -X GET https://weesify.com/api/v1/events/01j… \
-H "Authorization: Bearer wsy_…"
PATCH/events/{id}Change an event (send only what changes)
Change an event (send only what changes). Scope: events:write.
| Body | |
|---|---|
| name | |
| summary | |
| starts_local | |
| ends_local | |
| timezone | |
| capacity | |
| visibility | |
| venue_id |
curl -X PATCH https://weesify.com/api/v1/events/01j… \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
POST/events/{id}/statusMove an event through its lifecycle (publish, open registration, cancel…) with the app’s rules
Move an event through its lifecycle (publish, open registration, cancel…) with the app’s rules. Scope: events:write.
| Body | |
|---|---|
| status * | published, registration_open, registration_closed, postponed, cancelled, … |
| reason | For cancellations |
curl -X POST https://weesify.com/api/v1/events/01j…/status \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"status":"\u2026"}'
GET/events/{id}/occurrencesIts dates, with places left
Its dates, with places left. Scope: events:read.
| Query | |
|---|---|
| upcoming | 1 = only dates that haven’t ended |
curl -X GET https://weesify.com/api/v1/events/01j…/occurrences \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/ticket-typesIts ticket types and prices (minor units)
Its ticket types and prices (minor units). Scope: events:read.
curl -X GET https://weesify.com/api/v1/events/01j…/ticket-types \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/registrationsRegistrations (buyers), newest first
Registrations (buyers), newest first. Scope: events:attendees.
| Query | |
|---|---|
| status | confirmed, pending, cancelled, refunded… |
| Exact address |
curl -X GET https://weesify.com/api/v1/events/01j…/registrations \
-H "Authorization: Bearer wsy_…"
POST/events/{id}/registrationsRegister someone (same rules as the event page; paid → pay_url)
Register someone (same rules as the event page; paid → pay_url). Scope: events:attendees + events:write.
| Body | |
|---|---|
| tickets * | {ticket_type_id: quantity} |
| email * | |
| name | |
| occurrence_id | For multi-date events |
| attendees | [{name, email}] one per ticket |
| code | Promo or access code |
| answers | Registration form answers by key |
curl -X POST https://weesify.com/api/v1/events/01j…/registrations \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"tickets":"\u2026","email":"\u2026"}'
GET/events/{id}/registrations/{item}One registration
One registration. Scope: events:attendees.
curl -X GET https://weesify.com/api/v1/events/01j…/registrations/01j… \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/attendeesAttendees (one per ticket) with their ticket number
Attendees (one per ticket) with their ticket number. Scope: events:attendees.
| Query | |
|---|---|
| status | confirmed, pending, cancelled… |
| occurrence_id | |
| checked_in | 1 |
curl -X GET https://weesify.com/api/v1/events/01j…/attendees \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/attendees/{item}One attendee
One attendee. Scope: events:attendees.
curl -X GET https://weesify.com/api/v1/events/01j…/attendees/01j… \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/ticketsTickets: number and status (never the QR payload)
Tickets: number and status (never the QR payload). Scope: events:attendees.
| Query | |
|---|---|
| status | valid or void |
| number | WSY-XXXX-XXXX |
curl -X GET https://weesify.com/api/v1/events/01j…/tickets \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/ordersTicket orders (commerce orders for this event)
Ticket orders (commerce orders for this event). Scope: events:attendees (+ events.finance role).
| Query | |
|---|---|
| status | paid, pending, failed, refunded |
curl -X GET https://weesify.com/api/v1/events/01j…/orders \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/sessionsAgenda sessions
Agenda sessions. Scope: events:read.
curl -X GET https://weesify.com/api/v1/events/01j…/sessions \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/speakersSpeakers (public profile fields)
Speakers (public profile fields). Scope: events:read.
curl -X GET https://weesify.com/api/v1/events/01j…/speakers \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/sponsorsSponsors
Sponsors. Scope: events:read.
curl -X GET https://weesify.com/api/v1/events/01j…/sponsors \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/exhibitorsExhibitors
Exhibitors. Scope: events:read.
curl -X GET https://weesify.com/api/v1/events/01j…/exhibitors \
-H "Authorization: Bearer wsy_…"
GET/events/{id}/check-insCheck-in scans, with their result
Check-in scans, with their result. Scope: events:checkin.
| Query | |
|---|---|
| result | accepted, duplicate, invalid… |
curl -X GET https://weesify.com/api/v1/events/01j…/check-ins \
-H "Authorization: Bearer wsy_…"
POST/events/{id}/check-insScan a ticket (verifies the signed QR; idempotent per client_uuid)
Scan a ticket (verifies the signed QR; idempotent per client_uuid). Scope: events:checkin.
| Body | |
|---|---|
| payload * | The QR text, WT1.… |
| client_uuid | UUID from your device |
| direction | in or out |
| session_id |
curl -X POST https://weesify.com/api/v1/events/01j…/check-ins \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"payload":"\u2026"}'
GET/events/{id}/check-ins/{item}One check-in
One check-in. Scope: events:checkin.
curl -X GET https://weesify.com/api/v1/events/01j…/check-ins/01j… \
-H "Authorization: Bearer wsy_…"
GET/venuesYour venues
Your venues. Scope: events:read.
curl -X GET https://weesify.com/api/v1/venues \
-H "Authorization: Bearer wsy_…"
GET/venues/{id}One venue
One venue. Scope: events:read.
curl -X GET https://weesify.com/api/v1/venues/01j… \
-H "Authorization: Bearer wsy_…"
Bookings & meetings 3 endpoints
GET/booking-servicesBookable services, with length, capacity and price (minor units)
Bookable services, with length, capacity and price (minor units). Scope: bookings:read.
curl -X GET https://weesify.com/api/v1/booking-services \
-H "Authorization: Bearer wsy_…"
GET/bookingsBookings, newest first (never the guest’s private meeting link)
Bookings, newest first (never the guest’s private meeting link). Scope: bookings:read.
| Query | |
|---|---|
| status | held, pending, confirmed, in_progress, cancelled, attended, no_show |
| service_id | One service |
| starts_after | ISO 8601 |
| starts_before | ISO 8601 |
curl -X GET https://weesify.com/api/v1/bookings \
-H "Authorization: Bearer wsy_…"
GET/bookings/{id}One booking
One booking. Scope: bookings:read.
curl -X GET https://weesify.com/api/v1/bookings/01j… \
-H "Authorization: Bearer wsy_…"
Courses 4 endpoints
GET/coursesCourses, with lesson and student counts
Courses, with lesson and student counts. Scope: courses:read.
curl -X GET https://weesify.com/api/v1/courses \
-H "Authorization: Bearer wsy_…"
GET/courses/{id}One course
One course. Scope: courses:read.
curl -X GET https://weesify.com/api/v1/courses/01j… \
-H "Authorization: Bearer wsy_…"
GET/courses/{id}/enrollmentsIts students, with progress (never their private course link)
Its students, with progress (never their private course link). Scope: courses:read.
| Query | |
|---|---|
| status | active or revoked |
| completed | 1 = only students who finished |
curl -X GET https://weesify.com/api/v1/courses/01j…/enrollments \
-H "Authorization: Bearer wsy_…"
GET/enrollments/{id}One enrolment
One enrolment. Scope: courses:read.
curl -X GET https://weesify.com/api/v1/enrollments/01j… \
-H "Authorization: Bearer wsy_…"
Websites 20 endpoints
GET/websitesList HTML websites, newest first
List HTML websites, newest first. Scope: sites:read.
| Query | |
|---|---|
| status | draft, published, unpublished, archived or suspended |
curl -X GET https://weesify.com/api/v1/websites \
-H "Authorization: Bearer wsy_…"
POST/websitesCreate an empty HTML website
Create an empty HTML website. Scope: sites:write.
| Body | |
|---|---|
| name * | Up to 120 characters |
| slug | Its address: weesify.com/{slug}/ ([a-z0-9-], 3–63). Shared with pages and short links, so it must be free; from the name if empty |
curl -X POST https://weesify.com/api/v1/websites \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
GET/websites/{id}One website: status, url (https://weesify.com/{slug}/), files and storage
One website: status, url (https://weesify.com/{slug}/), files and storage. Scope: sites:read.
curl -X GET https://weesify.com/api/v1/websites/01j… \
-H "Authorization: Bearer wsy_…"
PATCH/websites/{id}Rename it, change its address or homepage, or its routing settings
Rename it, change its address or homepage, or its routing settings. Scope: sites:write.
| Body | |
|---|---|
| name | |
| slug | New weesify.com/{slug}/ address; the old one redirects |
| homepage | A path such as index.html |
| settings | {clean_urls, trailing_slash, spa_fallback, not_found, redirects, headers, noindex} |
curl -X PATCH https://weesify.com/api/v1/websites/01j… \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
DELETE/websites/{id}Delete a website (disconnects its domains); needs sites:write and the publish permission
Delete a website (disconnects its domains); needs sites:write and the publish permission. Scope: sites:write.
curl -X DELETE https://weesify.com/api/v1/websites/01j… \
-H "Authorization: Bearer wsy_…"
GET/websites/{id}/filesEvery file in the working draft (or the live site, or one deployment): path, size, sha256, type
Every file in the working draft (or the live site, or one deployment): path, size, sha256, type. Scope: sites:read.
| Query | |
|---|---|
| source | draft (default), live or a deployment id |
curl -X GET https://weesify.com/api/v1/websites/01j…/files \
-H "Authorization: Bearer wsy_…"
POST/websites/{id}/filesUpload files (multipart files[] with optional paths[] and dir); blocked types are reported, not stored
Upload files (multipart files[] with optional paths[] and dir); blocked types are reported, not stored. Scope: sites:write.
| Body | |
|---|---|
| files * | multipart files[] |
| paths | multipart paths[]: each file’s relative path |
| dir | Folder to upload into |
curl -X POST https://weesify.com/api/v1/websites/01j…/files \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"files":"\u2026"}'
PUT/websites/{id}/files/{path}Write one file from the raw request body (creates folders as needed)
Write one file from the raw request body (creates folders as needed). Scope: sites:write.
curl -X PUT https://weesify.com/api/v1/websites/01j…/files/{path} \
-H "Authorization: Bearer wsy_…"
DELETE/websites/{id}/files/{path}Delete a file or folder from the draft
Delete a file or folder from the draft. Scope: sites:write.
curl -X DELETE https://weesify.com/api/v1/websites/01j…/files/{path} \
-H "Authorization: Bearer wsy_…"
POST/websites/{id}/deploymentsPublish the draft — or send a ZIP as multipart archive to replace the draft and publish it. Needs an approved review when the site requires approval
Publish the draft — or send a ZIP as multipart archive to replace the draft and publish it. Needs an approved review when the site requires approval. Scope: sites:deploy.
| Body | |
|---|---|
| message | Shown in the deployment history |
| archive | multipart ZIP (also needs sites:write) |
| replace | With archive: 1 makes the draft exactly the ZIP (files not in it are removed) |
curl -X POST https://weesify.com/api/v1/websites/01j…/deployments \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"message":"\u2026"}'
GET/websites/{id}/deploymentsDeployment history, newest first
Deployment history, newest first. Scope: sites:read.
curl -X GET https://weesify.com/api/v1/websites/01j…/deployments \
-H "Authorization: Bearer wsy_…"
GET/websites/{id}/deployments/{item}One deployment and its status (live, failed, superseded)
One deployment and its status (live, failed, superseded). Scope: sites:read.
curl -X GET https://weesify.com/api/v1/websites/01j…/deployments/01j… \
-H "Authorization: Bearer wsy_…"
POST/websites/{id}/rollbackMake an earlier deployment live again
Make an earlier deployment live again. Scope: sites:deploy.
| Body | |
|---|---|
| deployment_id * | A deployment of this website |
curl -X POST https://weesify.com/api/v1/websites/01j…/rollback \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"deployment_id":"\u2026"}'
GET/websites/{id}/domainsCustom domains: state, DNS records to add, HTTPS
Custom domains: state, DNS records to add, HTTPS. Scope: sites:read.
curl -X GET https://weesify.com/api/v1/websites/01j…/domains \
-H "Authorization: Bearer wsy_…"
POST/websites/{id}/domainsConnect a custom domain (pending until its TXT record verifies)
Connect a custom domain (pending until its TXT record verifies). Scope: sites:write.
| Body | |
|---|---|
| host * | e.g. www.yourbrand.com |
curl -X POST https://weesify.com/api/v1/websites/01j…/domains \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"host":"\u2026"}'
POST/websites/{id}/domains/{item}/verifyCheck ownership, DNS and HTTPS now
Check ownership, DNS and HTTPS now. Scope: sites:write.
curl -X POST https://weesify.com/api/v1/websites/01j…/domains/01j…/verify \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
DELETE/websites/{id}/domains/{item}Disconnect a custom domain
Disconnect a custom domain. Scope: sites:write.
curl -X DELETE https://weesify.com/api/v1/websites/01j…/domains/01j… \
-H "Authorization: Bearer wsy_…"
POST/websites/{id}/archiveReplace or update the working draft from a ZIP without publishing
Replace or update the working draft from a ZIP without publishing. Scope: sites:write.
| Body | |
|---|---|
| archive * | multipart ZIP |
| replace | 1: the draft becomes exactly the ZIP; otherwise files are added or overwritten |
curl -X POST https://weesify.com/api/v1/websites/01j…/archive \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"archive":"\u2026"}'
GET/websites/{id}/archiveDownload the draft, the live site or one deployment as a ZIP
Download the draft, the live site or one deployment as a ZIP. Scope: sites:read.
| Query | |
|---|---|
| source | draft (default), live or a deployment id |
curl -X GET https://weesify.com/api/v1/websites/01j…/archive \
-H "Authorization: Bearer wsy_…"
GET/websites/{id}/usageStorage, bandwidth, views, visits, form submissions and plan limits
Storage, bandwidth, views, visits, form submissions and plan limits. Scope: sites:read.
curl -X GET https://weesify.com/api/v1/websites/01j…/usage \
-H "Authorization: Bearer wsy_…"
Blog 3 endpoints
GET/blog/postsBlog posts, newest first (drafts included)
Blog posts, newest first (drafts included). Scope: blog:read.
| Query | |
|---|---|
| status | draft, scheduled, published, archived |
| category_id | One category |
curl -X GET https://weesify.com/api/v1/blog/posts \
-H "Authorization: Bearer wsy_…"
GET/blog/posts/{id}One post, with its body
One post, with its body. Scope: blog:read.
curl -X GET https://weesify.com/api/v1/blog/posts/01j… \
-H "Authorization: Bearer wsy_…"
GET/blog/categoriesBlog categories
Blog categories. Scope: blog:read.
curl -X GET https://weesify.com/api/v1/blog/categories \
-H "Authorization: Bearer wsy_…"
Analytics 1 endpoint
GET/analytics/summaryViews and clicks per day, with top countries, referrers and devices
Views and clicks per day, with top countries, referrers and devices. Scope: analytics:read.
| Query | |
|---|---|
| days | 1-90 (30) |
| subject | site, short_link or qr_code |
| subject_id | One of them |
curl -X GET https://weesify.com/api/v1/analytics/summary \
-H "Authorization: Bearer wsy_…"
Webhooks 10 endpoints
GET/webhook-eventsEvery event an endpoint can ask for
Every event an endpoint can ask for. Scope: webhooks:read.
curl -X GET https://weesify.com/api/v1/webhook-events \
-H "Authorization: Bearer wsy_…"
GET/webhooksYour webhook, Slack and Discord endpoints
Your webhook, Slack and Discord endpoints. Scope: webhooks:read.
curl -X GET https://weesify.com/api/v1/webhooks \
-H "Authorization: Bearer wsy_…"
POST/webhooksAdd an endpoint; the signing secret is in this answer only
Add an endpoint; the signing secret is in this answer only. Scope: webhooks:write.
| Body | |
|---|---|
| url * | https address on a host name (port 443) |
| events * | Event names, e.g. ["order.paid"] |
| kind | webhook (default), slack or discord |
| description | Only you see it |
curl -X POST https://weesify.com/api/v1/webhooks \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"url":"\u2026","events":"\u2026"}'
GET/webhooks/{id}One endpoint and its health
One endpoint and its health. Scope: webhooks:read.
curl -X GET https://weesify.com/api/v1/webhooks/01j… \
-H "Authorization: Bearer wsy_…"
PATCH/webhooks/{id}Change its events or description; active: false pauses it, active: true switches it back on
Change its events or description; active: false pauses it, active: true switches it back on. Scope: webhooks:write.
| Body | |
|---|---|
| events | |
| description | |
| active | Boolean |
curl -X PATCH https://weesify.com/api/v1/webhooks/01j… \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"events":"\u2026"}'
DELETE/webhooks/{id}Remove an endpoint
Remove an endpoint. Scope: webhooks:write.
curl -X DELETE https://weesify.com/api/v1/webhooks/01j… \
-H "Authorization: Bearer wsy_…"
POST/webhooks/{id}/testSend a signed “ping” now and get the result
Send a signed “ping” now and get the result. Scope: webhooks:write.
curl -X POST https://weesify.com/api/v1/webhooks/01j…/test \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
POST/webhooks/{id}/rotate-secretA new signing secret; the old one keeps signing alongside it for a day
A new signing secret; the old one keeps signing alongside it for a day. Scope: webhooks:write.
curl -X POST https://weesify.com/api/v1/webhooks/01j…/rotate-secret \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'
GET/webhooks/{id}/deliveriesIts delivery log (30 days), newest first
Its delivery log (30 days), newest first. Scope: webhooks:read.
| Query | |
|---|---|
| status | pending, sending, delivered, failed, dead |
curl -X GET https://weesify.com/api/v1/webhooks/01j…/deliveries \
-H "Authorization: Bearer wsy_…"
POST/webhooks/{id}/deliveries/{item}/redeliverSend a delivery again (same event id)
Send a delivery again (same event id). Scope: webhooks:write.
curl -X POST https://weesify.com/api/v1/webhooks/01j…/deliveries/01j…/redeliver \
-H "Authorization: Bearer wsy_…" \
-H "Content-Type: application/json" \
-d '{"name":"\u2026"}'