Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: SimplyBook.me Admin API
version: '2026-10-13'
description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-13: 3 operation(s) read from 1 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; SimplyBook.me has published no machine-readable contract that the pipeline could find. Engine: local.'
x-evidence-tiers:
code-example: 0
documentation: 3
pages-with-code: 0
pages-read: 1
x-generated-from: documentation
x-provenance: generated
x-authored-by: API Evangelist
x-generated: '2026-10-13'
x-generator: generate-contract-from-docs.py
x-engine: local
x-sources:
- https://help.simplybook.me/wiki/Special:MyLanguage/REST_API_webhooks
tags:
- name: Admin
paths:
/admin/webhooks:
get:
operationId: get_admin_webhooks
tags:
- Admin
summary: List subscriptions
description: Returns the list of webhook subscriptions. When omitted, only active subscriptions are returned.
x-source: https://help.simplybook.me/wiki/Special:MyLanguage/REST_API_webhooks
parameters:
- name: is_active
in: query
required: false
schema:
type: string
description: Filters by status (0 or 1). When omitted, only active subscriptions are returned.
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
post:
operationId: post_admin_webhooks
tags:
- Admin
summary: Create a subscription
description: Creates a new webhook subscription. Up to 5 active subscriptions are allowed per event; creating another deactivates the oldest one.
x-source: https://help.simplybook.me/wiki/Special:MyLanguage/REST_API_webhooks
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PostAdminWebhooksRequest'
responses:
'201':
description: Success (status as documented)
content:
application/json:
schema:
$ref: '#/components/schemas/PostAdminWebhooksResponse'
x-evidence:
kind: documentation
/admin/webhooks/{id}:
delete:
operationId: delete_admin_webhooks_id
tags:
- Admin
summary: Remove a subscription
description: Removes the subscription with the given id.
x-source: https://help.simplybook.me/wiki/Special:MyLanguage/REST_API_webhooks
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: Success (status as documented)
x-evidence:
kind: documentation
components:
schemas:
PostAdminWebhooksResponse:
type: object
properties:
id:
type: integer
description: Identifier of the created subscription.
url:
type: string
description: The callback URL.
event:
type: string
description: The subscribed event.
is_active:
type: integer
description: 1 if the subscription is active.
changed:
type: string
description: Timestamp of the last change (e.g., "2026-08-27 12:00:00").
PostAdminWebhooksRequest:
type: object
properties:
url:
type: string
description: A valid absolute URL (http/https) that will receive the callback.
event:
type: string
description: One of the event values listed in the documentation (e.g., new_client).
required:
- url
- event