Profiles - BloxCord V3

These methods surface a member’s BloxCord profile and the departments they belong to, so your game can display or gate on them in real time.

getUserProfile

Returns a member’s profile: their About Me, pronouns, reputation total, the 10 most recent reputations, and whether it is currently their birthday.

local profile = BloxCord:Invoke("getUserProfile", userId)

Batchable as the user.getProfile op with args { userId } — see apiBatch. Requires the Profiles module; the reputation fields also require the Reputations module.

Parameters

number | string

required

The UserId whose profile to fetch.

Returns

table | nil

The profile payload, or nil if the request was rejected (e.g. the Profiles module is disabled) or the backend was unreachable.

Show profile fields

string

The member’s UserId.

boolean

Whether the member has hidden their profile. When true, aboutme, pronouns, pronounsRaw, and birthday are withheld.

string | null

The member’s About Me text.

string | null

Display pronouns.

string | null

The raw pronoun selection.

boolean

Whether the Reputations module is enabled.

number

The member’s total reputation.

object[]

Up to the 10 most recent reputations received.

Show reputation fields

object

{ id, username } of who gave it.

number

The reputation amount.

string | null

The attached comment, if any.

number | null

When it was given (ms).

boolean

true when it is currently the member’s birthday, evaluated at local midnight using their last-seen timezone offset.

Example

local BloxCord = game:WaitForChild("BloxCord")

local profile = BloxCord:Invoke("getUserProfile", player.UserId)
if profile then
    if profile.birthday then
        print("It's " .. player.Name .. "'s birthday!")
    end
    print(player.Name .. " has " .. profile.reputation .. " reputation.")
end

getUserDepartments

Returns the distinct departments (with color) of a member’s assigned roles.

local departments = BloxCord:Invoke("getUserDepartments", userId)

Batchable as the user.getDepartments op with args { userId } — see apiBatch. The op result is { departments = {...} }.

Parameters

number | string

required

The UserId whose departments to fetch.

Returns

object[]

An array of the member’s departments. Empty if none (or the member is not in the organization).

Show department fields

string

The department name.

string | null

The department’s role color, if set.

Example

local BloxCord = game:WaitForChild("BloxCord")

local departments = BloxCord:Invoke("getUserDepartments", player.UserId)
for _, dept in ipairs(departments) do
    print(player.Name .. " is in " .. dept.name)
end

​getUserProfile

​Parameters

​Returns

​Example

​getUserDepartments

​Parameters

​Returns

​Example

getUserProfile

Parameters

Returns

Example

getUserDepartments

Parameters

Returns

Example