Skip to main content

Retrieve a user (by partner code)

GET 
/api/users/by-code/:code

Retrieve a user by passing in the partner code.

Request​

Path Parameters

    code stringrequired

Header Parameters

    partnerId stringrequired

    Partner Id

    clientId stringrequired

    Client Id

    clientSecret stringrequired

    Client Secret

Responses​

The user object requested.

Schema

    id string

    Unique Id for the user

    firstName string

    User's first name

    lastName string

    User's last name

    email string

    User's email address

    phone string

    User's cell phone number

    address

    object

    Address

    addressLine1 string

    Street Address Line 1

    addressLine2 string

    Street Address Line 2

    city string

    City

    state string

    2 Letter State Code

    country string

    2 Letter Country Code

    zip string

    Zip

    tosAnswer string

    Possible values: [None, Accepted, Declined]

    User's answer to terms of service for sharing data with Partner. (Only valid for certain partners)

    partnerCode string

    A code generated for the user to share with Partner. (Only valid for certain partners)

    dateRegistered string

    Time at which user was registered on the system

    updated string

    Last updated timestamp

Loading...