Get User Data

POST

/v1/users/info

Return one community member without leaking whether the same identity exists elsewhere. A missing user and a user outside the API key's community both return the same 404 USER_NOT_FOUND response.

Use the successful read as the readback step after Create User or Update User Data. Never probe broader identifiers after a privacy-safe 404.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

User data retrieved successfully. Branch on the HTTP status and meta.code; do not branch on the human-readable message.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409Server Error

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

byEmailbyUserId

curl --location 'https://sgtr-integration.returning.ai/apis/v1/users/info' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idOrEmail": "user@example.com",
    "customFields": [
        "customerid"
    ]
}'

Response Example

200 - Success Example

{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "code": "USER_DATA_RETRIEVED"
    },
    "message": "User data retrieved successfully.",
    "data": {
        "userId": "3247779",
        "username": "ada_lovelace_123",
        "email": "ada@example.com",
        "roles": [
            "@all"
        ],
        "customFields": {
            "customerid": "broker-user-123"
        }
    }
}

Modified at 2026-07-20 18:50:42

Create New User

Manage User Account