Skip to main content
POST
Connect SimplyBook.me

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
api_host
enum<string>
required

REST API endpoint from Custom Features → API, for example https://user-api-v2.simplybook.it.

Available options:
https://user-api-v2.simplybook.me,
https://user-api-v2.simplybook.it,
https://user-api-v2.simplybook.asia,
https://user-api-v2.simplybook.us,
https://user-api-v2.simplybook.vip,
https://user-api-v2.simplybook.cc,
https://user-api-v2.simplybook.pro,
https://user-api-v2.enterpriseappointments.com,
https://user-api-v2.simplybook.webnode.page,
https://user-api-v2.servicebookings.net,
https://user-api-v2.booking.names.uk,
https://user-api-v2.booking.lcn.uk,
https://user-api-v2.booking.register365.ie
company_login
string
required

Company login, for example mycompany from mycompany.simplybook.me.

Pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,63}$
user_login
string
required

Staff user login the API User Key belongs to.

api_key
string
required
write-only

API User Key (api_user_key_…). Never returned.

name
string
default:simplybook

Unique tool name, using letters, numbers and underscores.

Response

Created. Secret values are masked.

data
object
required

A reusable tool of the account. Secret values inside config (auth values, header values, Browser Use login password and authenticator key) are always masked as •••.