Sign in

v1

latestOpenAPI 3.1.02026-07-136388308.2 KB
Profile Management

Get the details of a user

This endpoint will retrieve the details of a specific Fire user. You will need to enable PERM_BUSINESS_GET_USER to use this endpoint.

get/v1/users/{userId}

Path parameters

userIdinteger required

Lists a specific User

Example:14059

Response

Unique information about a User.

idinteger

The User ID for this User

emailAddressstring

email address for user

firstNamestring

User first name

lastNamestring

User second name

mobileNumberstring

User mobile number

role'ADMIN' | 'FULL_USER' | 'PAYMENT_ONLY_USER' | 'PAYEE_MANAGEMENT' | 'READ_ONLY' | 'CARD_ONLY'

User role

status'LIVE' | 'CLOSED' | 'FROZEN' | 'INVITE_SENT' | 'SMS_CODE_SENT'

Status of user

lastloginstring

Timestamp on when user last logged in.

userCvlstring

Users Cvl type ID (shows up when status is LIVE)

Example response

{
  "id": 14059,
  "emailAddress": "user@example.com",
  "firstName": "Colm",
  "lastName": "User",
  "mobileNumber": "+353871234567",
  "lastlogin": "2012-01-20T11:21:35.000Z",
  "userCvl": "FULL",
  "mobileApplicationDetails": {
    "clientID": "EBB10F29-A653-4DBA-9C8C-BA79F72F78B0",
    "deviceOSVersion": "14.4"
  }
}