Get A User Field Definition
GET
/v1/communities/{communityId}/user-fields/{fieldIdOrName}
What this endpoint does
INFO
Quick start
_id.Authentication and permission
APIKeyModel key with userFields. The caller must belong to the target community. Authentication and community isolation complete before the definition is returned.Complete examples
{
"meta": { "status": "success", "statusCode": 200, "code": "USER_FIELD_RETRIEVED" },
"message": "Read user field api success.",
"data": {
"_id": "<fieldObjectId>",
"name": "Trading Volume",
"field": "trading_volume",
"type": "numerical",
"defaultValue": 0,
"isCustom": true
}
}Success and readback
data.name, data.type, and data.defaultValue with the preceding create/update request. Store data.field as the durable key. data.isCustom tells management clients whether update/delete is eligible; built-in definitions are protected.CHECK
Errors and recovery
400 INVALID_COMMUNITY_ID or INVALID_FIELD_IDENTIFIER: correct the path parameter.401 AUTHENTICATION_REQUIRED: use a recognized community API key.403 API_KEY_PERMISSION_DENIED or COMMUNITY_ACCESS_DENIED: fix permission/community membership.404 COMMUNITY_NOT_FOUND: the community is unavailable.404 USER_FIELD_NOT_FOUND: no definition matches the key/ObjectId. Re-list fields before deciding to create.500 USER_FIELD_OPERATION_FAILED: retry this read with bounded backoff.Retry safety
TIP
Gotchas
Next steps
Request
Path Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.returning.ai/v1/communities/6502c9e514a3e564c5c09c0a/user-fields/trading_volume' \
--header 'Authorization: Bearer <apiKey>'Response Response Example
200 - Success Example
{
"meta": {
"status": "success",
"statusCode": 200,
"code": "USER_FIELD_RETRIEVED"
},
"message": "Read user field api success.",
"data": {
"_id": "66f000000000000000000010",
"name": "Trading Volume",
"field": "trading_volume",
"type": "numerical",
"defaultValue": 0,
"isCustom": true
}
}Modified at 2026-07-27 16:00:46