Users .: Get Details

API Reference / v15

Get User Details

This endpoint returns details about the user account associated with the access token.

Request Endpoint

GET /v15/users

The authorization header should include a user token with the read_user_basic_info permission, and look like the following:

Authorization Required – User Token in Header

Authorization: token user="1123-15d2aeedc9f4e0e7094a9d283868f8fbe873cb85ceaa0c511727245aec8c9e"

cURL Example

curl https://sandbox.thelevelup.com/v15/users \
    -H Accept:application/json \
    -H Content-Type:application/json \
    -H 'Authorization:token user="1123-15d2aeedc9f4e0e7094a9d283868f8fbe873cb85ceaa0c511727245aec8c9e"'

Example Response

HTTP/1.1 200 OK

{
    "user": {
        "born_at": "1915-01-01T00:00:00-05:00",
        "cause_id": null,
        "custom_attributes": {},
        "debit_card_only": false,
        "email": "testcreds+consumer@thelevelup.com",
        "first_name": "TestCreds",
        "gender": "male",
        "id": 236,
        "user_app_id": 12345,
        "last_name": "Test Consumer",
        "merchants_visited_count": 1,
        "orders_count": 3,
        "phone": "(555) 555-5555",
        "terms_accepted_at": null,
        "connected_to_facebook": false,
        "global_credit_amount": 0,
        "total_savings_amount": 0
    }
}

Response Parameters

Param Type Description
born_at String (Date) or null The user’s birthdate (ISO8601 format).
cause_id Integer or null DEPRECATED.
custom_attributes String or null Dictionary of custom attributes for a user (specific to the app through which the request was placed).
email String The user’s email address.
first_name String The user’s first name.
gender String or null The user’s gender (male or female).
id Integer DEPRECATED.
user_app_id Integer The user’s ID (specific to the app through which the request was placed).
last_name String The user’s last name.
merchants_visited_count Integer The count of unique merchants where the user has transacted.
orders_count Integer The count of orders the user has placed.
phone String The phone number of the user (if available)
terms_accepted_at String (Date) or null The date and time when the user accepted the LevelUp terms of service.
connected_to_facebook Boolean DEPRECATED.
debit_card_only Boolean DEPRECATED.
global_credit_amount Integer The total amount of global credit (in cents) available to the user.
total_savings_amount Integer The total amount of credit (all types, in cents) that has been redeemed by the user.