Users / Read

get https://{tenantUrl}/public-api/resources/users/v1.0/{user}

Get a user

Responses

Response body

object

data

object

string

emailVerified

string | null

ISO 8601 formatted date

requirePasswordReset

boolean

Sets a requirement for the user to set a new password when they next open the app. After a new password is set, this option resets automatically.

firstName

string | null

middleName

string | null

lastName

string | null

phone

string | null

country

string | null

state

string | null

city

string | null

postCode

string | null

address

string | null

vehicleNo

string | null

personalId

string

locale

string | null

balance

number

The current amount in the balance of the user (in the base currency). Would not be returned in the response if the user is related to a Partner without "addUserBalance" permission

status

string

enabled Enabled - the user is allowed to use the system
disabled Disabled - the user is NOT allowed to use the system

enabled disabled

userGroupIds

array of integers

userGroupIds

externalId

string | null

Third party identifier of the user

subscriptionId

integer | null

user subscription id

options

object

password

string | null

Returns the hashed password. This property is optional and can be enabled by request.

lastUpdatedAt

date-time

ISO 8601 formatted date

createdAt

date-time

createdBy

string

The return values are admin: , partner: - the value after the colon is the respective ID of the admin account or the partner. token: - the value after the colon is the admin token. mobile_api - means that the User registered themselves through the mobile app.

receiveNewsAndPromotions

boolean

Shows if the user has opted into receiving news and promotions.

partnerInvites

array of objects | null

It's a part of the response only if request is called with include.partnerInvites query parameter.

partnerInvites

object

integer

required

partnerId

integer

required

sendViaEmail

boolean

string | null

Required by default, but if sendViaEmail is false, then email is null.

language

string

The language of the e-mail sent to the invitee. If none selected, the default end-users language will be used.

acceptUrl

url | null

options

object

status

string

required

pending sent accepted

createdAt

date-time

required

acceptedAt

date-time | null

userId

integer | null

lastUpdatedAt

date-time

ISO 8601 formatted date

bankDetails

object

externalAppData

object | null

The externalAppData field is an object designed to hold additional data related to external integrations.
This object can contain the following keys, which are currently supported:

externalCustomerId: A string representing the customer ID of the user in an external payment provider integration. This ID is used to link the user's account within the system to their corresponding account in the external payment provider.

If no information is available, the externalAppData object will be null. It's a part of the response only if request is called with include.externalAppData query parameter.

Has additional fields

amountDue

number

The total amount that the user owes by the current moment.

Language

Credentials

Bearer

API Token

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://example.com/public-api/resources/users/v1.0/user \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

401Access token is missing or invalid

403You do not have permission to perform the action

404The record is not found