Skip to main content
GET
/
users
/
{user_id}
/
custom-attributes
Get extended custom attributes for user
curl --request GET \
  --url http://localhost:3001/portal-api/users/{user_id}/custom-attributes \
  --header 'Authorization: <api-key>'
[
  {
    "Value": "true",
    "ID": 1,
    "CustomAttribute": {
      "Name": "Terms of use",
      "Identifier": "terms-of-use",
      "Type": "Boolean",
      "Behaviour": "Edit and view",
      "AddToKeyMetadata": true,
      "Required": true,
      "ShowOnSignUp": true,
      "WriteOnceReadMany": true
    }
  }
]

Authorizations

​
Authorization
string
header
required

Path Parameters

​
user_id
integer
required

UID of user

Example:

1

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
Value
string

custom attribute value

Example:

"true"

​
ID
integer

UID of this user custom attribute

Example:

1

​
CustomAttribute
object