Skip to main content
GET
/
v1
/
quarantines
/
check
Check whether a respondent is currently quarantined
curl --request GET \
  --url https://clientapi.woku.app/v1/quarantines/check \
  --header 'Authorization: Bearer <token>'
{
  "quarantined": true,
  "remainingMinutes": 42,
  "quarantineId": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://woku.app/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.

Query Parameters

​
email
string<email>

Respondent email (provide email or phone).

​
phone
string

Respondent phone (provide email or phone).

Response

Quarantine status

​
quarantined
boolean
required

True if the respondent cannot submit again yet.

​
remainingMinutes
integer

Minutes until the respondent can submit again (only when quarantined).

Example:

42

​
quarantineId
string

Id of the matched quarantine rule (only when quarantined).

Pattern: ^[0-9a-fA-F]{24}$