Skip to content
Keptslot
Start free

List questions

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

This endpoint lists the questions of the booking form. Active questions come first, then archived ones. Read active to tell them apart.

Authorizations

Section titled “ Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

The questions of the workspace.

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

A question on the booking form, as the workspace manages it. The Question schema is the customer’s view of the same row, and has no active.

object
id
required
string format: uuid
label
required
string
help_text
required
string | null
type
required
string
Allowed values: short_text long_text single_select
options
required

Empty unless type is single_select.

Array<string>
required
required
boolean
applies_to
required
string
Allowed values: all_services selected_services
service_ids
required

The services set with PUT /v1/questions/{id}/services. GET /v1/questions and that endpoint return them. Create, replace, archive and restore always return [] here, whatever the services are.

Array<string>
position
required

Active questions list first, then archived ones; within each, by this value, lowest first.

integer
active
required

False when the question is archived. An archived question is not on the booking form.

boolean
Example 
{
  "data": [
    {
      "type": "short_text",
      "applies_to": "all_services"
    }
  ]
}

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
  }
}

403

Section titled “ 403 ”

This is a server route and you sent a publishable key. Send a secret key from your server. The type field is secret_key_required.

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
  }
}

500

Section titled “ 500 ”

A fault on our side. Do not retry the same request in a loop. The type field is internal_error.

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
  }
}