GET Setup Data

Retrieve setup data codes by type for the tenant.

Endpoint

Endpoint

/api/administration/setupdata/{type}

Method

GET

Scope

riskassess.administration.read

Headers

Header Argument

Authorization

Bearer token

Accept

application/json or application/xml

X-Correlation-Id

(Optional) Request tracing ID

Parameters

Table 1. Path parameters
Parameter Description

type

Setup type code segment (for example Classification, Category, SubCategory). Empty or whitespace returns success: false with InvalidRequest.
Table 2. Query parameters
Parameter Required Description

limit

No

Page size. Default: 50.

offset

No

Rows to skip. Default: 0.

order_by

No

(Optional) Sort column when supported by the setup-data filter/sort pipeline.

dir

No

Sort direction when order_by is used. Default: Asc.

includeDeleted

No

Include soft-deleted setup rows when true. Default: false.
Table 3. Filterable fields
API filter field Description

setupCode

Data code on the row.

status

Status filter.

scoreValue

Numeric score.

parentCode

Parent data code (for example subcategory under category).

activeDate

Active date filter.

code

Type / code dimension (maps to TypeCode in filter model).

Get setup data

Endpoint

GET /api/administration/setupdata/{type}

Example cURL request
curl --location 'https://<your-instance>.risk.com/api/administration/setupdata/Category?limit=10&offset=0&dir=Asc' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'
Example response
{
    "success": true,
    "result": {
        "totalCount": 2,
        "setupDataCodes": [
            {
                "code": "Category",
                "setupCode": "Cat1",
                "status": "Active",
                "scoreValue": 0.0,
                "parentCode": null,
                "activeDate": "2025-01-01T00:00:00Z",
                "displayName": "Category One"
            },
            {
                "code": "Category",
                "setupCode": "Cat2",
                "status": "Active",
                "scoreValue": 0.0,
                "parentCode": null,
                "activeDate": "2025-01-01T00:00:00Z",
                "displayName": "Category Two"
            }
        ]
    },
    "errors": []
}
Example error response
{
    "success": false,
    "result": null,
    "errors": [
        {
            "message": "The 'type' parameter is required",
            "errorCode": "InvalidRequest"
        }
    ]
}