Get specific user field

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

communityId

string

required

The unique identifier of the community

Example:

507f1f77bcf86cd799439011

Match pattern:

^[0-9a-fA-F]{24}$

fieldId

string

required

The unique identifier of the user field

Example:

507f1f77bcf86cd799439012

Match pattern:

^[0-9a-fA-F]{24}$

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

Responses

🟢200OK

application/json

Get specific user field successful

Body

meta

object

optional

status

string

optional

statusCode

number

optional

message

string

optional

Success message for the operation

data

object

optional

_id

string

optional

Field's unique identifier

field

string

optional

Field identifier

name

string

optional

Human-readable field name

type

string

optional

Field data type

creator

object | null

optional

User who created this field

isCustom

boolean

optional

Whether this is a custom field

createdAt

string <date-time>

optional

Field creation timestamp

updatedAt

string <date-time>

optional

Field last update timestamp

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