Get all user fields for a community

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

communityId

string

required

The unique identifier of the community

Example:

6167dba9c548eb5c7ec28057

Query Params

isCustom

enum<string>

optional

Filter to show only custom fields when set to true

Allowed values:

truefalse

Default:

false

Example:

true

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

User fields retrieved successfully

Body

meta

object

optional

status

string

optional

statusCode

number

optional

totalItemsCount

number

optional

Total number of items processed

message

string

optional

Success message for the operation

data

array [object {8}]

optional

Array of user fields for the community

_id

string

optional

Unique identifier of the user field

field

string

optional

Field identifier or key name

name

string

optional

Display name of the user field

type

enum<string>

optional

Data type of the user field

Allowed values:

datesingle-line-textnumericalmulti-line-textnumbertextstring

creator

object | null

optional

isCustom

boolean

optional

Indicates whether this is a custom user field or a system field

createdAt

string <date-time>

optional

Timestamp when the user field was created

updatedAt

string <date-time>

optional

Timestamp when the user field was last updated

Example

{
    "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"
        }
    ]
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error