Breadcrumbs

User home

Contents

Structure of user home and favourites can be found at UserHome document model.

List User’s Recent Projects

Endpoint:

URL

/api/v2/user/projects/recent/

Method

GET

Expected response code

200

Expected response type

JSON

This endpoint returns a list of last 10 projects that current user recently visited. This is a similar list that is returned from /api/v2/projects/, with an exception that it is filtered to return the only projects that are listed in the cache.

Example:

Bash
curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/user/projects/recent/

Example response:

Recent projects JSON
JSON
{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "aspects": {},
            "associated_contacts_id": [],
            "associated_users": [],
            "connected_users": [
                "Administrator"
            ],
            "contacts": [],
            "created": "2023-11-09T15:54:21",
            "created_by": "Administrator Administrator",
            "description": "",
            "due_date": "2012-01-03",
            "dynatype": {
                "caption_plural": "dynatypes_labels:Project_plural:",
                "caption_singular": "dynatypes_labels:Project_singular:",
                "id": "d6ec2d38-7f17-11ee-a25a-93420ff9ced7",
                "title": "Project"
            },
            "fileplan": "",
            "fileplan_title": "",
            "id": "3f237b9a-7f18-11ee-924b-fbce7251e32d",
            "identifier": "2023-1",
            "modified": "2023-11-09T15:54:21",
            "modified_by": "Administrator Administrator",
            "path": "/domain/spaces/Some space folder/Some Space/Projects/Some project 1",
            "resource_uri": "/api/v2/projects/3f237b9a-7f18-11ee-924b-fbce7251e32d/",
            "responsible_users": [],
            "snapshot_id": "3f239d3c-7f18-11ee-924b-37c1c4cb413c",
            "space": {
                "id": "385d15dc-7f18-11ee-a7dc-cb91413255db",
                "title": "Some Space"
            },
            "status": "project_status:In_progress:",
            "status_message": "",
            "tags": [
                "tag0",
                "tag1",
                "tag2",
            ],
            "template": null,
            "title": "Some project 1",
            "type": "Project",
            "version": "0.1"
        },
        {
            "aspects": {},
            "associated_contacts_id": [],
            "associated_users": [],
            "connected_users": [
                "Administrator"
            ],
            "contacts": [],
            "created": "2023-11-09T15:54:21",
            "created_by": "Administrator Administrator",
            "description": "",
            "due_date": "2012-01-03",
            "dynatype": {
                "caption_plural": "dynatypes_labels:Project_plural:",
                "caption_singular": "dynatypes_labels:Project_singular:",
                "id": "d6ec2d38-7f17-11ee-a25a-93420ff9ced7",
                "title": "Project"
            },
            "fileplan": "",
            "fileplan_title": "",
            "id": "3fa79d8a-7f18-11ee-8e75-a719cb04fc60",
            "identifier": "2023-2",
            "modified": "2023-11-09T15:54:21",
            "modified_by": "Administrator Administrator",
            "path": "/domain/spaces/Some space folder/Some Space/Projects/Some project 2",
            "resource_uri": "/api/v2/projects/3fa79d8a-7f18-11ee-8e75-a719cb04fc60/",
            "responsible_users": [],
            "snapshot_id": "3fa7cecc-7f18-11ee-8e75-634ec2ec7bdc",
            "space": {
                "id": "385d15dc-7f18-11ee-a7dc-cb91413255db",
                "title": "Some Space"
            },
            "status": "project_status:In_progress:",
            "status_message": "",
            "tags": [],
            "template": null,
            "title": "Some project 2",
            "type": "Project",
            "version": "0.1"
        }
    ]
}

User’s Favourites

Users car mark particular documents as favourites, and then access the favourites list, see UserHome document model | User favourites for more details.

Endpoint:

URL

/api/v2/user/$filter_type/favorite/

Method

GET

Expected response code

200

Expected response type

JSON

URL parameters:

This endpoint returns the items, denoted by the filter_type, currently stored in the logged in user's Favourites list.

If an invalid filter type is requested, the endpoint will return a 400 status code with json object:

JSON
{"Error": "No such filter type: <filter_type>"}

Where:

  • filter_type – is the requested filter type.

List Favourite Projects

Endpoint [1]:

URL

/api/v2/user/favorite/

Method

GET

Expected response code

200

Expected response type

JSON

Example [1]:

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

Endpoint [2]:

URL

/api/v2/user/projects/favorite/

Method

GET

Expected response code

200

Expected response type

JSON

Example [2]:

Bash
curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/user/projects/favorite/

Each of the two endpoint above return the projects that have been added to the user’s favourite list. Here is an example response:

Favourite projects JSON
JSON
{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "aspects": {},
            "associated_contacts_id": [],
            "associated_users": [],
            "connected_users": [
                "Administrator"
            ],
            "contacts": [],
            "created": "2024-02-26T12:17:26",
            "created_by": "Administrator Administrator",
            "description": "",
            "due_date": "2012-01-03",
            "dynatype": {
                "caption_plural": "dynatypes_labels:Project_plural:",
                "caption_singular": "dynatypes_labels:Project_singular:",
                "id": "9a61d3c0-d4a0-11ee-8adf-dfee9c6de3cf",
                "title": "Project"
            },
            "fileplan": "",
            "fileplan_title": "",
            "id": "00bbd4cc-d4a1-11ee-afc8-371f752824ad",
            "identifier": "2024-2",
            "modified": "2024-02-26T12:17:26",
            "modified_by": "Administrator Administrator",
            "path": "/domain/spaces/Space folder title/Space title/Projects/Project 1",
            "resource_uri": "/api/v2/projects/00bbd4cc-d4a1-11ee-afc8-371f752824ad/",
            "responsible_users": [],
            "snapshot_id": "00bc1b08-d4a1-11ee-afc8-fb94b3c9fd75",
            "space": {
                "id": "fdafd53a-d4a0-11ee-afc8-cbda05af010e",
                "title": "Space title"
            },
            "status": "project_status:In_progress:",
            "status_message": "",
            "tags": [],
            "template": null,
            "title": "Project 1",
            "type": "Project",
            "version": "0.1"
        },
        {
            "aspects": {},
            "associated_contacts_id": [],
            "associated_users": [],
            "connected_users": [
                "Administrator"
            ],
            "contacts": [],
            "created": "2024-02-26T12:17:26",
            "created_by": "Administrator Administrator",
            "description": "",
            "due_date": "2022-01-03",
            "dynatype": {
                "caption_plural": "dynatypes_labels:Project_plural:",
                "caption_singular": "dynatypes_labels:Project_singular:",
                "id": "9a61d3c0-d4a0-11ee-8adf-dfee9c6de3cf",
                "title": "Project"
            },
            "fileplan": "",
            "fileplan_title": "",
            "id": "00f739e0-d4a1-11ee-b962-1751ade63123",
            "identifier": "2024-3",
            "modified": "2024-02-26T12:17:26",
            "modified_by": "Administrator Administrator",
            "path": "/domain/spaces/Space folder title/Space title/Projects/Project 2",
            "resource_uri": "/api/v2/projects/00f739e0-d4a1-11ee-b962-1751ade63123/",
            "responsible_users": [],
            "snapshot_id": "00f7908e-d4a1-11ee-b962-a790e1aa0262",
            "space": {
                "id": "fdafd53a-d4a0-11ee-afc8-cbda05af010e",
                "title": "Space title"
            },
            "status": "project_status:In_progress:",
            "status_message": "",
            "tags": [],
            "template": null,
            "title": "Project 2",
            "type": "Project",
            "version": "0.1"
        }
    ]
}

See related endpoints:

List Favourite Tasks

There is actually no way in CoreData for marking a contact as a favourite.

Endpoint:

URL

/api/v2/user/tasks/favorite/

Method

GET

Expected response code

200

Expected response type

JSON

Returns the tasks that have been added to the user’s favourite list.

Example:

Bash
curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/user/tasks/favorite/

See related endpoints:

List Favourite Files

Endpoint:

URL

/api/v2/user/files/favorite/

Method

GET

Expected response code

200

Expected response type

JSON

Returns the files that have been added to the user’s favourite list.

Example:

Bash
curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/user/files/favorite/

Example response:

Favourite files JSON
JSON
{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "aspects": {},
            "blob_name": "65ea57a5f0254e578582e3d64e4083d9",
            "category": "main",
            "created": "2024-02-28T13:15:22",
            "created_by": "Administrator Administrator",
            "description": "",
            "digest": "4b41a3475132bd861b30a878e30aa56a",
            "dynatype": {
                "caption_plural": "dynatypes_labels:File_plural:",
                "caption_singular": "dynatypes_labels:File_singular:",
                "id": "1d270064-d4a1-11ee-8810-6f3bdec3cd32",
                "title": "File"
            },
            "filename": "sample.pdf",
            "fileplan": "",
            "fileplan_title": "",
            "folder": "",
            "id": "6d986a2e-d63b-11ee-a110-dbc303128966",
            "mime_type": "application/pdf",
            "modified": "2024-02-28T13:15:22",
            "modified_by": "Administrator Administrator",
            "owner": null,
            "parent": "00cb84b2-d4a1-11ee-9db5-f3cdecff83ec",
            "path": "/domain/spaces/Space folder title/Space title/Projects/Project title/2024-2/sample.pdf",
            "project": {
                "id": "00bbd4cc-d4a1-11ee-afc8-371f752824ad",
                "identifier": "2024-2",
                "title": "Project title"
            },
            "resource_uri": "/api/v2/files/6d986a2e-d63b-11ee-a110-dbc303128966/",
            "size": 3028,
            "snapshot_id": "6d98bfb0-d63b-11ee-a110-1f199e7073b0",
            "space": {
                "id": "fdafd53a-d4a0-11ee-afc8-cbda05af010e",
                "title": "Space title"
            },
            "tags": [],
            "template": null,
            "title": "sample",
            "type": "File",
            "userhome": null,
            "version": "0.1"
        },
        {
            "aspects": {},
            "blob_name": "f8f946c24ff44c5585589db71b88d9f6",
            "category": "main",
            "created": "2024-02-28T13:15:22",
            "created_by": "Administrator Administrator",
            "description": "",
            "digest": "4b41a3475132bd861b30a878e30aa56a",
            "dynatype": {
                "caption_plural": "dynatypes_labels:File_plural:",
                "caption_singular": "dynatypes_labels:File_singular:",
                "id": "1d270064-d4a1-11ee-8810-6f3bdec3cd32",
                "title": "File"
            },
            "filename": "sample2.PDF",
            "fileplan": "",
            "fileplan_title": "",
            "folder": "",
            "id": "6d9ea9d4-d63b-11ee-86d6-ffb88cae44d1",
            "mime_type": "application/pdf",
            "modified": "2024-02-28T13:15:22",
            "modified_by": "Administrator Administrator",
            "owner": null,
            "parent": "00cb84b2-d4a1-11ee-9db5-f3cdecff83ec",
            "path": "/domain/spaces/Space folder title/Space title/Projects/Project title/2024-2/sample2.PDF",
            "project": {
                "id": "00bbd4cc-d4a1-11ee-afc8-371f752824ad",
                "identifier": "2024-2",
                "title": "Project title"
            },
            "resource_uri": "/api/v2/files/6d9ea9d4-d63b-11ee-86d6-ffb88cae44d1/",
            "size": 3028,
            "snapshot_id": "6d9ed42c-d63b-11ee-86d6-9b7fc97a76e4",
            "space": {
                "id": "fdafd53a-d4a0-11ee-afc8-cbda05af010e",
                "title": "Space title"
            },
            "tags": [],
            "template": null,
            "title": "sample2",
            "type": "File",
            "userhome": null,
            "version": "0.1"
        }
    ]
}

See related endpoints:

List Favourite Contacts

Endpoint:

URL

/api/v2/user/contacts/favorite/

Method

GET

Expected response code

200

Expected response type

JSON

Returns the contacts that have been added to the user’s favourite list.

Example:

Bash
curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/user/contacts/favorite/

Example response:

Favourite contacts JSON
JSON
{
    "meta": {
        "limit": 20,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 2
    },
    "objects": [
        {
            "aspects": {
                "person": {
                    "username": "User_B"
                }
            },
            "contact_addresses": [],
            "contact_groups": [],
            "created": "2024-02-26T12:17:12",
            "created_by": "Administrator Administrator",
            "description": "",
            "dynatype": {
                "caption_plural": "dynatypes_labels:Person_plural:",
                "caption_singular": "dynatypes_labels:Person_singular:",
                "id": "9b7f4f44-d4a0-11ee-8adf-1f818025e571",
                "title": "Person"
            },
            "emails": [],
            "id": "f8856016-d4a0-11ee-b2e3-e72c71434df3",
            "identifier": "",
            "modified": "2024-02-26T12:17:12",
            "modified_by": "Administrator Administrator",
            "organization": {
                "id": "9ce26fec-d4a0-11ee-87ea-d3366a8c40ff",
                "title": "cd-laika"
            },
            "path": "/domain/spaces/system/global/Contacts/cd-laika/John Doe",
            "phones": [],
            "resource_uri": "/api/v2/contacts/f8856016-d4a0-11ee-b2e3-e72c71434df3/",
            "role": "contact_role:customer:",
            "snapshot_id": "f8858c58-d4a0-11ee-b2e3-0f73aa052491",
            "status": "contact_status:Active:",
            "tags": [],
            "template": null,
            "title": "John Doe",
            "type": "Contact",
            "urls": [],
            "version": "0.1"
        },
        {
            "aspects": {
                "person": {
                    "username": "coredata"
                }
            },
            "contact_addresses": [],
            "contact_groups": [],
            "created": "2024-02-26T12:17:15",
            "created_by": "Administrator Administrator",
            "description": "",
            "dynatype": {
                "caption_plural": "dynatypes_labels:Person_plural:",
                "caption_singular": "dynatypes_labels:Person_singular:",
                "id": "9b7f4f44-d4a0-11ee-8adf-1f818025e571",
                "title": "Person"
            },
            "emails": [],
            "id": "fa49f6aa-d4a0-11ee-8810-7f0e768f4a7c",
            "identifier": "",
            "modified": "2024-02-26T12:17:15",
            "modified_by": "Administrator Administrator",
            "organization": {
                "id": "9ce26fec-d4a0-11ee-87ea-d3366a8c40ff",
                "title": "cd-laika"
            },
            "path": "/domain/spaces/system/global/Contacts/cd-laika/Core Data",
            "phones": [],
            "resource_uri": "/api/v2/contacts/fa49f6aa-d4a0-11ee-8810-7f0e768f4a7c/",
            "role": "contact_role:customer:",
            "snapshot_id": "fa49fe20-d4a0-11ee-8810-6b843cd5e035",
            "status": "contact_status:Active:",
            "tags": [],
            "template": null,
            "title": "Core Data",
            "type": "Contact",
            "urls": [],
            "version": "0.1"
        }
    ]
}

See related endpoints: