Retrieve a sign-up custom field
GET
Retrieves detailed information for the specified sign-up custom field.
API-Keyheader
X-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
claim_name*string
The unique claim name identifying the custom field.
Response Body
200
application/json
The custom field was retrieved successfully
TypeScript Definitions
Use the response body type in TypeScript.
Sign-up Custom Field Response: Represents the configuration of a custom field collected during user sign-up.
Errors
401Unauthorized
403Forbidden
curl -X GET "https://your-domain.us.monocloud.com/api/options/authentication/signup/custom_fields/first_name" \ -H "X-API-KEY: <token>"{ "enabled": true, "required": true, "claim_name": "string", "value_type": "string", "label": "string"}