GET
/
User
/
{userId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/User/{userId} \
  --header 'requestToken: <api-key>'
{
  "userId": 123,
  "Email": "example@email.com",
  "Name": "Sean Smith",
  "Phone": "5555555555",
  "snProvider": "google",
  "snIdentifier": null,
  "snData": null,
  "Scope": [
    {
      "orgType": 0,
      "orgId": 123,
      "orgEntry": "pilgrim-planner"
    }
  ],
  "Access": [
    {
      "roleLabel": "customers",
      "roleValue": true
    }
  ],
  "UsrStatus": 1,
  "language": "en",
  "timeZone": -5,
  "UsrMFA": false,
  "UsrMFAMode": 0,
  "createdAt": "2022-07-01 15:00:01",
  "lastAccess": "2022-07-01T15:00:01",
  "AdditionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}

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
Success
​
userId
integer

The user's ID in Payabli.

​
Email
string | null

The user's email address.

Maximum length: 320
Example:

"example@email.com"

​
Name
string | null
Example:

"Sean Smith"

​
Phone
string | null

The user's phone number.

Example:

"5555555555"

​
snProvider
string | null

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

Example:

"google"

​
snIdentifier
string | null

Identifier or token for customer in linked social network.

Example:

null

​
snData
string | null

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

Example:

null

​
Scope
object[] | null
​
Access
object[] | null
​
UsrStatus
enum<integer> | null

The user's status:

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

1

​
language
string | null

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

  • en
  • es
Example:

"en"

​
timeZone
integer | null
default:0

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

Example:

-5

​
UsrMFA
boolean | null

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

Example:

false

​
UsrMFAMode
integer
Example:

0

​
createdAt
string

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

Example:

"2022-07-01 15:00:01"

​
lastAccess
string | null

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

Example:

"2022-07-01T15:00:01"

​
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"
  }
}
Example:
{
  "key1": "value1",
  "key2": "value2",
  "key3": "value3"
}

Was this page helpful?