Skip to content
Keptslot
Start free

List services

GET
/v1/services
 
curl --request GET \
  --url https://api.keptslot.com/v1/services \
  --header 'Authorization: Bearer <token>'

This endpoint lists every service of the workspace, active and inactive. Read active to tell them apart.

Authorizations

Section titled “ Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The services of the workspace.

Media type application/json
object
data
required
Array<object>

The full service, with the rules that drive availability. The Service schema is the smaller customer-facing view of the same row.

object
id
required
string format: uuid
name
required
string
duration_minutes
required
integer
buffer_before_minutes
required

Free time held before the appointment.

integer
buffer_after_minutes
required

Free time held after the appointment.

integer
min_lead_minutes
required

How far ahead a customer must book.

integer
max_advance_days
required

How far ahead a customer can book. If you send 0 on a write, the API stores 60.

integer
min_cancel_notice_minutes
required

How long before the start time cancellation closes. It binds customers only. A secret key cancels at any time. A value of 0 keeps cancellation open until the start time.

integer
active
required
boolean
price_cents
integer | null
description
string | null
payment_mode
string
deposit_amount_cents
integer | null
deposit_percent
integer | null
Example generated 
{
  "data": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "name": "example",
      "duration_minutes": 1,
      "buffer_before_minutes": 1,
      "buffer_after_minutes": 1,
      "min_lead_minutes": 1,
      "max_advance_days": 1,
      "min_cancel_notice_minutes": 1,
      "active": true,
      "price_cents": 1,
      "description": "example",
      "payment_mode": "example",
      "deposit_amount_cents": 1,
      "deposit_percent": 1
    }
  ]
}

401

Section titled “ 401 ”

The key is missing, malformed or revoked.

Media type application/json
object
error
required
object
type
required

A stable machine-readable code. Match on this.

string
message
required

A sentence for a person. Do not match on this.

string
param

The field that caused the refusal, if one field did.

string
dimension

The plan limit that refused the request. It is present only on a 402, and only for a secret key or an account key. See the errors guide.

string
used

The current count for that dimension. It is present only on a 402, and only for an account key. It is absent when the refusal has no count to report. Absent and zero are different answers.

integer format: int64
limit

The cap for that dimension. It is present only on a 402, and only for an account key. A cap of zero is a real value.

integer format: int64
Example generated 
{
  "error": {
    "type": "example",
    "message": "example",
    "param": "example",
    "dimension": "example",
    "used": 1,
    "limit": 1
  }
}