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);
});

from sonoran import Instance, productEnums

instance = Instance(
    apiKey="YOUR_API_KEY",
    communityId="YOUR_COMMUNITY_ID",
    product=productEnums.CMS,
    serverId=1,
)

response = instance.cms.getProfileFieldsV2()

if response.success:
    print(response.data)
else:
    print(response.reason)

using Sonoran;
using System.Text.Json;

using var sonoran = new SonoranClient(new SonoranClientOptions
{
    product = SonoranProduct.CMS,
    apiKey = "YOUR_API_KEY",
    communityId = "YOUR_COMMUNITY_ID",
    defaultServerId = 1
});

var response = await sonoran.Cms.getProfileFieldsV2();

if (response.success)
{
    Console.WriteLine(JsonSerializer.Serialize(response.data));
}
else
{
    Console.WriteLine(response.reason);
}

openapi: "3.0.3"

info:

  title: "Sonoran CMS v2 - Get Profile Fields"

  version: "1.0.0"

  description: "Retrieve the configured profile fields."

servers:

  -

    url: "https://api.sonorancms.com"

paths:

  /v2/community/profile-fields:

    get:

      summary: "Get Profile Fields"

      operationId: "getProfileFields"

      security:

        -

          bearerAuth: []

      responses:

        "200":

          description: "Successful response"

          content:

            application/json:

              schema:

                type: "object"

              example:

                success: true

                data:

                  -

                    id: "discord"

                    label: "Discord"

                    type: "discord"

                    options: null

                    metadata:

                      placeholder: "username#0000"

                meta:

                  timestamp: "2026-04-15T00:00:00.000Z"

                  path: "/v2/community/profile-fields"

components:

  securitySchemes:

    bearerAuth:

      type: "http"

      scheme: "bearer"

      bearerFormat: "JWT"

Response

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


{

  "success": true,

  "data": [

    {

      "id": "discord",

      "label": "Discord",

      "type": "discord",

      "options": null,

      "metadata": {

        "placeholder": "username#0000"

      }

    }

  ],

  "meta": {

    "timestamp": "2026-04-15T00:00:00.000Z",

    "path": "/v2/community/profile-fields"

  }

}

PreviousGet Departments NextGet Clock In Types

Last updated 27 days ago

Was this helpful?

openapi: "3.0.3"

info:

  title: "Sonoran CMS v2 - Get Profile Fields"

  version: "1.0.0"

  description: "Retrieve the configured profile fields."

servers:

  -

    url: "https://api.sonorancms.com"

paths:

  /v2/community/profile-fields:

    get:

      summary: "Get Profile Fields"

      operationId: "getProfileFields"

      security:

        -

          bearerAuth: []

      responses:

        "200":

          description: "Successful response"

          content:

            application/json:

              schema:

                type: "object"

              example:

                success: true

                data:

                  -

                    id: "discord"

                    label: "Discord"

                    type: "discord"

                    options: null

                    metadata:

                      placeholder: "username#0000"

                meta:

                  timestamp: "2026-04-15T00:00:00.000Z"

                  path: "/v2/community/profile-fields"

components:

  securitySchemes:

    bearerAuth:

      type: "http"

      scheme: "bearer"

      bearerFormat: "JWT"