---
updatedAt: 2026-07-27T05:35:29.000Z
agentTools:
  projectIndex: https://developer.xentral.com/llms.txt
---

# View sales order traffic light configuration V3

This endpoint requires the following scopes: `salesOrder:read`.

View sales order traffic light configuration.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Xentral Business Documents API v3",
    "description": "The Xentral Business Documents API v3 for working with sales orders, offers, invoices, credit notes, delivery notes, return orders, purchase orders, proforma invoices and productions.\n\nIndividual endpoints marked as *Beta* may still change without prior notice — see the respective endpoint descriptions.\n\nRequest payloads may contain properties that an endpoint does not define; these are ignored rather than rejected. Nothing is stored for them and no error is returned, so check the response body to confirm which values were actually applied.",
    "contact": {
      "name": "API Support",
      "url": "https://xentral.com",
      "email": "api@xentral.com"
    },
    "version": "0.2.0"
  },
  "servers": [
    {
      "url": "https://{xentralId}.xentral.biz",
      "description": "Your xentral instance",
      "variables": {
        "xentralId": {
          "default": "my-company",
          "description": "Your Xentral instance ID"
        }
      }
    },
    {
      "url": "https://{domain}",
      "description": "Xentral with a custom domain",
      "variables": {
        "domain": {
          "default": "demo.xentral.com",
          "description": "Your Xentral custom domain"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "SalesOrderTrafficLight": {
        "description": "A traffic light configuration",
        "required": [
          "id",
          "name",
          "type",
          "icon",
          "isActive",
          "values"
        ],
        "properties": {
          "id": {
            "description": "The unique identifier of the traffic light",
            "type": "string",
            "example": "stock"
          },
          "name": {
            "description": "The name/identifier of the traffic light",
            "type": "string",
            "example": "stock"
          },
          "type": {
            "description": "The type of traffic light",
            "type": "string",
            "enum": [
              "system",
              "custom"
            ],
            "example": "system"
          },
          "icon": {
            "description": "The icon identifier for the traffic light",
            "type": "string",
            "example": "foo.svg"
          },
          "isActive": {
            "description": "Whether this traffic light is active/enabled",
            "type": "boolean",
            "example": true
          },
          "values": {
            "description": "Possible values for this traffic light. Boolean traffic lights return [true, false], enum-based traffic lights return string values.",
            "type": "array",
            "items": {
              "oneOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                }
              ]
            },
            "example": [
              true,
              false
            ]
          }
        },
        "type": "object",
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "SalesOrder",
      "description": "SalesOrder"
    }
  ],
  "paths": {
    "/api/v3/salesOrderTrafficLights": {
      "get": {
        "tags": [
          "SalesOrder"
        ],
        "summary": "View sales order traffic light configuration V3",
        "description": "This endpoint requires the following scopes: `salesOrder:read`.\n\nView sales order traffic light configuration.",
        "operationId": "GET::api-v3-salesordertrafficlights",
        "parameters": [
          {
            "name": "perPage",
            "in": "query",
            "description": "Number of items per page. Default: 15, Max: 100. A larger value is reduced to the maximum; omitting it or sending 0 selects the default.",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "example": 15
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "Page number. Omitting it or sending 0 selects the first page.",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 0,
              "example": 1
            }
          }
        ],
        "responses": {
          "200": {
            "description": "View sales order traffic light configuration.",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/SalesOrderTrafficLight"
                      },
                      "x-description-ignore": true,
                      "x-example-ignore": true
                    },
                    "meta": {
                      "description": "Pagination meta data",
                      "properties": {
                        "currentPage": {
                          "description": "The current page number",
                          "type": "integer",
                          "example": 1
                        },
                        "from": {
                          "description": "The first item being returned in the current page",
                          "type": "integer",
                          "example": 1,
                          "nullable": true
                        },
                        "path": {
                          "description": "The base path for the paginated results",
                          "type": "string",
                          "example": "https://api.example.com/items"
                        },
                        "perPage": {
                          "description": "The number of items shown per page",
                          "type": "integer",
                          "example": 15
                        },
                        "to": {
                          "description": "The last item being returned in the current page",
                          "type": "integer",
                          "example": 15,
                          "nullable": true
                        }
                      },
                      "type": "object",
                      "x-example-ignore": true
                    },
                    "links": {
                      "description": "Pagination links",
                      "properties": {
                        "first": {
                          "description": "URL to the first page",
                          "type": "string",
                          "example": "https://api.example.com/items?page=1",
                          "nullable": true
                        },
                        "last": {
                          "description": "URL to the last page",
                          "type": "string",
                          "example": null,
                          "nullable": true
                        },
                        "prev": {
                          "description": "URL to the previous page",
                          "type": "string",
                          "example": null,
                          "nullable": true
                        },
                        "next": {
                          "description": "URL to the next page",
                          "type": "string",
                          "example": "https://api.example.com/items?page=17",
                          "nullable": true
                        }
                      },
                      "type": "object",
                      "x-example-ignore": true
                    }
                  },
                  "type": "object"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "429": {
            "description": "Too Many Requests",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "message": {
                      "description": "Too Many Requests",
                      "type": "string",
                      "example": "Too Many Requests"
                    }
                  },
                  "type": "object"
                }
              }
            }
          }
        },
        "x-scopes": [
          "salesOrder:read"
        ]
      }
    }
  }
}
```