v1

latestOpenAPI 3.0.32026-07-24235275.4 KB
Custom Attributes

Get Custom Attributes for a User

Make a call to this endpoint to retrieve all custom attribute data associated with a user. You can query this endpoint by either phone or email.

Note: You must include a single query parameter, phone or email. Including both will result in a 400 error.

get/attributes/custom

Query parameters

phonestring
Example:+13115552368

A user’s phone number in E.164 format. The '+' sign in the phone number must be encoded in the URL query parameter as '%2B'

emailstring
Example:test@gmail.com

A user's email

Response

Successfully accepted get custom attributes request

namestring

Name of the custom attribute

valuestring required

Value of the custom attribute

Example response

[
  {
    "name": "favoriteColor",
    "value": "blue"
  }
]