Spaces

List Spaces

List all Spaces. For more information see Spaces document model.

Endpoint:

URL	`/api/v2/spaces/`
Method	`GET`
Expected response code	`200`
Expected response type	`JSON`

Example:

BASH

curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/spaces/

Example response:

Space list JSON

JSON

{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 5
    },
    "objects": [
        {
            "created": "2016-10-03T11:18:34",
            "id": "1fa8f598-895b-11e6-9def-dfae3ffdca3e",
            "is_hidden": false,
            "resource_uri": "/api/v2/spaces/1fa8f598-895b-11e6-9def-dfae3ffdca3e/",
            "status": "space_status:active:",
            "title": "Board meetings",
            // ...
        },
        // ...
    ]
}

Get Space details

Get details of an existing Space.

Endpoint:

URL	`/api/v2/spaces/$space_id/`
Method	`GET`
Expected response code	`200`
Expected response type	`JSON`

URL parameters:

space_id – ID of an existing Space.

Example:

BASH

space_id=c6c574bc-7758-11ee-a909-cbd0373c1708

curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/spaces/$space_id/

Example response:

Space details JSON

JSON

{
    "aspects": {},
    "created": "2023-10-30T19:16:07",
    "created_by": "Administrator Administrator",
    "description": "",
    "dynatype": {},
    "id": "c6c574bc-7758-11ee-a909-cbd0373c1708",
    "is_hidden": false,
    "modified": "2023-10-30T19:16:07",
    "modified_by": "Administrator Administrator",
    "path": "/domain/spaces/Spaces/Space title",
    "resource_uri": "/api/v2/spaces/c6c574bc-7758-11ee-a909-cbd0373c1708/",
    "snapshot_id": "c6c58c72-7758-11ee-a909-1f36cc068eb9",
    "status": "",
    "tags": [],
    "template": null,
    "title": "Space title",
    "type": "Space",
    "version": "0.1"
}

List allowed Fileplan categories for a Space

List all allowed Fileplan categories for an existing Space.

Endpoint:

URL	`/api/v2/spaces/$space_id/fileplans/`
Method	`GET`
Expected response code	`200`
Expected response type	`JSON`

URL parameters:

space_id – ID of an existing Space.

Example:

BASH

space_id=c6c574bc-7758-11ee-a909-cbd0373c1708

curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/spaces/$space_id/fileplans/

Example response:

Fileplan categories list JSON

JSON

[
    {
        "id": "bf97a8a4-897b-11e6-8e0b-db698dbf8fdf",
        "title": "ADG01 General"
    },
    {
        "id": "ccc299da-897b-11e6-b226-4720bba08b85",
        "title": "ADG02 Reports and Statistics"
    }
]

Where for each object in the list has Fileplan’s category fields:

id – Fileplan’s category ID;
title – Fileplan category title.

List Projects in a Space

See Projects | List-Projects-in-a-Space.

List Project Templates in a Space

See Project templates | List-Project-Templates-in-a-Space.

Contents

List Spaces

Get Space details

List allowed Fileplan categories for a Space

List Projects in a Space

List Project Templates in a Space