GET Engagement Extension Fields

Retrieves extension fields (user-defined fields) for a specific engagement.

Endpoint

Endpoint

/api/engagements/{entityId}/extensionFields

Method

GET

Scope

riskassess.engagement.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

entityId

Engagement entityId (GUID). Must not be an empty GUID.
Table 2. Query parameters
Parameter Required Description

limit

No

Maximum number of items to return. Default: 50.

offset

No

Number of items to skip from start. Default: 0.

name

No

Filter by extension field name. Supports [contains] and [eq] operators.
Tip: Example filter: /api/engagements/{entityId}/extensionFields?name[contains]=udf

Elements

The following elements are available in the response:

Element Data Type Available Options Description

success

boolean

Whether the request was successful.

totalCount

integer

Total number of extension fields that match the filter criteria across all pages.

Note:

Use the limit and offset query parameters to retrieve additional sets of data if totalCount exceeds the page size.

result

array

Array of objects containing engagement extension field data.

errors

array

List of error objects. Typically empty when the request is successful.

entityId

string (GUID)

Unique identifier for the engagement.

engagementName

string

Name of the engagement associated with the extension fields.

extensionFields

array

Array of user-defined field objects containing name and value pairs.

name

string

Name of the extension field (e.g., "udf_contract_type").

value

string

Value of the extension field stored as a string regardless of underlying data type.

Get engagement extension fields

Endpoint

GET /api/engagements/{entityId}/extensionFields

Example cURL request
curl --location 'https://<your-instance>.risk.com/api/engagements/3a2edf76-ca80-46cc-bddd-761ecbbdd658/extensionFields' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ••••••'
Example response
{
  "success": true,
  "totalCount": 5,
  "result": [
    {
      "entityId": "3a2edf76-ca80-46cc-bddd-761ecbbdd658",
      "engagementName": "Supplier Onboarding Engagement",
      "extensionFields": [
        {
          "name": "udf_contract_type",
          "value": "Master Service Agreement"
        },
        {
          "name": "udf_priority",
          "value": "High"
        },
        {
          "name": "udf_budget_code",
          "value": "BU-IT-2026-Q1"
        }
      ]
    }
  ],
  "errors": []
}
Example error response
{
  "success": false,
  "result": null,
  "errors": [
    {
      "message": "Engagement not found",
      "errorCode": "DataNotFound"
    }
  ]
}