Get User

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Authorization

Either 1) x-token, or 2) x-api-key must be given to authenticate account.

Parameters

Allowed Fields

  • first_name
  • last_name
  • email
  • birthday
  • phone
  • gender
  • city
  • state
  • zip
  • address
  • address_2
  • join_date
  • source_id
  • source

Custom Attributes
Each account inherits, or creates it's own custom attributes for users. These attributes must be sent in key => value pairs.

Example

attributes: {
    first_pet_name: "Fluffy"
}

NOTE 1

User fields or custom attributes that do not exist will simply be ignored.

Path Params
string
required

Account ID

Query Params
int32
required

user_id or email required - The user id of the user to retrieve

string
required

user_id or email required - Email of user being retrieved

fields
array of strings
Defaults to first_name,last_name,email,join_date

Fields to return. Always returns user_id

fields
attributes
array of strings

fields to return based on accounts attributes.

attributes
Headers
string

Admin's authorization token

string

Authorized account's API key

Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json