API referencePay Ops endpointsUser management

Get user

Authentication

requestTokenstring
API Key authentication via header

Path parameters

userIdlongRequired

The Payabli-generated userId value.

Query parameters

entrystringOptional
The entrypoint identifier.
levelintegerOptional

Entry level: 0 - partner, 2 - paypoint

Response

Success
Accesslist of objectsOptional
AdditionalDatastringOptional

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:

1{
2  "additionalData": {
3    "key1": "value1",
4    "key2": "value2",
5    "key3": "value3"
6  }
7}
createdAtdatetimeOptional
The timestamp for the user's creation, in UTC.
EmailstringOptionalformat: "email"<=320 characters
The user's email address.
languagestringOptional

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

  • en
  • es
lastAccessdatetimeOptional
The timestamp for the user's last activity, in UTC.
NamestringOptional
PhonestringOptional<=50 characters
The user's phone number.
Scopelist of objectsOptional
snDatastringOptional
Additional data provided by the social network related to the customer.
snIdentifierstringOptional
Identifier or token for customer in linked social network.
snProviderstringOptional

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

timeZoneintegerOptional

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

userIdlongOptional
The user's ID in Payabli.
UsrMFAbooleanOptional

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

UsrMFAModeintegerOptional
UsrStatusintegerOptional

The user’s status:

  • Inactive: 0
  • Active: 1
  • Deleted: -99
  • Locked: 85

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error