User

Get User in an Organization

Use this endpoint to retrieve information about a specific user within an organization.

get/User/{userId}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/User/{userId}
  • Auth: HTTP bearer

Path parameters

userIdinteger required

The Payabli-generated userId value.

Query parameters

entrystring

The entrypoint identifier.

levelinteger

Entry level: 0 - partner, 2 - paypoint

Response

Success

AdditionalDataAdditionalDataMap

Custom dictionary of key:value pairs. You can use this field to store any data related to the object or for your system. If you are using custom identifiers, pass those in this object. Max length for a value is 100 characters.

{
  "additionalData": {
    "key1": "value1",
    "key2": "value2",
    "key3": "value3"
  }
}
createdAtstring date-time

Timestamp of when record was created, in UTC.

Emailstring email

Email address.

languagestring

The language code.

lastAccessstring date-time

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

Namestring
Phonestring

Phone number.

snDatastring

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

snIdentifierstring

Identifier or token for customer in linked social network.

snProviderstring

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

timeZoneinteger

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

userIdinteger

The user's ID in Payabli.

UsrMFAboolean

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

UsrMFAModeinteger
UsrStatusinteger

The user's status:

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

Changes

No recorded changes to this operation across all 1 revision of this API.