Get Specific User Field

What it is for: Get Specific User Field. Use this to define and maintain custom user fields used for broker segmentation, eligibility, reporting, and integration payloads.

How to use it: Send a GET request to /v1/communities/{communityId}/user-fields/{fieldIdOrName}. Authorization: Bearer <apiKey> or an admin bearer token, depending on the owning API surface. The key must be scoped to the community and have user-field access.

Successful response: HTTP 200. The body follows the endpoint schema; many integration endpoints wrap the useful payload under data with status and message.

Common error states:

400 invalid request body, query, ObjectId, pagination, file format, or missing required field.

401 missing, invalid, expired, or insufficient API key/token.

403 key is valid but cannot access this community/channel/user/resource, where supported by the service.

404 target resource, route, or community-scoped record was not found.

409 duplicate or conflicting state for create/update operations, where applicable.

500 unexpected Returning.AI service error.

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

Request

Responses