Get User Attributes

Try it

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

Content-Type: application/json

JSON Body/Payload Icon

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.

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.

200 OK

Content-Type: application/json

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.