v1
latestOpenAPI 3.0.12026-07-243124341009.5 KBGet Config Choice by Category
Returns a predefined list of custom setup options from the ConfigChoice table in Back Office.
Path parameters
The category value used to retrieve Config Choice records.
Query parameters
The unique identifier for the Branch record, sometimes known as a Staffing Supplier Site.
The external ID of the Branch entity, used as an alternative to the BranchGuid query parameter. When provided with a valid ExternalIdSource header, it overrides the lookup of the Branch entity record. If a matching record is not found, an ExternalEntityNotFound error is returned. If a match is found, the response includes a BranchGuid header containing the classic entity record ID.
Headers
An integer identifier for the tenant that the request is being made for.
The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.
The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.
The string source name (such as application or function name) that indicates the origin of the request.
The external ID source that determines which external reference source is used to perform an external ID lookup.
The identifier of the Avionté BOLD user on whose behalf the request is performed. Used to establish the user context for auditing, permission checks, and user-attributed actions. This value must correspond to a valid, active Avionté Back Office user. If the identifier cannot be resolved, the request is rejected.
Response
Successfully retrieved custom setup options by category.