Retrieves the setting with the specified code.

Request Information

URI Parameters :

None.

Body Parameters :

JSON body with a code key.

Collection of Object

None.

Response Information

Resource Description :

IHttpActionResult containing the matching setting, or null if no setting has that code.

settings
NameDescriptionTypeAdditional 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": "6716593e-f811-4ca6-9a00-1c2dec72c200",
  "code": "sample string 2",
  "value": "sample string 3",
  "sales_organization_id": "f15a7be6-f5ef-4aab-9adb-295626e321fe",
  "user_id": "416af126-6f4e-453d-9976-f23d42dc954a",
  "modified_dateutc": "2026-09-16T10:59:50.3441401+00:00"
}

application/xml, text/xml

Sample:
<settings xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <code>sample string 2</code>
  <id>6716593e-f811-4ca6-9a00-1c2dec72c200</id>
  <modified_dateutc>2026-09-16T10:59:50.344Z</modified_dateutc>
  <sales_organization_id>f15a7be6-f5ef-4aab-9adb-295626e321fe</sales_organization_id>
  <user_id>416af126-6f4e-453d-9976-f23d42dc954a</user_id>
  <value>sample string 3</value>
</settings>