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
    • tenantId string Required

      Maximum length is 21.

    • id string Required

      Minimum length is 1, maximum length is 21.

    • name string Required

      Minimum length is 1, maximum length is 128.

    • type string Required

      Values are Text, Number, Date, Checkbox, Select, Url, Regex, Address, or Fullname.

    • label string Required

      Maximum length is 128.

    • description string | null Required

      Maximum length is 256.

    • required boolean Required
    • config object Required
      Hide config attributes Show config attributes object
      • placeholder string

        Maximum length is 256.

      • minLength number
      • maxLength number
      • minValue number
      • maxValue number
      • format string

        Maximum length is 128.

      • options array[object]
        Hide options attributes Show options attributes object
        • label string Required
        • value string Required
      • parts array[object]
        Hide parts attributes Show parts attributes object
        • key string Required
        • enabled boolean Required
    • createdAt number Required
    • sieOrder number Required
  • 401

    Unauthorized

  • 403

    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
  }
]