Sign inSign up

Get user public data

GET
/api/users/[user_id]/public_data
Returns the public data associated with the specified user. This data is typically non-sensitive and may be user-editable.

Path Parameters

user_id
string
Required

The ID of the user whose public data should be retrieved.

Authentication

X-API-KEY
header
Required

The API key is essential for accessing MonoCloud's APIs. You can find it in the Tenant Settings section of your MonoCloud dashboard. To authenticate your requests, include this key in the request header using the following format: X-API-Key: <Your_API_Key>.

Headers

accept
string
  • application/json
  • application/problem+json

Responses

200
Successfully retrieved user's public data
422
Client Error
404
Not Found
401
Unauthorized
403
Forbidden

Request Example

Request
curl -X GET "https://<your-domain>/api/users/{user_id}/public_data" \
 -H "X-API-KEY: <your-api-key>" \
 -H "Accept: application/json"

Response Example

Response
200 OK
{

  "public_data": {

    "color_preference": {
      "dashboard": "monochrome"

    },
    "send_emails": true,
    "days_to_retain": 1

  }
}