Sign in
People / Custom fields

Retrieves a specific custom field by its key.

Fetches the details of a single custom field by its unique key. This endpoint is useful for retrieving the configuration and metadata for individual custom fields.

get/dx/api/people/v1/customFields/{key}

Path parameters

The unique key of the custom field to retrieve.

Response

Custom field retrieved successfully.

Changes

Changed in 2 of the 3 revisions of this API.22

  • 2267cfc94cf02See the full diff
    • ▲

      removed the media type */* for the response with the status

      response-media-type-removed

    • ▲

      removed the media type exampleCustomField for the response with the status

      response-media-type-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 355f7332f5502See the full diff
    • ○

      added the media type */* for the response with the status

      response-media-type-added

    • ○

      added the media type exampleCustomField for the response with the status

      response-media-type-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog