Community Details

🏘️ Community Brief API

Fetches essential summary data about a specific community, including its admin, onboarding flags, and branding details.

Method:

GET

Endpoint:

/api/v1/community/one/brief

Headers

Name	Type	Required	Description
x-api-key	string	✅	API key to authorize the request

Body Parameters

None

Sample Response

{
  "data": {
    "community": {
      "communityId": "68502b58dc3b2c00124cd5af",
      "readableId": "monetized-communitylihqu",
      "communityName": "Bulk Invite Auto Onboard",
      "communityImage": "",
      "communityFeatureImage": "",
      "communityVisibility": 0,
      "timeStamp": 1750084440720
    },
    "communityAdmin": {
      "id": "6787893423126f0012a92ed6",
      "name": "Spencer Johnson Spencer",
      "image": "https://.../image (25).png",
      "mattermost": {
        "loginId": "gupta.sahu",
        "userId": "iwpi53tk7brm8nen98k4zw9tjh"
      }
    },
    "communityProfileId": "68502b59dc3b2c00124cd5b8",
    "subCommunityCount": 3,
    "directoryPeople": 0,
    "about": "Bulk Invite Auto Onboard",
    "address": "",
    "website": "",
    "size": 0,
    "yearFounded": 0,
    "timeStmp": 1750084441087,
    "isAdmin": "admin",
    "isModerator": false,
    "isMember": true,
    "primaryColour": "#0566FA",
    "secondryColour": "#0785ff1A",
    "platformAdminEmailFlag": true,
    "welcomeMessageFlag": true,
    "isStripeEnabled": true,
    "OBSGettingStarted": false,
    "OBSCommunityProfile": true,
    "OBSCommunityFeatures": true,
    "OBSCommunityColor": true,
    "OBSUserRoles": true,
    "OBSUserRolesPrivileges": false,
    "memberLandingPage": 3,
    "nonMemberLandingPage": 3,
    "mediacenterView": 0,
    "isWelcomeFlag": false,
    "isGuideLineFlag": false
  },
  "error": false,
  "message": "Success"
}

Response Interface

interface CommunityBriefResponse {
  data: {
    community: {
      communityId: string;
      readableId: string;
      communityName: string;
      communityImage: string;
      communityFeatureImage: string;
      communityVisibility: number;
      timeStamp: number;
    };
    communityAdmin: {
      id: string;
      name: string;
      image: string;
      mattermost: {
        loginId: string;
        userId: string;
      };
    };
    communityProfileId: string;
    subCommunityCount: number;
    directoryPeople: number;
    about: string;
    address: string;
    website: string;
    size: number;
    yearFounded: number;
    timeStmp: number;
    isAdmin: string;
    isModerator: boolean;
    isMember: boolean;
    primaryColour: string;
    secondryColour: string;
    platformAdminEmailFlag: boolean;
    welcomeMessageFlag: boolean;
    isStripeEnabled: boolean;
    [key: string]: any; // OBS flags and other dynamic keys
  };
  error: boolean;
  message: string;
}

Response Field Descriptions

Field	Type	Description
community	object	Contains metadata about the community
communityAdmin	object	Details of the community's admin
communityProfileId	string	ID linking to the community's profile
isAdmin	string	Role of the current user (e.g., "admin", "member")
isMember	boolean	Indicates if the user is a member of the community
primaryColour	string	Primary branding color
isStripeEnabled	boolean	Indicates whether Stripe integration is enabled
OBS*	boolean	Onboarding steps (OBS = Onboarding Step), track community setup progress
memberLandingPage	number	Landing page configuration for members
nonMemberLandingPage	number	Landing page configuration for non-members

Reference

Response codes

Notes

This API is used to preload core configuration, branding, admin, and onboarding setup data for a community.

Ideal for preparing onboarding dashboards and rendering administrative controls.

{ "data": { "community": { "communityId": "68502b58dc3b2c00124cd5af", "readableId": "monetized-communitylihqu", "communityName": "Bulk Invite Auto Onboard", "communityImage": "", "communityFeatureImage": "", "communityVisibility": 0, "timeStamp": 1750084440720 }, "communityAdmin": { "id": "6787893423126f0012a92ed6", "name": "Spencer Johnson Spencer", "image": "https://ntwc-us-east-2-qa-eks-s3-files-storage.s3.us-east-2.amazonaws.com/user-6787893423126f0012a92ed6/file_1741258763688_image%20%2825%29.png", "mattermost": { "loginId": "gupta.sahu", "userId": "iwpi53tk7brm8nen98k4zw9tjh" } }, "communityProfileId": "68502b59dc3b2c00124cd5b8", "subCommunityCount": 3, "directoryPeople": 0, "about": "Bulk Invite Auto Onboard", "address": "", "website": "", "size": 0, "yearFounded": 0, "timeStmp": 1750084441087, "isAdmin": "admin", "isModerator": false, "isMember": true, "primaryColour": "#0566FA", "secondryColour": "#0785ff1A", "platformAdminEmailFlag": true, "welcomeMessageFlag": true, "isStripeEnabled": true, "OBSGettingStarted": false, "OBSCommunityProfile": true, "OBSProcessToJoin": false, "OBSViewContent": false, "OBSPostContent": false, "OBSNotificationPreference": false, "OBSSpaceStructure": false, "OBSSpaceSettings": false, "OBSUnderStandMonetization": false, "OBSConnectStripe": false, "OBSLandingPage": false, "OBSCustomDomain": false, "OBSBrandColor": false, "OBSAutomateMassageGuidline": false, "OBSProfileComplition": false, "OBSMakePlan": false, "OBSCustomizeBranding": false, "OBSAutomateOnboarding": false, "OBSBestPractices": false, "OBSJoinNetworkedCommunity": false, "OBSCommunityLogo": false, "OBSCommunityBanner": false, "OBSCommunityAbout": true, "OBSCommunityWelcomeMsg": false, "OBSCommunityGuideline": false, "OBSCommunityFeatures": true, "OBSCommunityColor": true, "OBSUserRoles": true, "OBSUserRolesPrivileges": false, "memberLandingPage": 3, "nonMemberLandingPage": 3, "mediacenterView": 0, "isWelcomeFlag": false, "isGuideLineFlag": false }, "error": false, "message": "Operation completed successfully" }

🏘️ Community Brief API

Method:

Endpoint:

Headers

Body Parameters

Sample Response

Response Interface

Response Field Descriptions

Reference

Notes

Request

Responses

Community Details

🏘️ Community Brief API#

Method:#

Endpoint:#

Headers#

Body Parameters#

Sample Response#

Response Interface#

Response Field Descriptions#

Reference#

Notes#

Request

Responses

🏘️ Community Brief API

Method:

Endpoint:

Headers

Body Parameters

Sample Response

Response Interface

Response Field Descriptions

Reference

Notes