Skip to main content
GET
/
v1
/
users
/
{userId}
Get an User by id
curl --request GET \
  --url https://sandbox-api.borderless.xyz/v1/users/{userId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "businessTitle": "<string>",
  "role": "OWNER",
  "deleted": true,
  "deletedAt": "2023-11-07T05:31:56Z",
  "mfaEnabled": true,
  "dashboardPermissions": [
    "OrganizationApiKeysGenerate"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
userId
string
required

Response

Successfully retrieved User data.

​
id
string
required
​
email
string
required
​
firstName
string | null
required
​
lastName
string | null
required
​
businessTitle
string | null
required
​
role
enum<string>
required
Available options:
OWNER,
VIEWER,
CUSTOM
​
deleted
boolean
required
​
deletedAt
string<date-time> | null
required
​
mfaEnabled
boolean
required
​
dashboardPermissions
enum<string>[]
Available options:
OrganizationApiKeysGenerate,
OrganizationApiKeysRegenerate,
OrganizationMfaEnable,
PermissionGroupCreate,
PermissionGroupUpdate,
PermissionGroupDelete,
PermissionGroupUserAdd,
PermissionGroupUserDelete,
UserCreate,
UserUpdate,
UserDelete,
UserChangeRole,
UserMfaEnable,
AccountCreate,
AccountAssetAddressAdd,
IdentityCreate,
IdentityUpdate,
IdentityDelete,
IdentityDocumentsUpload,
ComplianceCheckTosLinkManage,
ComplianceCheckStart,
PaymentInstructionCreate,
PaymentInstructionDelete,
TransactionAllCreate,
TransactionAllCancel,
TransactionAllExport,
WebhookPublicKeysGenerate,
WebhookCreate,
WebhookUpdate,
WebhookDelete