Get Specific User Field

GET

/apis/v1/communities/{communityId}/user-fields/{fieldIdOrName}

This endpoint retrieve detailed information about a specific user field within a community by its field ID or field name.

Authorization

Bearer token Required
Found in the platform under community settings > API keys.
Permission: User Fields

Community ID

Community ID is needed in the path.
Found in the platform under community settings > Apperance.

Field ID or name

The unique identifier (ObjectId) or name (string) of the custom user field to update. There are 2 methods to get the field ID or name

Via API
Use the Get All User Fields endpoint to retrive all fields, use the _id or field in the response.

Via community settings
In the community settings > User Fields, the Field name and Field ID can be found in each field column.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Responses

🟢200OK

application/json

Get specific user field successful

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/apis/v1/communities//user-fields/' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Get specific user field success.",
    "data": {
        "_id": "68ba4a4f8957d9f71aa6",
        "name": "Revenue",
        "field": "revenue",
        "type": "numerical",
        "creator": {
            "_id": "661f084eb50c1e6b74e",
            "id": 1243,
            "avatar": "https://chartsnapshot-genesiv.s3.amazonaws.com/cbbd94f3406.jpeg",
            "displayName": "John Doe",
            "username": "johndoe"
        },
        "isCustom": true,
        "createdAt": "2025-09-05T02:26:23.561Z",
        "updatedAt": "2025-09-05T02:26:23.561Z"
    }
}

Modified at 2026-03-24 09:39:51

Get All User Fields

Create Custom User Field

Get Specific User Field

Authorization#

Community ID#

Field ID or name#

Request

Responses

Authorization

Community ID

Field ID or name