Skip to main content

The Request object

Attributes#

NameDescription
id (string)Unique identifier for the object
slug (string)Unique URL-friendly identifier (generated based on name)
name (string)The request's name
createdAt (string)The request's creation timestamp
author (User)The request's author
recipient (Recipient)The request's recipient
document (Document)The request's attached documents
requestComments (Object)The request's comments
items (RequestItem[]) The requests items

Object payload#

{
"id": "X",
"slug": "my-request",
"name": "My request",
"description": "My request's description",
"status": "ONGOING",
"deadline": "2021-05-25T22:00:00+00:00",
"lastReminderDate": null,
"emailStatus": "UNKNOWN",
"readAt": null,
"createdAt": "2021-05-25T12:26:45+00:00",
"author": {
"firstName": "John",
"lastName": "Doe"
},
"recipient": {
"id": "X",
"firstName": "Tim",
"lastName": "Cook",
"email": "tim@cook.com",
"role": null
},
"documents": [],
"requestComments": {
"edges": []
},
"items": [
{
"name": "Date of birth",
"description": null,
"type": "MESSAGE",
"id": "X",
"document": null,
"answer": {
"message": "12/07/1980",
},
{
"name": "ID card",
"description": null,
"type": "DOCUMENT",
"id": "X",
"document": null,
"answer": {
"documents": [{
"fileName": "ID card.png",
"url": "https://my-url/card.png",
}],
}
},
{
"name": "What colour do you prefer ?",
"description": null,
"type": "PROMPT",
"message": null,
"document": null,
"choices": [
{
"choice": "Blue"
},
{
"choice": "Red"
}
],
"answer": {
"choice": {
"choice": "Blue",
}
}
},
{
"name": "Read receipt",
"description": null,
"type": "ACKNOWLEDGE",
"document": null,
"id": "X",
"message": "I hereby certify that I have read this request",
"answer": {
"acknowledged": true
}
}
]
}