Get User Attributes
Returns the attributes of a user –
- You can use this API to post data, in which case you’ll get only the attributes you’ve passed in the ‘LookupValue’ parameter.
- If you don’t post any data, you’ll get all the attributes of the user.
API URL
URL
POST
https://{host}/v2/UserManagement.svc/User/Attribute/Retrieve?accessKey=AccessKey&secretKey=SecretKey
Request
Content-Type: application/jsonJSON Body/Payload
{
"Parameter": {
"LookupName": "SchemaName",
"LookupValue": "mx_Custom_1, mx_Custom_2"
}
}
Request Parameters
| Parameter | Description |
|---|---|
| LookupName | This should always be “SchemaName”. |
| LookupValue | Here you can pass the schema names of the attributes you want to retrieve. For example, the schema names of system fields are “EmailAddress”, “FirstName”, “Address”, “CreatedBy”, “CreatedOn” etc. To view the schema names of all custom fields, navigate to My Account>Settings>Customizations>Users>Custom fields. |
Response
200 OK
Content-Type: application/json
{
"TotalUserAttributes": 2,
"UserAttributes": [
{
"BaseTable": "User_Base",
"CanUserEdit": true,
"Category": "Custom",
"CreatedBy": "3b10421d-8374-11e7-8758-0a106ee76b21",
"CreatedByName": "System",
"CreatedOn": "2017-08-17 17:48:11",
"DataType": 8,
"DisplayName": "Number of Dependents",
"Id": "3ca30e62-8374-11e7-ab78-02de49b06427",
"InternalSchemaName": "mx_Custom_1",
"IsHidden": false,
"IsMandatory": false,
"MaxLength": 250,
"ModifiedBy": "1a50c565-8525-11ea-a93b-0aa4c559f4ca",
"ModifiedByName": "Yogesh",
"ModifiedOn": "2021-04-05 09:56:37",
"Options": "[{\"IsDefault\":true,\"Text\":null,\"Value\":\"Unmarried\",\"Order\":1,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0,\"BackgroundColor\":null,\"FontColor\":null},{\"IsDefault\":false,\"Text\":null,\"Value\":\"Married\",\"Order\":2,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0,\"BackgroundColor\":null,\"FontColor\":null}]",
"RangeMax": 250,
"RenderType": 22,
"SchemaName": "mx_Custom_1",
"Sequence": 31,
"SortOrder": 1,
"StatusCode": 0,
"StatusReason": 0,
"Type": 2
},
{
"BaseTable": "User_Base",
"CanUserEdit": true,
"Category": "Custom",
"CreatedBy": "3b10421d-8374-11e7-8758-0a106ee76b21",
"CreatedByName": "System",
"CreatedOn": "2017-08-17 17:48:11",
"DataType": 8,
"DisplayName": "Marital Status",
"Id": "3ca30f98-8374-11e7-ab78-02de49b06427",
"InternalSchemaName": "mx_Custom_2",
"IsHidden": false,
"IsMandatory": false,
"MaxLength": 250,
"ModifiedBy": "1a50c565-8525-11ea-a93b-0aa4c559f4ca",
"ModifiedByName": "Yogesh",
"ModifiedOn": "2021-04-05 09:59:14",
"Options": "[{\"IsDefault\":true,\"Text\":null,\"Value\":\"Male\",\"Order\":1,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0,\"BackgroundColor\":null,\"FontColor\":null},{\"IsDefault\":false,\"Text\":null,\"Value\":\"Female\",\"Order\":2,\"CanEdit\":1,\"CanDelete\":1,\"IsLastOption\":0,\"BackgroundColor\":null,\"FontColor\":null}]",
"RangeMax": 250,
"RenderType": 22,
"SchemaName": "mx_Custom_2",
"Sequence": 31,
"SortOrder": 2,
"StatusCode": 0,
"StatusReason": 0,
"Type": 2
}
]
}
HTTP Response Codes
| Code | Description |
|---|---|
| 200 OK | This is the status code for successful API call. |
| 401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
| 400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
| 404 Not Found | The API could not be found. Please check the API signature. |
| 429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
| 500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |
