RemindR API

The RemindR API lets another system work with one RemindR instance (a business): read and change its services and work hours, and see, place, move and cancel its bookings. It speaks JSON over HTTPS.

Calls are made server to server. Never put an API key in a web page or in an app that customers download.

OpenAPI 3.1 description

Import it into Postman, Insomnia or a code generator.

Getting started

Your first call:

curl "https://remindr.se/api/v1/me" \
  -H "Authorization: Bearer rmr_xxxxxxxx_…"

Authentication

Every call carries an instance API key in the Authorization header. An admin of the instance creates the key in RemindR Admin under Settings → PC-Kassa → API keys, chooses what it may do, and copies it; it is shown only once. Keys can be given an expiry date and can be revoked at any time.

The key decides which instance you work with: there is no instance id in the URL, and a key never reaches another instance. The keys are the same ones RemindRSync uses; give each system its own key, so one can be revoked without the others.

Authorization: Bearer rmr_<prefix>_<secret>

Scopes

`services:read`	Categories, services, add-ons and the resources that perform them.
`services:write`	Create and change categories, services and add-ons.
`schedules:read`	Work hours and exceptions.
`schedules:write`	Add, replace and remove work hours and exceptions.
`bookings:read`	Bookings, their customers, and availability.
`bookings:write`	Place, move and cancel bookings, and add the customers they are for.

A write scope includes its read scope. Resources can be listed with any read scope. The RemindRSync scopes (sync:read, sync:write) give no access to this API.

Conventions

Field names are camelCase. Send Content-Type: application/json.
Dates are YYYY-MM-DD and times of day HH:MM, both in the instance's time zone (see GET /me). Instants such as startsAt are ISO 8601 with an offset.
Prices are in SEK including VAT, as numbers.
PATCH changes only the fields you send. To clear a field that can be empty, send null.
Responses are never cached. Lists are not paginated: they are bounded by the date range you ask for, or by the size of the catalogue.

Rate limits

Each key may make 120 requests a minute, counted per calendar minute. Every response says where you are: RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset (seconds until the count starts over).

Over the limit, the answer is 429 rate_limited with a Retry-After header. Wait that many seconds before trying again. A system that needs more should spread its calls, or fetch lists rather than one item at a time.

HTTP/1.1 429 Too Many Requests
Retry-After: 23
RateLimit-Limit: 120
RateLimit-Remaining: 0
RateLimit-Reset: 23

{ "error": "rate_limited" }

Idempotency

A write that times out may or may not have happened. Send an Idempotency-Key header with every POST, PUT, PATCH and DELETE, and use the same key when you retry: if the first request went through, you get its response back, marked Idempotent-Replayed: true, and nothing is done twice.

Use a new key, such as a UUID, for each new change. The key is tied to the request: the same key with a different method, path or body is refused with 422 idempotency_key_reused. A request that failed is not stored, so retrying it with the same key runs it again. Keys are kept for 24 hours.

curl -X POST "https://remindr.se/api/v1/bookings" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -H "Idempotency-Key: 4f6c1f0e-9a51-4c1e-8f3a-2b7d9c0e5a11" \
  -H "Content-Type: application/json" \
  -d '{ … }'

Errors

Errors have a status code and a JSON body with a machine-readable code, and sometimes a detail:

HTTP/1.1 409 Conflict

{ "error": "no_capacity", "detail": "no capacity" }

Status	Code	Meaning
401	`invalid_key`	No key, or not a valid one.
401	`revoked`	The key has been revoked.
401	`expired`	The key has expired.
403	`missing_scope`	The key does not have the scope the operation needs.
403	`instance_suspended`	The instance is not active.
404	`not_found`	Nothing with that id in this instance.
400	`invalid_json`	The body is not JSON.
422	`invalid_body`	The body does not match the schema; `detail` says where.
422	`invalid_query`	A query parameter is missing or wrong; `detail` says which.
409	`in_use`	Something still refers to it.
409	`duplicate`	It already exists.
413	`payload_too_large`	The body is over 256 kB.
429	`rate_limited`	Over the key's limit this minute. Wait `Retry-After` seconds.
400	`invalid_idempotency_key`	The Idempotency-Key header is not 1–255 printable ASCII characters.
422	`idempotency_key_reused`	The Idempotency-Key was already used for a different request.
409	`idempotency_conflict`	The first request with this Idempotency-Key has not finished. Retry shortly.
500	`server_error`	Something went wrong on our side. Safe to retry reads; check before retrying writes.
409	`invalid_category`	The category is not one of this instance's.
409	`schedule_overlap`	The hours overlap other hours for the same resource and weekday.
409	`no_capacity`	No resource has room at that time.
409	`start_required`	The service is booked by time slot: give startsAt.
409	`day_required`	The service is booked by the day: give day.
409	`invalid_resource`	The resource cannot perform the service, or is not active.
409	`invalid_customer`	The customer is not one of this instance's.
409	`invalid_service`	The service does not exist or is not active.
409	`invalid_addon`	An add-on does not belong to the service, or is not active.
409	`booking_disabled`	The instance's plan does not include booking.
409	`booking_cancelled`	A cancelled booking cannot be moved.

Account

The key you are calling with and the instance it belongs to.

Who am I

GET/me

The instance the key belongs to, its time zone and booking mode, and the key's scopes. Works with any valid key: a good first call.

Scope: any key

Response 200

curl -X GET "https://remindr.se/api/v1/me" \
  -H "Authorization: Bearer $REMINDR_KEY"

Services

The catalogue: categories, services and their add-ons, and which resources can perform each service.

List categories

GET/categories

Scope: services:read

Response 200

A list of Category

curl -X GET "https://remindr.se/api/v1/categories" \
  -H "Authorization: Bearer $REMINDR_KEY"

Create a category

POST/categories

Scope: services:write

Parameters

Field Type

Field	Type
`Idempotency-Key (header)`optional	string Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours. min length 1 · max length 255

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(CategoryCreate)

Field Type

Field	Type
`name`required	string min length 1 · max length 120
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000 · default 0
`isActive`optional	boolean default true

namerequired

string

min length 1 · max length 120

sortOrderoptional

integer

Lower comes first.

≥ -100000 · ≤ 100000 · default 0

isActiveoptional

boolean

default true

Response 201

Update a category

PATCH/categories/{id}

Only the fields given change.

Scope: services:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(CategoryUpdate)

Field Type

Field	Type
`name`optional	string min length 1 · max length 120
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000
`isActive`optional	boolean

nameoptional

string

min length 1 · max length 120

sortOrderoptional

integer

Lower comes first.

≥ -100000 · ≤ 100000

isActiveoptional

boolean

Response 200

Delete a category

DELETE/categories/{id}

Only an empty category can be deleted; move or deactivate its services first.

Scope: services:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Response 204

No content.

May also return: not_found, in_use

curl -X DELETE "https://remindr.se/api/v1/categories/{id}" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY"

List services

GET/services

Every service, active or not, with its add-ons and resources, in the order they are shown.

Scope: services:read

Response 200

A list of Service

curl -X GET "https://remindr.se/api/v1/services" \
  -H "Authorization: Bearer $REMINDR_KEY"

Create a service

POST/services

Give the category by id, or by name to find or create it. A new service is not shown on the booking site until isPublic is true, and cannot be booked until at least one resource can perform it.

Scope: services:write

Parameters

Field Type

Field	Type
`Idempotency-Key (header)`optional	string Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours. min length 1 · max length 255

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(ServiceCreate)

Field	Type
`categoryId`optional	string (uuid) An existing category. Give this or `categoryName`.
`categoryName`optional	string A category by name; created if there is none. Give this or `categoryId`. min length 1 · max length 120
`name`required	string min length 1 · max length 200
`description`optional	string \| null max length 4000 · default null
`durationMinutes`required	integer ≥ 5 · ≤ 1440
`price`required	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000 · default 0
`isActive`optional	boolean default true
`isPublic`optional	boolean default false
`bookingMode`optional	"day_capacity" \| "time_slots" \| null `time_slots`: the customer picks a start time. `day_capacity`: the customer picks a day and the work is planned into it. default null
`slotIntervalMinutes`optional	5 \| 10 \| 15 \| 20 \| 30 \| 60 \| null default null
`minHoursAhead`optional	integer \| null ≥ 0 · ≤ 720 · default null
`maxDaysAhead`optional	integer \| null ≥ 0 · ≤ 730 · default null
`resources`optional	array of object Replaces the resources that can perform the service. Resources of other instances are ignored. at most 200 · default []

Response 201

Service

May also return: invalid_category

curl -X POST "https://remindr.se/api/v1/services" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Get a service

GET/services/{id}

Scope: services:read

Parameters

Field	Type
`{id}`required	string (uuid)

Response 200

Service

May also return: not_found

curl -X GET "https://remindr.se/api/v1/services/{id}" \
  -H "Authorization: Bearer $REMINDR_KEY"

Update a service

PATCH/services/{id}

Only the fields given change; resources, when given, replaces the whole list. Services are not deleted through the API, because bookings refer to them: set isActive to false instead. Existing bookings keep the name, duration and price they were booked with.

Scope: services:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(ServiceUpdate)

Field	Type
`categoryId`optional	string (uuid) An existing category. Give this or `categoryName`.
`categoryName`optional	string A category by name; created if there is none. Give this or `categoryId`. min length 1 · max length 120
`name`optional	string min length 1 · max length 200
`description`optional	string \| null max length 4000
`durationMinutes`optional	integer ≥ 5 · ≤ 1440
`price`optional	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000
`isActive`optional	boolean
`isPublic`optional	boolean Offered on the public booking site.
`bookingMode`optional	"day_capacity" \| "time_slots" \| null `time_slots`: the customer picks a start time. `day_capacity`: the customer picks a day and the work is planned into it.
`slotIntervalMinutes`optional	5 \| 10 \| 15 \| 20 \| 30 \| 60 \| null
`minHoursAhead`optional	integer \| null ≥ 0 · ≤ 720
`maxDaysAhead`optional	integer \| null ≥ 0 · ≤ 730
`resources`optional	array of object Replaces the resources that can perform the service. Resources of other instances are ignored. at most 200

Response 200

Service

May also return: not_found, invalid_category

curl -X PATCH "https://remindr.se/api/v1/services/{id}" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Add an add-on

POST/services/{id}/addons

Scope: services:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(AddonCreate)

Field	Type
`name`required	string min length 1 · max length 200
`description`optional	string \| null max length 4000 · default null
`durationMinutes`optional	integer Minutes the add-on adds to the booking. ≥ 0 · ≤ 1440 · default 0
`price`optional	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999 · default 0
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000 · default 0
`isActive`optional	boolean default true
`isPublic`optional	boolean default false

Response 201

Addon

May also return: not_found

curl -X POST "https://remindr.se/api/v1/services/{id}/addons" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Update an add-on

PATCH/services/{id}/addons/{addonId}

Only the fields given change.

Scope: services:write

Parameters

Field Type

{id}required

string (uuid)

{addonId}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(AddonUpdate)

Field	Type
`name`optional	string min length 1 · max length 200
`description`optional	string \| null max length 4000
`durationMinutes`optional	integer Minutes the add-on adds to the booking. ≥ 0 · ≤ 1440
`price`optional	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000
`isActive`optional	boolean
`isPublic`optional	boolean Offered on the public booking site.

Response 200

Addon

May also return: not_found

curl -X PATCH "https://remindr.se/api/v1/services/{id}/addons/{addonId}" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Delete an add-on

DELETE/services/{id}/addons/{addonId}

Bookings keep their own copy of the add-on.

Scope: services:write

Parameters

Field Type

{id}required

string (uuid)

{addonId}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Response 204

No content.

May also return: not_found

curl -X DELETE "https://remindr.se/api/v1/services/{id}/addons/{addonId}" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY"

Resources

Staff and other resources that bookings are placed on. Created and named in RemindR Admin.

List resources

GET/resources

Active resources first.

Scope: any read scope

Response 200

A list of Resource

curl -X GET "https://remindr.se/api/v1/resources" \
  -H "Authorization: Bearer $REMINDR_KEY"

Work hours

When each resource works, week by week, and exceptions such as closed days or other hours.

Get a resource's work hours

GET/resources/{id}/work-hours

Scope: schedules:read

Parameters

Field	Type
`{id}`required	string (uuid)

Response 200

A list of WorkHours

May also return: not_found

curl -X GET "https://remindr.se/api/v1/resources/{id}/work-hours" \
  -H "Authorization: Bearer $REMINDR_KEY"

Add work hours

POST/resources/{id}/work-hours

Adds the same hours to each weekday given. Returns all of the resource's work hours. Hours may not overlap others on the same weekday and dates.

Scope: schedules:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(WorkHoursCreate)

Field	Type
`weekdays`required	array of integer The same hours on each of these weekdays. at least 1 · at most 7
`startTime`required	string Time of day, HH:MM (24 h).
`endTime`required	string Time of day, HH:MM (24 h).
`validFrom`optional	string (date) \| null A date, YYYY-MM-DD, in the instance's time zone. default null
`validTo`optional	string (date) \| null A date, YYYY-MM-DD, in the instance's time zone. default null

Response 201

A list of WorkHours

May also return: not_found, schedule_overlap

curl -X POST "https://remindr.se/api/v1/resources/{id}/work-hours" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Replace all work hours

PUT/resources/{id}/work-hours

Sets the resource's complete work hours in one go: all or nothing. Handy for keeping RemindR in step with another system. Existing bookings are not moved.

Scope: schedules:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(WorkHoursReplace)

Field Type

Field	Type
`entries`required	array of object The resource's complete work hours. Everything not listed is removed. An empty list removes all. at most 200

entriesrequired

array of object

The resource's complete work hours. Everything not listed is removed. An empty list removes all.

at most 200

Response 200

A list of WorkHours

May also return: not_found, schedule_overlap

curl -X PUT "https://remindr.se/api/v1/resources/{id}/work-hours" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Delete work hours

DELETE/resources/{id}/work-hours/{entryId}

Scope: schedules:write

Parameters

Field Type

{id}required

string (uuid)

{entryId}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Response 204

No content.

May also return: not_found

curl -X DELETE "https://remindr.se/api/v1/resources/{id}/work-hours/{entryId}" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY"

List exceptions

GET/schedule-exceptions

Closed days and other hours that have not ended yet, for the whole instance and each resource.

Scope: schedules:read

Parameters

Field	Type
`from`optional	string (date) Exceptions ending on or after this day. Default: today.
`resourceId`optional	string (uuid) Only this resource's exceptions (instance-wide ones are always included).

Response 200

A list of ScheduleException

curl -X GET "https://remindr.se/api/v1/schedule-exceptions" \
  -H "Authorization: Bearer $REMINDR_KEY"

Add an exception

POST/schedule-exceptions

Closes a period, or sets other hours for it, for one resource or the whole instance. Takes precedence over the weekly work hours. Existing bookings are not moved.

Scope: schedules:write

Parameters

Field Type

Field	Type
`Idempotency-Key (header)`optional	string Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours. min length 1 · max length 255

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(ScheduleExceptionCreate)

Field	Type
`resourceId`optional	string (uuid) \| null Null or left out: the whole instance. default null
`startDate`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`endDate`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`kind`required	"closed" \| "custom_hours" `closed`: no work at all. `custom_hours`: only between startTime and endTime.
`startTime`optional	string \| null Required for custom_hours. default null
`endTime`optional	string \| null Required for custom_hours. default null
`note`optional	string \| null max length 200 · default null

Response 201

ScheduleException

May also return: not_found

curl -X POST "https://remindr.se/api/v1/schedule-exceptions" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Delete an exception

DELETE/schedule-exceptions/{id}

Scope: schedules:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Response 204

No content.

May also return: not_found

curl -X DELETE "https://remindr.se/api/v1/schedule-exceptions/{id}" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY"

Bookings

Bookings as staff see them. Placing, moving and cancelling check capacity and work hours, and send the same confirmations as RemindR Admin.

List bookings

GET/bookings

Bookings on the days from from to to, at most 93 days at a time.

Scope: bookings:read

Parameters

Field	Type
`from`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`to`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`status`optional	"confirmed" \| "cancelled" \| "all" default "confirmed"
`resourceId`optional	string (uuid)

Response 200

A list of Booking

curl -X GET "https://remindr.se/api/v1/bookings" \
  -H "Authorization: Bearer $REMINDR_KEY"

Create a booking

POST/bookings

For a service booked by time slot give startsAt; for one booked by the day give day. Without resourceId the first free resource that can perform the service is chosen. Give an existing customer's id, or the customer's details: a customer with the same mobile number is reused. The instance's confirmation e-mail and SMS are sent as when staff book.

Scope: bookings:write

Parameters

Field Type

Field	Type
`Idempotency-Key (header)`optional	string Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours. min length 1 · max length 255

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(BookingCreate)

Field	Type
`serviceId`required	string (uuid)
`addonIds`optional	array of string (uuid) at most 20 · default []
`day`optional	string (date) Required for services booked by the day. Ignored for time slots, where the day follows startsAt.
`startsAt`optional	string (date-time) Required for services booked by time slot.
`resourceId`optional	string (uuid) A specific resource. Left out: any free resource that can do the service.
`customerId`optional	string (uuid) An existing customer. Give this or `customer`.
`customer`optional	CustomerCreate
`customerNote`optional	string \| null max length 2000 · default null
`internalNote`optional	string \| null Only visible to staff. max length 2000 · default null
`smsOptIn`optional	boolean Send SMS confirmation and reminder, if the instance sends them. default true
`emailOptIn`optional	boolean Send e-mail confirmation and reminder, if the instance sends them. default true

Response 201

Booking

May also return: no_capacity, start_required, day_required, invalid_resource, invalid_customer, invalid_service, invalid_addon, booking_disabled

curl -X POST "https://remindr.se/api/v1/bookings" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Get a booking

GET/bookings/{id}

Scope: bookings:read

Parameters

Field	Type
`{id}`required	string (uuid)

Response 200

Booking

May also return: not_found

curl -X GET "https://remindr.se/api/v1/bookings/{id}" \
  -H "Authorization: Bearer $REMINDR_KEY"

Move or update a booking

PATCH/bookings/{id}

Giving startsAt, day or resourceId moves the booking, checking capacity as for a new one. Notes and opt-ins change as given. No message is sent to the customer.

Scope: bookings:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(BookingUpdate)

Giving day, startsAt or resourceId moves the booking; the other fields are updated as given.

Field	Type
`day`optional	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`startsAt`optional	string (date-time) ISO 8601 with offset.
`resourceId`optional	string (uuid) \| null Moves the booking to this resource. Null: any free resource. Left out: keeps the current one if it is free.
`customerNote`optional	string \| null max length 2000
`internalNote`optional	string \| null max length 2000
`smsOptIn`optional	boolean
`emailOptIn`optional	boolean

Response 200

Booking

May also return: not_found, no_capacity, start_required, invalid_resource, booking_cancelled

curl -X PATCH "https://remindr.se/api/v1/bookings/{id}" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Cancel a booking

POST/bookings/{id}/cancel

Stops reminders not yet sent and sends the instance's cancellation message. Cancelling a cancelled booking changes nothing.

Scope: bookings:write

Parameters

Field Type

{id}required

string (uuid)

Idempotency-Key (header)optional

string

Any unique string, e.g. a UUID. A retry with the same key and the same request gets the first response back, marked Idempotent-Replayed: true, instead of doing the change twice. Kept for 24 hours.

min length 1 · max length 255

Request body(BookingCancel)

Field	Type
`reason`optional	string \| null max length 500 · default null

Response 200

Booking

May also return: not_found

curl -X POST "https://remindr.se/api/v1/bookings/{id}/cancel" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $REMINDR_KEY" \
  -d '{ … }'

Availability

Free days and start times, as staff see them: the customer booking window (notice, how far ahead) does not apply.

Free days

GET/availability

Days from from to to (at most 63) with room for the service and add-ons.

Scope: bookings:read

Parameters

Field	Type
`serviceId`required	string (uuid)
`addonId`optional	string (uuid) \| array of string (uuid) Add-on ids; repeat the parameter for more than one. at most 20
`from`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`to`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.

Response 200

A list of AvailableDay

May also return: invalid_service, invalid_addon

curl -X GET "https://remindr.se/api/v1/availability" \
  -H "Authorization: Bearer $REMINDR_KEY"

Free start times

GET/availability/slots

Start times on a day for a service booked by time slot, each with the resource it would be booked on. Empty for services booked by the day.

Scope: bookings:read

Parameters

Field Type

serviceIdrequired

string (uuid)

addonIdoptional

string (uuid) | array of string (uuid)

Add-on ids; repeat the parameter for more than one.

at most 20

dayrequired

string (date)

A date, YYYY-MM-DD, in the instance's time zone.

Response 200

A list of AvailableSlot

May also return: invalid_service, invalid_addon

curl -X GET "https://remindr.se/api/v1/availability/slots" \
  -H "Authorization: Bearer $REMINDR_KEY"

Models

Me

Field	Type
`instance`	object
`key`	object

CategoryCreate

Field Type

Field	Type
`name`required	string min length 1 · max length 120
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000 · default 0
`isActive`optional	boolean default true

namerequired

string

min length 1 · max length 120

sortOrderoptional

integer

Lower comes first.

≥ -100000 · ≤ 100000 · default 0

isActiveoptional

boolean

default true

CategoryUpdate

Field Type

Field	Type
`name`optional	string min length 1 · max length 120
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000
`isActive`optional	boolean

nameoptional

string

min length 1 · max length 120

sortOrderoptional

integer

Lower comes first.

≥ -100000 · ≤ 100000

isActiveoptional

boolean

Addon

Field	Type
`id`	string (uuid)
`name`	string
`description`	string \| null
`durationMinutes`	integer ≥ -9007199254740991 · ≤ 9007199254740991
`price`	number
`sortOrder`	integer ≥ -9007199254740991 · ≤ 9007199254740991
`isActive`	boolean
`isPublic`	boolean

AddonCreate

Field	Type
`name`required	string min length 1 · max length 200
`description`optional	string \| null max length 4000 · default null
`durationMinutes`optional	integer Minutes the add-on adds to the booking. ≥ 0 · ≤ 1440 · default 0
`price`optional	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999 · default 0
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000 · default 0
`isActive`optional	boolean default true
`isPublic`optional	boolean default false

AddonUpdate

Field	Type
`name`optional	string min length 1 · max length 200
`description`optional	string \| null max length 4000
`durationMinutes`optional	integer Minutes the add-on adds to the booking. ≥ 0 · ≤ 1440
`price`optional	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000
`isActive`optional	boolean
`isPublic`optional	boolean Offered on the public booking site.

Service

Field	Type
`id`	string (uuid)
`categoryId`	string (uuid)
`categoryName`	string
`name`	string
`description`	string \| null
`durationMinutes`	integer ≥ -9007199254740991 · ≤ 9007199254740991
`price`	number
`sortOrder`	integer ≥ -9007199254740991 · ≤ 9007199254740991
`isActive`	boolean
`isPublic`	boolean
`bookingMode`	"day_capacity" \| "time_slots" \| null Null follows the instance's setting.
`slotIntervalMinutes`	integer \| null Null follows the instance's setting. ≥ -9007199254740991 · ≤ 9007199254740991
`minHoursAhead`	integer \| null Notice needed, in hours. Null follows the instance's setting. ≥ -9007199254740991 · ≤ 9007199254740991
`maxDaysAhead`	integer \| null How far ahead it can be booked, in days. Null follows the instance's setting. ≥ -9007199254740991 · ≤ 9007199254740991
`addons`	array of Addon
`resources`	array of object The resources (staff) that can perform the service.

ServiceCreate

Field	Type
`categoryId`optional	string (uuid) An existing category. Give this or `categoryName`.
`categoryName`optional	string A category by name; created if there is none. Give this or `categoryId`. min length 1 · max length 120
`name`required	string min length 1 · max length 200
`description`optional	string \| null max length 4000 · default null
`durationMinutes`required	integer ≥ 5 · ≤ 1440
`price`required	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000 · default 0
`isActive`optional	boolean default true
`isPublic`optional	boolean default false
`bookingMode`optional	"day_capacity" \| "time_slots" \| null `time_slots`: the customer picks a start time. `day_capacity`: the customer picks a day and the work is planned into it. default null
`slotIntervalMinutes`optional	5 \| 10 \| 15 \| 20 \| 30 \| 60 \| null default null
`minHoursAhead`optional	integer \| null ≥ 0 · ≤ 720 · default null
`maxDaysAhead`optional	integer \| null ≥ 0 · ≤ 730 · default null
`resources`optional	array of object Replaces the resources that can perform the service. Resources of other instances are ignored. at most 200 · default []

ServiceUpdate

Field	Type
`categoryId`optional	string (uuid) An existing category. Give this or `categoryName`.
`categoryName`optional	string A category by name; created if there is none. Give this or `categoryId`. min length 1 · max length 120
`name`optional	string min length 1 · max length 200
`description`optional	string \| null max length 4000
`durationMinutes`optional	integer ≥ 5 · ≤ 1440
`price`optional	number SEK including VAT, at most two decimals. ≥ 0 · ≤ 9999999
`sortOrder`optional	integer Lower comes first. ≥ -100000 · ≤ 100000
`isActive`optional	boolean
`isPublic`optional	boolean Offered on the public booking site.
`bookingMode`optional	"day_capacity" \| "time_slots" \| null `time_slots`: the customer picks a start time. `day_capacity`: the customer picks a day and the work is planned into it.
`slotIntervalMinutes`optional	5 \| 10 \| 15 \| 20 \| 30 \| 60 \| null
`minHoursAhead`optional	integer \| null ≥ 0 · ≤ 720
`maxDaysAhead`optional	integer \| null ≥ 0 · ≤ 730
`resources`optional	array of object Replaces the resources that can perform the service. Resources of other instances are ignored. at most 200

Resource

Field	Type
`id`	string (uuid)
`name`	string
`code`	string \| null Up to five characters; starts the booking reference.
`sortOrder`	integer ≥ -9007199254740991 · ≤ 9007199254740991
`isActive`	boolean

WorkHours

Field	Type
`id`	string (uuid)
`weekday`	integer ISO weekday: 1 Monday … 7 Sunday. ≥ 1 · ≤ 7
`startTime`	string Time of day, HH:MM (24 h).
`endTime`	string Time of day, HH:MM (24 h).
`validFrom`	string (date) \| null First day the hours apply. Null: from the beginning.
`validTo`	string (date) \| null Last day the hours apply. Null: until further notice.

WorkHoursCreate

Field	Type
`weekdays`required	array of integer The same hours on each of these weekdays. at least 1 · at most 7
`startTime`required	string Time of day, HH:MM (24 h).
`endTime`required	string Time of day, HH:MM (24 h).
`validFrom`optional	string (date) \| null A date, YYYY-MM-DD, in the instance's time zone. default null
`validTo`optional	string (date) \| null A date, YYYY-MM-DD, in the instance's time zone. default null

WorkHoursReplace

Field Type

entriesrequired

array of object

The resource's complete work hours. Everything not listed is removed. An empty list removes all.

at most 200

ScheduleException

Field	Type
`id`	string (uuid)
`resourceId`	string (uuid) \| null Null: applies to the whole instance, every resource.
`startDate`	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`endDate`	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`kind`	"closed" \| "custom_hours"
`startTime`	string \| null Time of day, HH:MM (24 h).
`endTime`	string \| null Time of day, HH:MM (24 h).
`note`	string \| null

ScheduleExceptionCreate

Field	Type
`resourceId`optional	string (uuid) \| null Null or left out: the whole instance. default null
`startDate`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`endDate`required	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`kind`required	"closed" \| "custom_hours" `closed`: no work at all. `custom_hours`: only between startTime and endTime.
`startTime`optional	string \| null Required for custom_hours. default null
`endTime`optional	string \| null Required for custom_hours. default null
`note`optional	string \| null max length 200 · default null

Customer

Field	Type
`id`	string (uuid)
`firstName`	string
`lastName`	string \| null
`phone`	string \| null
`email`	string \| null

Booking

Field	Type
`id`	string (uuid)
`reference`	string Shown to the customer, e.g. A1042.
`status`	"confirmed" \| "cancelled"
`day`	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`startsAt`	string (date-time) \| null Null for bookings by the day (day_capacity).
`endsAt`	string (date-time) \| null ISO 8601 with offset.
`service`	object
`addons`	array of object
`durationMinutes`	integer ≥ -9007199254740991 · ≤ 9007199254740991
`price`	number
`resource`	object
`customer`	Customer \| null
`customerNote`	string \| null
`internalNote`	string \| null
`smsOptIn`	boolean
`emailOptIn`	boolean
`source`	"admin" \| "api" \| "public" \| "sync"
`createdAt`	string (date-time) ISO 8601 with offset.
`cancelledAt`	string (date-time) \| null ISO 8601 with offset.
`cancelReason`	string \| null

CustomerCreate

A customer with the same mobile number is reused as it is; otherwise a new customer is created.

Field	Type
`firstName`required	string min length 1 · max length 100
`lastName`optional	string \| null max length 100 · default null
`phone`optional	string \| null Mobile number. Swedish numbers may be given without +46. max length 40 · default null
`email`optional	string (email) \| null max length 320 · default null

BookingCreate

Field	Type
`serviceId`required	string (uuid)
`addonIds`optional	array of string (uuid) at most 20 · default []
`day`optional	string (date) Required for services booked by the day. Ignored for time slots, where the day follows startsAt.
`startsAt`optional	string (date-time) Required for services booked by time slot.
`resourceId`optional	string (uuid) A specific resource. Left out: any free resource that can do the service.
`customerId`optional	string (uuid) An existing customer. Give this or `customer`.
`customer`optional	CustomerCreate
`customerNote`optional	string \| null max length 2000 · default null
`internalNote`optional	string \| null Only visible to staff. max length 2000 · default null
`smsOptIn`optional	boolean Send SMS confirmation and reminder, if the instance sends them. default true
`emailOptIn`optional	boolean Send e-mail confirmation and reminder, if the instance sends them. default true

BookingUpdate

Giving day, startsAt or resourceId moves the booking; the other fields are updated as given.

Field	Type
`day`optional	string (date) A date, YYYY-MM-DD, in the instance's time zone.
`startsAt`optional	string (date-time) ISO 8601 with offset.
`resourceId`optional	string (uuid) \| null Moves the booking to this resource. Null: any free resource. Left out: keeps the current one if it is free.
`customerNote`optional	string \| null max length 2000
`internalNote`optional	string \| null max length 2000
`smsOptIn`optional	boolean
`emailOptIn`optional	boolean

BookingCancel

Field	Type
`reason`optional	string \| null max length 500 · default null

AvailableDay

Field Type

day

string (date)

A date, YYYY-MM-DD, in the instance's time zone.

free

integer

Free start times (time_slots), or free minutes on the best resource (day_capacity).

≥ -9007199254740991 · ≤ 9007199254740991

AvailableSlot

Field	Type
`startsAt`	string (date-time) ISO 8601 with offset.
`resourceId`	string (uuid)

Error

Field	Type
`error`	string Machine-readable code, e.g. `not_found`, `missing_scope`, `no_capacity`.
`detail`	string Human-readable detail, when there is one.