Is there any way to access the Display name and Description of the Field Name in Schema via Postman or AEP Query? | Community
Skip to main content
New Participant
July 23, 2025
Solved

Is there any way to access the Display name and Description of the Field Name in Schema via Postman or AEP Query?

  • July 23, 2025
  • 1 reply
  • 293 views

Here's an image for reference:

 

Best answer by bjoern__koth

Hi @user15611 

You can retrieve a full schema definition (which includes fields and their descriptions if set) via a GET request to the schema endpoint:
 

 

GET /tenant/schemas/{SCHEMA_ID} 


 

Replace  {SCHEMA_ID}  with the schema’s  meta:altId  or  $id .

The response includes the JSON schema with properties and metadata describing fields, including any descriptions.

 

See also documentation here

1 reply

bjoern__koth
bjoern__kothAccepted solution
New Participant
July 23, 2025

Hi @user15611 

You can retrieve a full schema definition (which includes fields and their descriptions if set) via a GET request to the schema endpoint:
 

 

GET /tenant/schemas/{SCHEMA_ID} 


 

Replace  {SCHEMA_ID}  with the schema’s  meta:altId  or  $id .

The response includes the JSON schema with properties and metadata describing fields, including any descriptions.

 

See also documentation here

Cheers from Switzerland!