Get specific user field

GET

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

Retrieve detailed information about a specific user field within a community by its field ID or field name.

Security Requirements:

Bearer token authentication required

Only community members can access this endpoint

User must have COMMUNITY_MEMBER permission for the specified community

Community API key with userFields permission can also be used

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://application.returning.ai/apis/v1/communities/507f1f77bcf86cd799439011/user-fields/507f1f77bcf86cd799439012'

Responses

🟢200OK

application/json

Get specific user field successful

Body

Example

{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Get specific user field",
    "data": {
        "_id": "507f1f77bcf86cd799439011",
        "field": "custom_field_1",
        "name": "Custom Field 1",
        "type": "string",
        "creator": {
            "_id": "507f1f77bcf86cd799439011",
            "id": 123456789012345680,
            "avatar": "https://cdn.discordapp.com/avatars/123456789012345678/avatar.png",
            "displayName": "John Doe",
            "username": "johndoe"
        },
        "isCustom": true,
        "createdAt": "2023-01-01T12:00:00.000Z",
        "updatedAt": "2023-01-01T12:00:00.000Z"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Modified at 2025-08-28 10:34:32

Get all user fields for a community

Create user field