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 /communities/{communityId}/user-fields/{fieldId}. 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", "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" } }

Request

Responses