ℹ️User Details

This step shows how to get details regarding a specific user.

You can view the details of a user in two different ways:

• With USER_ID parameter

• With USERNAME parameter

Getting User Details with USER_ID

Example payload:

CURL

curl --location --request GET 'https://<DOMAIN>/xapi/user/<USER_ID>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: x-www-form-urlencoded'

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Get user by id
user = client.users.get_user_by_id("<USER_ID>")
print(user)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Get user 
const user = client.users.getUser("<USER_ID>")
console.log(user)

Go

// ASAP :)

Example response:

{
    "user_id": "<USER_ID>",
    "name": "john",
    "surname": "Doe",
    "username": "johndoe",
    "email": "[e-mail]",
    "role": "u",
    "mobile": "",
    "login_allowed": true,
    "status": 1,
    "lang": "tr-TR",
    "timezone": null,
    "expires_at": null,
    "creation_date": "2024-08-01T00:45:03.8888474+00:00",
    "updating_date": null
}

Getting User Details with USERNAME

Example payload:

CURL

curl --location --request GET 'https://<DOMAIN>/xapi/user/<USERNAME>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: x-www-form-urlencoded'

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Get user by username
user = client.users.get_user_by_username("<USERNAME>")
print(user)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Get user 
const user = client.users.getUser("<USERNAME>")
console.log(user)

Go

// ASAP :)

Example response:

{
    "user_id": "<USER_ID>",
    "name": "john",
    "surname": "Doe",
    "username": "johndoe",
    "email": "[e-mail]",
    "role": "u",
    "mobile": "",
    "login_allowed": true,
    "status": 1,
    "lang": "tr-TR",
    "timezone": null,
    "expires_at": null,
    "creation_date": "2024-08-01T00:45:03.8888474+00:00",
    "updating_date": null
}