HTTP Verb: GET

Available statuses: 200 OK, 204 No Content, 404 Not Found

Object: Space

Location: n/a

Formats: XML, JSON

Returns a list of spaces.

Params

Param Description
filter[spacegroup] Specify group ID. Assembla provides the following predefined group IDs:
  • rule-2: All spaces
  • rule-10: Active spaces
  • rule-11: Archived spaces
  • rule-12: Proposed spaces
  • rule-13: Template spaces
  • rule-14: Shared spaces
Check Portfolio Group API for getting a list of custom groups.

Examples

Request XML, using cURL utility:

curl -i -H "Authorization: Bearer _token" https://_portfolio_subdomain.api.assembla.com/v1/spaces.xml

Response:

HTTP/1.1 200 OK
Server: nginx/0.8.55
Date: Fri, 07 Sep 2012 13:08:42 GMT
Content-Type: application/xml; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Status: 200
...

<?xml version="1.0" encoding="UTF-8"?>
<spaces type="array">
  <space>
    <id>d6_muWDNyr4PMj5bfBjDYC</id>
    <name>Space Name</name>
    <description></description>
    <wiki-name>space_name</wiki-name>
    <public-permissions type="integer">0</public-permissions>
    <team-permissions type="integer">2</team-permissions>
    <watcher-permissions type="integer">1</watcher-permissions>
    <share-permissions type="boolean">true</share-permissions>
    <team-tab-role type="integer">0</team-tab-role>
    <created-at type="datetime">2013-02-14T02:20:16-05:00</created-at>
    <updated-at type="datetime">2013-03-03T23:27:07-05:00</updated-at>
    <default-showpage>0</default-showpage>
    <tabs-order nil="true"></tabs-order>
    <parent-id>cJiq3KDNyr4PMj5bfBjDYC</parent-id>
    <restricted type="boolean">false</restricted>
    <restricted-date nil="true"></restricted-date>
    <commercial-from type="datetime">2013-02-14T02:20:16-05:00</commercial-from>
    <banner nil="true"></banner>
    <banner-height nil="true"></banner-height>
    <banner-text nil="true"></banner-text>
    <banner-link nil="true"></banner-link>
    <style nil="true"></style>
    <status type="integer">4</status>
    <approved type="boolean">false</approved>
    <is-manager type="boolean">true</is-manager>
    <is-volunteer type="boolean">false</is-volunteer>
    <is-commercial type="boolean">true</is-commercial>
    <can-join type="boolean">false</can-join>
    <can-apply type="boolean">true</can-apply>
    <last-payer-changed-at nil="true"></last-payer-changed-at>
  </space>
  ...
</spaces>

Request JSON, using cURL utility:

curl -i -H "Authorization: Bearer _token" https://_portfolio_subdomain.api.assembla.com/v1/spaces.json

Response:

HTTP/1.1 200 OK
Server: nginx/0.8.55
Date: Fri, 07 Sep 2012 13:12:30 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Status: 200
...

[
  {
    "id": "d6_muWDNyr4PMj5bfBjDYC",
    "name": "Space Name",
    "description": "",
    "wiki_name": "space_name",
    "public_permissions": 0,
    "team_permissions": 2,
    "watcher_permissions": 1,
    "share_permissions": true,
    "team_tab_role": 0,
    "created_at": "2013-02-14T02:20:16-05:00",
    "updated_at": "2013-03-03T23:27:07-05:00",
    "default_showpage": "0",
    "tabs_order": null,
    "parent_id": "cJiq3KDNyr4PMj5bfBjDYC",
    "restricted": false,
    "restricted_date": null,
    "commercial_from": "2013-02-14T02:20:16-05:00",
    "banner": null,
    "banner_height": null,
    "banner_text": null,
    "banner_link": null,
    "style": null,
    "status": 4,
    "approved": false,
    "is_manager": true,
    "is_volunteer": false,
    "is_commercial": true,
    "can_join": false,
    "can_apply": true,
    "last_payer_changed_at": null
  },
  ...
]

JSON is formatted here for readability, in a real response JSON body is inline with no indentation.

Description for each field: Space object fields reference