GET
/
User
/
{userId}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

userId
integer
required

The Payabli-generated userId value.

Query Parameters

entry
string

The entrypoint identifier.

level
integer

Entry level: 0 - partner, 2 - paypoint

Response

200 - application/json
Access
object[] | null
AdditionalData
string | null

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"
  }
}
createdAt
string

The timestamp for the user's creation, in UTC.

Email
string | null

The user's email address.

language
string | null

The user's locale for PartnerHub and PayHub localization. Supported values:

  • en
  • es
lastAccess
string | null

The timestamp for the user's last activity, in UTC.

Name
string | null
Phone
string | null

The user's phone number.

Scope
object[] | null
snData
string | null

Additional data provided by the social network related to the customer.

snIdentifier
string | null

Identifier or token for customer in linked social network.

snProvider
string | null

Social network linked to customer. Possible values: facebook, google, twitter, microsoft.

timeZone
integer | null
default:
0

Timezone, in UTC offset. For example, -5 is Eastern time.

userId
integer

The user's ID in Payabli.

UsrMFA
boolean | null

When true, multi-factor authentication (MFA) is enabled.

UsrMFAMode
integer
UsrStatus
enum<integer> | null

The user's status:

  • Inactive: 0
  • Active: 1
  • Deleted: -99
  • Locked: 85
Available options:
0,
1,
-99,
85