Get all custom profile fields

GET /api/custom-profile-fields

Get all custom profile fields.

Responses

  • 200 application/json

    Custom profile fields ordered by sieOrder (Sign-in Experience order).

    Hide response attributes Show response attributes object
  • Unauthorized

  • Forbidden

GET /api/custom-profile-fields
curl \
 --request GET 'https://[tenant_id].logto.app/api/custom-profile-fields' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
[
  {
    "tenantId": "string",
    "id": "string",
    "name": "string",
    "type": "Text",
    "label": "string",
    "description": "string",
    "required": true,
    "config": {
      "placeholder": "string",
      "minLength": 42.0,
      "maxLength": 42.0,
      "minValue": 42.0,
      "maxValue": 42.0,
      "format": "string",
      "options": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "parts": [
        {
          "key": "string",
          "enabled": true
        }
      ]
    },
    "createdAt": 42.0,
    "sieOrder": 42.0
  }
]