Retrieves all user fields associated with a specific community.Authorization#
Bearer token Required
Found in the platform under community settings > API keys.
Permission: User FieldsCommunity ID is needed in the path.Found in the platform under community settings > Apperance.Custom fields#
To retrive custom fields, include "isCustom": true in the query parems. Request
Provide your bearer token in the Authorization
header when making requests to protected resources. Example:Authorization: Bearer ********************
Request Code Samples
curl --location --request GET 'https://application.returning.ai/apis/v1/communities//user-fields?isCustom' \
--header 'Authorization: Bearer <token>'
Responses
application/json
User fields retrieved successfully
{
"meta": {
"status": "success",
"statusCode": 200,
"totalItemsCount": 1
},
"message": "Get user fields success.",
"data": [
{
"_id": "6857de260f3c24d98fd7ca85",
"field": "total",
"name": "Total",
"type": "numerical",
"creator": {
"_id": "61100af5c548eb5c7ebc7819",
"id": 1,
"avatar": "https://returning-ai.com/avatar.png",
"displayName": "Admin",
"username": "admin"
},
"isCustom": true,
"createdAt": "2025-06-22T11:28:50.301Z",
"updatedAt": "2025-06-22T11:28:50.301Z"
}
]
}
Modified at 2025-09-10 09:58:56
