Skip to navigation

Get Request Availability

View as Markdown

Lists the days a form with a daily limit cannot take another order, so a date picker can grey them out. The window starts today, or at from if later, and runs for 90 days, or to to, capped at 120 days.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired

Query parameters

form_idstringRequiredformat: "uuid"

The form’s id, from Get Request Form or a product’s request_form.

fromdateOptional
First day to check. Defaults to today.
todateOptional

Last day to check. Defaults to 90 days after from.

Response

Successfully fetched availability
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error