--- title: List Space Groups and Spaces slug: docs/list-space-groups-and-spaces docTags: createdAt: 2026-09-21T10:07:43.151Z --- { "id": "-hiwKAZyUIT0fKJIYzo4U", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.archbee.com/api/public-api/space-group/list", "servers": [ { "url": "https://api.archbee.com/api/public-api/space-group/list", "description": "Archbee API Server" } ], "name": "List Space Groups and Spaces", "description": "

List every space group of the organization together with the spaces it contains (id and name). Requires an organization API key (abteam_...); a space API key is rejected.

", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "searchQuery", "type": "string", "description": "

OPTIONAL. Case-insensitive filter on space group and space names. A matching group is returned with all of its spaces; otherwise only its matching spaces are returned.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "bearerAuth", "name": "bearerAuth", "kind": "optional", "type": "http", "description": "

Requires the Authorization header in the form Authorization: Bearer {base64(docSpaceId~apiKey)} Where the token is base64 encoding of docSpaceId, tilde, and apiKey.

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Space groups with their spaces", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "OK" ] }, { "name": "data", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "spaceGroups", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "spaces", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" } ] } ] } ] } ], "isExpanded": true } ] }, { "statusCode": "400", "description": "Invalid request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Response400", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "Response Status", "example": "Not OK", "enum": [ "OK", "Not OK" ] }, { "name": "messages", "kind": "optional", "type": "array", "description": "Array of messages", "example": "[\"Some error message\"]", "itemType": "string", "customType": "string[]", "itemExample": "Some error message", "itemDefault": "" } ], "modelRef": "#/components/schemas/Response400", "isExpanded": true } ] }, { "statusCode": "403", "description": "

The API key is a space key; an organization key is required

", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "6aq6DpvsgTSu41ZqHIql9", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.archbee.com/api/public-api/space-group/list \\\n --header 'accept: application/json'" }, { "id": "4DorUveawT7hlw2vjojcm", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.archbee.com/api/public-api/space-group/list\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "X9fOzTRFY7th6bmS9Zn5-", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.archbee.com/api/public-api/space-group/list\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "vv8t0MCLfge4mX3shZ8hW", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.archbee.com/api/public-api/space-group/list\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "6aq6DpvsgTSu41ZqHIql9" }, "results": { "languages": [ { "id": "umzKodWC02gaLR1QkWQvJ", "language": "200", "code": "// Space groups with their spaces\n{\n \"status\": \"\",\n \"data\": {\n \"spaceGroups\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"spaces\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n }\n ]\n }\n}" }, { "id": "lzy2AOgHIkYxwXcKxMYq9", "language": "400", "code": "// Invalid request\n{\n \"status\": \"Not OK\",\n \"messages\": [\n \"Some error message\"\n ]\n}" }, { "id": "wsIl7Ev_as7ZnoY0zJsA-", "language": "403", "code": "// The API key is a space key; an organization key is required\n" } ], "selectedLanguageId": "umzKodWC02gaLR1QkWQvJ" } }, "children": [ { "text": "" } ] }