Custom profile fields

Get a custom profile field by name

Get a custom profile field by name.

get/api/custom-profile-fields/{name}

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/custom-profile-fields/{name}
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

namestring required

Response

Custom profile field found successfully.

tenantIdstring required
idstring required
namestring required
type'Text' | 'Number' | 'Date' | 'Checkbox' | 'Select' | 'Url' | 'Regex' | 'Address' | 'Fullname' required
labelstring required
descriptionstring nullable required
requiredboolean required
createdAtnumber required
sieOrdernumber required

Changes

No recorded changes to this operation across all 8 revisions of this API.