For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get Profile Fields

Retrieve the configured profile fields.

GET https://api.sonorancms.com/v2/community/profile-fields

Rate limit: 13 requests per minute

Authenticated v2 endpoints are rate limited per credential rather than per IP address.

Retrieve the configured profile fields.

Example Request

local Sonoran = require("sonoran")

local sonoran = Sonoran.createClient({
  product = Sonoran.productEnums.CMS,
  apiKey = "YOUR_API_KEY",
  communityId = "YOUR_COMMUNITY_ID",
  defaultServerId = 1,
  timeoutMs = 30000,
})

local response = sonoran.cms:getProfileFieldsV2()

if response.success then
  print(response.data)
else
  print(response.reason)
end
const Sonoran = require("sonoran.js");

const instance = Sonoran.instance({
  apiKey: "YOUR_API_KEY",
  communityId: "YOUR_COMMUNITY_ID",
  product: Sonoran.productEnums.CMS,
  serverId: 1,
});

async function main() {
  const response = await instance.cms.getProfileFieldsV2();

  if (response.success) {
    console.log(response.data);
  } else {
    console.error(response.reason);
  }
}

main().catch((error) => {
  console.error(error);
});

Response

The data array contains the community profile field definitions with their ids, labels, types, options, and metadata.

Last updated

Was this helpful?