Spaces List

🧩 Get Community Spaces

Fetches all Community Spaces and their associated channels configured within a specific community.

Method:

GET

Endpoint:

/api/v1/community/one/mattermost-channels?all=true

Headers

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

Query Parameters

Name	Type	Required	Description
all	boolean	✅	If true, retrieves all categories with channels

Body Parameters

None

Sample Response

{
  "data": {
    "categories": [
      {
        "id": "uz3fj4mdeirodxx8hhzqr8qy5r",
        "name": "Set of Links",
        "channels": [
          {
            "id": "6790d6bfed370e00118c1c98",
            "name": "New Link",
            "shapeCode": {},
            "imageType": "image",
            "nonMemberLandingPage": 3,
            "settings": {
              "about": false,
              "chat": false,
              "feed": true,
              "directory": false,
              "events": false,
              "careerOpportunities": false,
              "mediaCenter": false,
              "fundraisingInitiatives": false,
              "companyDirectoryandServices": false
            }
          },
          {
            "id": "6790d68fed370e00118c1bfc",
            "name": "Public Links",
            "shapeCode": {},
            "imageType": "image",
            "nonMemberLandingPage": 3,
            "settings": {
              "about": false,
              "chat": false,
              "feed": true,
              "directory": false,
              "events": false,
              "careerOpportunities": false,
              "mediaCenter": false,
              "fundraisingInitiatives": false,
              "companyDirectoryandServices": false
            }
          }
        ]
      }
    ]
  },
  "error": false,
  "message": "Success"
}

Response Interface

Response Field Descriptions

Field	Type	Description
categories[].id	string	Unique identifier of the category
categories[].name	string	Name of the channel category
categories[].channels[].id	string	Channel ID
categories[].channels[].name	string	Name of the channel
channels[].shapeCode	object	Object representing shape metadata (can be empty)
channels[].imageType	string	Type of image used for the channel
channels[].nonMemberLandingPage	number	Landing page value for non-members
channels[].settings	object	Permissions and visibility settings per module in the channel

Reference

Response codes

Notes

The settings object per channel helps toggle visibility for users across different modules like feed, events, media center, etc.

{ "data": { "categories": [ { "id": "uz3fj4mdeirodxx8hhzqr8qy5r", "name": "Set of Links", "channels": [ { "id": "6790d6bfed370e00118c1c98", "name": "New Link", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790d68fed370e00118c1bfc", "name": "Public Links", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67d957835930c60012157ee5", "name": "Space Name", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": true, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67d958f95930c6001215800f", "name": "Space Names 1", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67d95b615930c60012158267", "name": "Space Names 2", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67875d869a27380012ecc8df", "name": "Web Team", "shapeCode": { "shape": "1", "color": "3" }, "imageType": "shape", "nonMemberLandingPage": 7, "settings": { "about": false, "chat": true, "feed": true, "directory": true, "events": true, "careerOpportunities": false, "mediaCenter": true, "fundraisingInitiatives": false, "companyDirectoryandServices": false } } ] }, { "id": "dwtqsthgb7gujrptxjkf54y7zo", "name": "Engineering", "channels": [ { "id": "678e35a6f41aa80012e2b087", "name": "Data Base", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6785061cb3572f0012f6e0a7", "name": "Group Chat", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 0, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "678e36e2f41aa80012e2b1f0", "name": "Link Test 1", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "679587f4bc6bea0012fdc292", "name": "Pinned and auto onboard", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": true, "chat": true, "feed": true, "directory": true, "events": true, "careerOpportunities": true, "mediaCenter": true, "fundraisingInitiatives": true, "companyDirectoryandServices": true } }, { "id": "678e35e8f41aa80012e2b0cd", "name": "QA Team", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "678e362af41aa80012e2b18f", "name": "Raj Link", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "68359eaf9a776b00124b2c9b", "name": "hey", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } } ] }, { "id": "b55ae71rpfgczn4gefnawwyb1a", "name": "Group Activity", "channels": [ { "id": "6790bfbfed370e00118c063d", "name": "Demo Space", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": false, "events": true, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790c121ed370e00118c08b4", "name": "Demo space 4", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": true, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790bff6ed370e00118c0727", "name": "Demp space 3", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": true, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6785061cb3572f0012f6e0a7", "name": "Group Chat", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 0, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790c90fed370e00118c11da", "name": "Moderator Post", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790c920ed370e00118c122f", "name": "Only Admin", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "679587bebc6bea0012fdc24c", "name": "Pinned Space", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "679712b8bc6bea0012fdfab6", "name": "Space 27_01", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "678e4bc1f41aa80012e2babd", "name": "Test space", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } } ] }, { "id": "channels_se99j91gfig4tmipoy43ajqsqo_et515hx95praiqg8h1tqddnnya", "name": "Channels", "channels": [ { "id": "6790bfbfed370e00118c063d", "name": "Demo Space", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": false, "events": true, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790bff6ed370e00118c0727", "name": "Demp space 3", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": true, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6785061cb3572f0012f6e0a7", "name": "Group Chat", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 0, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "678e36e2f41aa80012e2b1f0", "name": "Link Test 1", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790c90fed370e00118c11da", "name": "Moderator Post", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790d6bfed370e00118c1c98", "name": "New Link", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790c920ed370e00118c122f", "name": "Only Admin", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "679587bebc6bea0012fdc24c", "name": "Pinned Space", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "679587f4bc6bea0012fdc292", "name": "Pinned and auto onboard", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": true, "chat": true, "feed": true, "directory": true, "events": true, "careerOpportunities": true, "mediaCenter": true, "fundraisingInitiatives": true, "companyDirectoryandServices": true } }, { "id": "6790d68fed370e00118c1bfc", "name": "Public Links", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "6790d6f9ed370e00118c1cdc", "name": "Sales space 1", "image": "https://ntwc-us-east-2-qa-eks-s3-files-storage.s3.us-east-2.amazonaws.com/user-66eff26fe7177800124594db/file_1737545444351_My%20Photo%201.jpg", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": true, "chat": true, "feed": true, "directory": true, "events": true, "careerOpportunities": true, "mediaCenter": true, "fundraisingInitiatives": true, "companyDirectoryandServices": true } }, { "id": "679712b8bc6bea0012fdfab6", "name": "Space 27_01", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67d957835930c60012157ee5", "name": "Space Name", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": true, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67d958f95930c6001215800f", "name": "Space Names 1", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": true, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67d95b615930c60012158267", "name": "Space Names 2", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "678e4bc1f41aa80012e2babd", "name": "Test space", "shapeCode": {}, "imageType": "image", "nonMemberLandingPage": 3, "settings": { "about": false, "chat": false, "feed": true, "directory": false, "events": false, "careerOpportunities": false, "mediaCenter": false, "fundraisingInitiatives": false, "companyDirectoryandServices": false } }, { "id": "67875d869a27380012ecc8df", "name": "Web Team", "shapeCode": { "shape": "1", "color": "3" }, "imageType": "shape", "nonMemberLandingPage": 7, "settings": { "about": false, "chat": true, "feed": true, "directory": true, "events": true, "careerOpportunities": false, "mediaCenter": true, "fundraisingInitiatives": false, "companyDirectoryandServices": false } } ] } ] }, "error": false, "message": "Operation completed successfully" }

🧩 Get Community Spaces

Method:

Endpoint:

Headers

Query Parameters

Body Parameters

Sample Response

Response Interface

Response Field Descriptions

Reference

Notes

Request

Responses

Spaces List

🧩 Get Community Spaces#

Method:#

Endpoint:#

Headers#

Query Parameters#

Body Parameters#

Sample Response#

Response Interface#

Response Field Descriptions#

Reference#

Notes#

Request

Responses

🧩 Get Community Spaces

Method:

Endpoint:

Headers

Query Parameters

Body Parameters

Sample Response

Response Interface

Response Field Descriptions

Reference

Notes