See api-docs Menu

v1-v3 APIs have been deprecated

Don't worry, these APIs are deprecated, but they won't be shut off until 2017, at the earliest. Questions? Contact

All new development with APIs should use the newest version of our API: /1. API /1 is based on RESTful principles, is secured by OAuth 2.0, and provides JSON messages, search, pagination, sorting, and filtering.

Get Custom Attributes

Gets all custom attributes (also known as custom user fields) that have been defined for the account.

For more info about defining custom user fields, see Custom User Fields.

Resource URL

Sample Response

   <attribute type="string" label="Aliases" name="aliases" />

Response Elements

Element Description


type: Always returns string. Indicates that custom attributes accept string type values.

name: Name value used to access the custom attribute via API. For example, custom_attribute_.

label: Field label value displayed for the custom attribute in the user interface.

Sample cURL Request

Be sure to replace placeholder values surrounded by { } with actual values.

curl -X GET \
-u {api_key}:x

Postman Collection

Be sure to set Postman-specific environment variables indicated by {{ }}.

Download for the Users API