Retrieves the setting with the specified code.
Request Information
URI Parameters :
None.
Body Parameters :
JSON body with a code key.
Collection of ObjectNone.
Response Information
Resource Description :
IHttpActionResult containing the matching setting, or null if no setting has that code.
settings| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier | |
| code |
Key/name identifying which setting this record holds the value for. |
string | |
| value |
Value of the setting identified by , stored as text. |
string | |
| sales_organization_id |
Foreign key of the sales organization this setting applies to. |
globally unique identifier | |
| user_id |
Foreign key of the user this setting applies to, when scoped to an individual user rather than the whole organization. |
globally unique identifier | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Response Formats
application/json, text/json
Sample:
{
"id": "0be0f00f-2265-4f3b-800d-50d4579d0507",
"code": "sample string 2",
"value": "sample string 3",
"sales_organization_id": "d838d1f3-c7e7-4f61-b561-d5480833b987",
"user_id": "f22b502b-c9a6-40cc-819d-cbe0e17d22e6",
"modified_dateutc": "2026-11-12T14:27:10.0086902+00:00"
}
application/xml, text/xml
Sample:
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <code>sample string 2</code> <id>0be0f00f-2265-4f3b-800d-50d4579d0507</id> <modified_dateutc>2026-11-12T14:27:10.008Z</modified_dateutc> <sales_organization_id>d838d1f3-c7e7-4f61-b561-d5480833b987</sales_organization_id> <user_id>f22b502b-c9a6-40cc-819d-cbe0e17d22e6</user_id> <value>sample string 3</value> </settings>