Skip to content

Ramp: List custom roles — response body — data item

List custom roles: response body, field data / item. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: List custom roles — response body — data item

FieldTypePresenceDescription and constraints
$objectRoot
base_rolestringRequired within parentSystem role this custom role is based on.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the custom role.
description (anyOf 2)nullAlternative
idstringRequired within parentUnique identifier of the custom role.
Format: uuid
namestringRequired within parentDisplay name of the custom role.
product_capabilitiesarrayRequired within parentProduct capabilities enabled for the custom role.
product_capabilities[]ModelEach itemExpand List custom roles — response body — data item product capabilities item

Referenced models: List custom roles — response body — data item product capabilities item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.