---
updatedAt: 2026-04-20T19:28:31.000Z
---

# Get a specific field

Returns information about a field.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Flows",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://{hostname}"
    }
  ],
  "paths": {
    "/config/{app_id}/flows/{flow}/fields/{field}": {
      "get": {
        "operationId": "get-field",
        "summary": "Get a specific field",
        "description": "Returns information about a field.",
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "example": [
                  {
                    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/signInEmailAddress",
                    "name": "signInEmailAddress"
                  },
                  {
                    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/currentPassword",
                    "name": "currentPassword"
                  }
                ],
                "schema": {
                  "type": "object",
                  "description": "Creates a field. A field essentially represents a user profile attribute. For example, a flow might have fields for such items as a user's first name, a user's address, and a user's phone number.\n",
                  "properties": {
                    "forms": {
                      "type": "string",
                      "description": "Name and configuration URL for all the forms that use the field.\n"
                    },
                    "_self": {
                      "type": "string",
                      "description": "Configuration URL for the field.\n"
                    },
                    "type": {
                      "type": "string",
                      "enum": [
                        "text",
                        "email",
                        "password",
                        "checkbox",
                        "radio",
                        "select",
                        "textarea",
                        "dateselect",
                        "readonly",
                        "hidden",
                        "multiIdentifierAuth"
                      ],
                      "description": "Type of field. Note that, after a field has been created, the field type can’t be changed.\n"
                    },
                    "name": {
                      "type": "string",
                      "description": "Unique name (within a flow) assigned to the field.\n"
                    },
                    "schemaAttribute": {
                      "type": "string",
                      "description": "User profile attribute associated with a field. For example, a field named `firstName` might be associated with the `givenName` attribute.\n"
                    },
                    "label": {
                      "type": "string",
                      "description": "Optional field label used when the field appears on an Identity Cloud screen. Labels need to reference a translation identifier.\n"
                    },
                    "tip": {
                      "type": "string",
                      "description": "Optional tooltip used when the field appears on an Identity Cloud screen. Tooltips need to reference a translation identifier.\n"
                    },
                    "socialProfileData": {
                      "type": "string",
                      "description": "Specifies the data returned from a social identity login that Identity Cloud can use to populate the value of this field. For example, the syntax `profile.emailAddress` means that the `emailAddress` property returned from the social identity provider can be used as the value for this field.\n"
                    },
                    "placeholder": {
                      "type": "string",
                      "description": "Serves as the HTML `placeholder` text when the field appears on an Identity Cloud screen. A `placeholder` is sample text that appears in a field, but then disappears as soon as the user begins to type in that field.\n"
                    },
                    "validation": {
                      "type": "array",
                      "description": "Validations assigned to a field. Validations help verify field data before writing that information to the user profile. For example, a validation might ensure that you don’t attempt to write string data to an attribute that can only accept integer data.\n",
                      "items": {
                        "type": "object",
                        "properties": {
                          "rule": {
                            "description": "Validation rule assigned to the field.\n",
                            "type": "string",
                            "enum": [
                              "blacklist",
                              "emailDomainsBlacklist",
                              "format",
                              "match",
                              "matchOptions",
                              "maxLength",
                              "minLength",
                              "minYears",
                              "required",
                              "unique",
                              "disableClientSide",
                              "alongWith",
                              "whitelist",
                              "clientFunctionName",
                              "serverRegexSetting"
                            ]
                          },
                          "value": {
                            "type": "string",
                            "description": "Value to validate against.\n"
                          },
                          "message": {
                            "type": "string",
                            "description": "Error message displayed if the validation fails. This needs to be a reference to a translation identifier.\n"
                          }
                        }
                      }
                    }
                  }
                }
              }
            },
            "description": "Successful response\n"
          }
        }
      },
      "parameters": [
        {
          "$ref": "#/paths/~1config~1%7Bapp_id%7D~1flows/parameters/0"
        },
        {
          "description": "Name of the field.\n",
          "in": "path",
          "name": "field",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "$ref": "#/paths/~1config~1%7Bapp_id%7D~1flows~1%7Bflow%7D/parameters/1"
        }
      ]
    }
  },
  "x-readme": {
    "samples-languages": [
      "curl",
      "python",
      "node"
    ],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "externalDocs": {
    "url": "https://techdocs.akamai.com/identity-cloud-config/reference",
    "description": "See documention for Akamai's Identity Cloud: Configuration API\n"
  }
}
```

# Sibling pages

* [Remove a field from a flow](https://techdocs.akamai.com/identity-cloud-config/reference/delete-field.md)
* [Modify a field](https://techdocs.akamai.com/identity-cloud-config/reference/put-field.md)