This use case shows how to retrieve Engage attribute definitions through the API — for example, to discover which profile attributes exist and their data types before mapping or syncing contact data.
Prerequisites
Before you begin, make sure you have valid authorization credentials. See Getting Started with Engage API for more information.
Procedure
Retrieve the profile attributes with a GET request. Optional query parameters let you include archived attributes (archived) and enumerated values (withEnums).
GET 'https://your-engage-domain.com/api/rest/profileAttributes/list?withEnums=true'To retrieve a single attribute, use GET /profileAttributes/get with an attributeId.
Conclusion
You receive a 200 response with an array of attribute definitions. Each entry includes fields such as id, name, displayName, and dataType, and flags such as standard, technical, archived, and enumerated (with enumeratedValues). Member, group, and address attributes have their own list endpoints.