Get all user fields for a community

What it is for: Get all user fields for a community. 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. 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, "totalItemsCount": 1 }, "message": "Get user fields success.", "data": [ { "_id": "6857de260f3c24d98fd7ca85", "field": "total", "name": "Total", "type": "numerical", "creator": { "_id": "61100af5c548eb5c7ebc7819", "id": 1, "avatar": "https://returning-ai.com/avatar.png", "displayName": "Admin", "username": "admin" }, "isCustom": true, "createdAt": "2025-06-22T11:28:50.301Z", "updatedAt": "2025-06-22T11:28:50.301Z" } ] }

Get all user fields for a community

Request

Responses