Get information about an option

GET /company/options/@id



This endpoint requires authentication.

Header Value
Authorization Set the value to Bearer + + access_token

URL parameters

Replace the @ keywords in the URL with their corresponding value.

A dictionary with fields

Field Type Description
id Int ID of the option you want to return

Example request 1 Retrieve options

GET /company/options/1601 HTTP/1.1
Authorization: Bearer c94469467f905b85d2e6f3c1ba21ee9ba323433712f7af7486e0cdd26135fb0efbcd71ff4ffc258375f588b332f3627d93ee2bda7dae9e357efd21b487287691ae596785aeee21931ab3f29b196ba9bcbf6b22c0043eb3d580d42edb36e2fc4d2270cab2
X-VERSION: 1.5.0
Accept-Language: en-US,en;q=0.5


Field Type Description
name [Language: String] Name of the option
price_change Int Price change in cents. Positive for price increase, negative for discounts.
id Int ID of this option
code String? Nullable. Your own ID or key that you can associate with an option
order Int The options of a option set are sorted on the order property (descending). If you specify the same order for multiple option sets, the id of the option set is used. Setting the same order for all option sets is discouraged.

Example response 1 Retrieve options

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 119

    "id": 1601,
    "name": {
        "nl": "Yes"
    "price_change": -947,
    "code": null,
    "order": 3
1.5.0 stable