Get User
Authorizations
Most endpoints require an organization
token. Some endpoints require an application
token, and those endpoints are noted.
Path Parameters
The Payabli-generated userId value.
Query Parameters
The entrypoint identifier.
Entry level: 0 - partner, 2 - paypoint
Response
The user's ID in Payabli.
The user's email address.
320
"example@email.com"
"Sean Smith"
The user's phone number.
"5555555555"
Social network linked to customer. Possible values: facebook, google, twitter, microsoft.
"google"
Identifier or token for customer in linked social network.
null
Additional data provided by the social network related to the customer.
null
The user's status:
- Inactive: 0
- Active: 1
- Deleted: -99
- Locked: 85
0
, 1
, -99
, 85
1
The user's locale for PartnerHub and PayHub localization. Supported values:
en
es
"en"
Timezone, in UTC offset. For example, -5 is Eastern time.
-5
When true
, multi-factor authentication (MFA) is enabled.
false
0
The timestamp for the user's creation, in UTC.
"2022-07-01 15:00:01"
The timestamp for the user's last activity, in UTC.
"2022-07-01T15:00:01"
Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. Example usage:
{
"additionalData": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
{
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
Was this page helpful?