Skip to content
ShaireDevelopers
Get a token

intake

9 endpoints.

Build a form, read its submissions, and file through it as a member — which is the bridge from any other system that has a queue. The public link for a form is minted by an admin in the app.

get/api/intake/forms#

tickets:read
Request
curl https://api.shairelabs.com/api/intake/forms \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · IntakeForm[]

idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
createdBystring · uuid*
namestring*
headingstring*
introstring | null*
confirmationstring | null*
detailsLabelstring | null*
collectSubmitterboolean*
requireSubmitterEmailboolean*
fieldsobject[]*
[item]object
fieldIdstring · uuid*
requiredboolean*
labelstring | null*
helpstring | null*
fieldobject*
idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
namestring*
typestring*
textnumberdateurlselectusercheckbox
optionsobject[]*
[item]object
idstring · uuid*
namestring*
huestring*
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
positionstring*
createdAtstring*
updatedAtstring*
defaultStatusIdstring · uuid | null*
defaultPrioritystring*
nonelowmediumhighurgent
defaultAssigneeIds(string · uuid)[]*
defaultTagIds(string · uuid)[]*
enabledboolean*
closesAtstring | null*
hasPublicLinkboolean*
dailyLimitinteger*
submissionCountinteger*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

post/api/intake/forms#

tickets:write

Body

listIdstring · uuid*
namestring*
min length 1 · max length 120
headingstring*
min length 1 · max length 200
introstring | null
max length 2000 · default null
confirmationstring | null
max length 500 · default null
detailsLabelstring | null
max length 120 · default null
collectSubmitterboolean
default true
requireSubmitterEmailboolean
default false
fieldsobject[]
default []
[item]object
fieldIdstring · uuid*
requiredboolean
default false
labelstring | null
max length 120 · default null
helpstring | null
max length 300 · default null
defaultStatusIdstring · uuid | null
default null
defaultPrioritystring
nonelowmediumhighurgentdefault "none"
defaultAssigneeIds(string · uuid)[]
default []
defaultTagIds(string · uuid)[]
default []
dailyLimitinteger
min 1 · max 10000 · default 200
Request
curl https://api.shairelabs.com/api/intake/forms \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"listId":"00000000-0000-0000-0000-000000000000","name":"example","heading":"example"}'

Response · 201 · IntakeForm

idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
createdBystring · uuid*
namestring*
headingstring*
introstring | null*
confirmationstring | null*
detailsLabelstring | null*
collectSubmitterboolean*
requireSubmitterEmailboolean*
fieldsobject[]*
[item]object
fieldIdstring · uuid*
requiredboolean*
labelstring | null*
helpstring | null*
fieldobject*
idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
namestring*
typestring*
textnumberdateurlselectusercheckbox
optionsobject[]*
[item]object
idstring · uuid*
namestring*
huestring*
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
positionstring*
createdAtstring*
updatedAtstring*
defaultStatusIdstring · uuid | null*
defaultPrioritystring*
nonelowmediumhighurgent
defaultAssigneeIds(string · uuid)[]*
defaultTagIds(string · uuid)[]*
enabledboolean*
closesAtstring | null*
hasPublicLinkboolean*
dailyLimitinteger*
submissionCountinteger*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

get/api/intake/forms/{id}#

tickets:read

Path

idstring*
Request
curl https://api.shairelabs.com/api/intake/forms/$FORM_ID \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · IntakeForm

idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
createdBystring · uuid*
namestring*
headingstring*
introstring | null*
confirmationstring | null*
detailsLabelstring | null*
collectSubmitterboolean*
requireSubmitterEmailboolean*
fieldsobject[]*
[item]object
fieldIdstring · uuid*
requiredboolean*
labelstring | null*
helpstring | null*
fieldobject*
idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
namestring*
typestring*
textnumberdateurlselectusercheckbox
optionsobject[]*
[item]object
idstring · uuid*
namestring*
huestring*
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
positionstring*
createdAtstring*
updatedAtstring*
defaultStatusIdstring · uuid | null*
defaultPrioritystring*
nonelowmediumhighurgent
defaultAssigneeIds(string · uuid)[]*
defaultTagIds(string · uuid)[]*
enabledboolean*
closesAtstring | null*
hasPublicLinkboolean*
dailyLimitinteger*
submissionCountinteger*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

patch/api/intake/forms/{id}#

tickets:write

Path

idstring*

Body

namestring
min length 1 · max length 120
headingstring
min length 1 · max length 200
introstring | null
max length 2000
confirmationstring | null
max length 500
detailsLabelstring | null
max length 120
collectSubmitterboolean
requireSubmitterEmailboolean
fieldsobject[]
[item]object
fieldIdstring · uuid*
requiredboolean
default false
labelstring | null
max length 120 · default null
helpstring | null
max length 300 · default null
defaultStatusIdstring · uuid | null
defaultPrioritystring
nonelowmediumhighurgent
defaultAssigneeIds(string · uuid)[]
defaultTagIds(string · uuid)[]
enabledboolean
closesAtstring · date-time | null
dailyLimitinteger
min 1 · max 10000
Request
curl https://api.shairelabs.com/api/intake/forms/$FORM_ID \
  -X PATCH \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · IntakeForm

idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
createdBystring · uuid*
namestring*
headingstring*
introstring | null*
confirmationstring | null*
detailsLabelstring | null*
collectSubmitterboolean*
requireSubmitterEmailboolean*
fieldsobject[]*
[item]object
fieldIdstring · uuid*
requiredboolean*
labelstring | null*
helpstring | null*
fieldobject*
idstring · uuid*
workspaceIdstring · uuid*
listIdstring · uuid*
namestring*
typestring*
textnumberdateurlselectusercheckbox
optionsobject[]*
[item]object
idstring · uuid*
namestring*
huestring*
redorangeamberlimegreentealcyanblueindigovioletfuchsiapinkbrownolivemauvezinc
positionstring*
createdAtstring*
updatedAtstring*
defaultStatusIdstring · uuid | null*
defaultPrioritystring*
nonelowmediumhighurgent
defaultAssigneeIds(string · uuid)[]*
defaultTagIds(string · uuid)[]*
enabledboolean*
closesAtstring | null*
hasPublicLinkboolean*
dailyLimitinteger*
submissionCountinteger*
createdAtstring*
updatedAtstring*

Also answers 401 and 403. SeeErrors.

delete/api/intake/forms/{id}#

tickets:write

Path

idstring*
Request
curl https://api.shairelabs.com/api/intake/forms/$FORM_ID \
  -X DELETE \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 204

Also answers 401 and 403. SeeErrors.

get/api/intake/forms/{id}/submissions#

tickets:read

Path

idstring*
Request
curl https://api.shairelabs.com/api/intake/forms/$FORM_ID/submissions \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · IntakeSubmission[]

idstring · uuid*
formIdstring · uuid*
formNamestring*
ticketIdstring · uuid*
submittedBystring · uuid | null*
submitterNamestring | null*
submitterEmailstring | null*
createdAtstring*

Also answers 401 and 403. SeeErrors.

post/api/intake/forms/{id}/submit#

tickets:write

Path

idstring*

Body

titlestring*
min length 1 · max length 500
detailsstring | null
max length 5000 · default null
valuesobject
default {}
[key: string]unknown
submitterNamestring | null
max length 120 · default null
submitterEmailstring · email | null
max length 320 · default null
websitestring
max length 200
Request
curl https://api.shairelabs.com/api/intake/forms/$FORM_ID/submit \
  -X POST \
  -H "Authorization: Bearer $SHAIRE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"example"}'

Response · 201 · MemberSubmitResponse

ticketIdstring · uuid*
keystring*

Also answers 401 and 403. SeeErrors.

get/api/intake/submissions#

tickets:read

Query

ticketIdstring · uuid*
Request
curl https://api.shairelabs.com/api/intake/submissions?ticketId=00000000-0000-0000-0000-000000000000 \
  -H "Authorization: Bearer $SHAIRE_TOKEN"

Response · 200 · IntakeSubmission | null

Also answers 401 and 403. SeeErrors.