List Inbox Custom Fields
Request
GET /v2/mailboxes/1/fields HTTP/1.1
Authorization: Bearer oauth_token
Path Parameters
/v2/mailboxes/{mailboxId}/fields
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json
{
"_embedded" : {
"fields" : [ {
"id" : 104,
"required" : false,
"order" : 1,
"type" : "dropdown",
"name" : "Beers",
"options" : [ {
"id" : 168,
"order" : 1,
"label" : "IPA"
}, {
"id" : 170,
"order" : 2,
"label" : "Stout"
} ]
} ]
},
"_links" : {
"self" : {
"href" : "..."
},
"first" : {
"href" : "..."
},
"last" : {
"href" : "..."
},
"page" : {
"href" : "...",
"templated" : true
}
},
"page" : {
"size" : 50,
"totalElements" : 1,
"totalPages" : 1,
"number" : 1
}
}
Response fields
Path | Type | Description |
---|---|---|
_embedded.fields |
Array |
List of Custom Fields |
Response fields
Path | Type | Description |
---|---|---|
id |
Number |
Unique identifier |
required |
Boolean |
Specifies if the custom fields has to be set |
order |
Number |
Order when displayed in the Help Scout application |
type |
String |
Type of the custom field |
name |
String |
Name of the custom field, as seen in the Help Scout application |
Response fields
Path | Type | Description |
---|---|---|
[].id |
Number |
Unique identifier |
[].order |
Number |
Order when displayed in the Help Scout application |
[].label |
String |
Name of the dropdown option, as seen in the Help Scout application |