LogoLogo
SupportDeveloper ForumLogin
  • Overview
    • Introduction
    • Getting Started
    • Authentication
    • Error Handling
    • Pagination
    • Filtering
    • Ordering
    • Rate Limits
    • Permissions
    • Webhooks
    • MCP Server
    • Versioning
    • Changelog
    • Support
  • API v1 Reference
    • Projects Overview
    • Tasks Overview
    • Time Tracking Overview
    • Documents Overview
    • Search Overview
    • Companies Overview
    • Users Overview
    • Files & Images Overview
    • Custom Fields Overview
    • Workload & Planning Overview
    • Project Templates Overview
    • Login & Access Overview
    • API Management Overview
SupportDeveloper ForumLogin
API v1 ReferenceTask Views

Creates a new task view and directly subscribes the user to it.

POST
https://api.awork.com/api/v1/me/taskviews
POST
/api/v1/me/taskviews
1curl -X POST https://api.awork.com/api/v1/me/taskviews \
2 -H "Authorization: Bearer <token>" \
3 -H "Content-Type: application/json" \
4 -d '{
5 "filter": "(project/company ne null)",
6 "filterSettings": "(json data representing the filter settings. Too long to show in doc)",
7 "name": "Projects with defined company",
8 "isShared": true
9}'
Try it
200Successful
1{
2 "id": "123e4567-e89b-12d3-a456-426614174000",
3 "isShared": true,
4 "filter": "(project/company ne null)",
5 "filterSettings": "(json data representing the filter settings. Too long to show in doc)",
6 "name": "Projects with defined company",
7 "createdOn": "2022-03-10T16:03:49.100Z",
8 "createdBy": "123e4567-e89b-12d3-a456-426614174000",
9 "updatedOn": "2022-03-15T16:55:00.100Z",
10 "updatedBy": "123e4567-e89b-12d3-a456-426614174000"
11}

Creates a new task view. The user will automatically subscribe to it in the process. If the provided filter string is invalid the request will fail with status 400.

Required Permissions
Any authenticated user.

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.

Request

This endpoint expects an object.
filterstring or nullOptional
The filter query that is applied to the tasks results. The syntax follows the normal filter conventions that can be used on GET routes.
filterSettingsstring or nullOptional
The filter settings to display.
namestring or nullOptional
The name of the task view.
isSharedbooleanOptional
If the taskview is shared or not.

Response

OK
idUUID or null
The id of the task view.
isSharedboolean or null
Whether this task view is shared within the workspace.
filterstring or null
The filter query that is applied to the tasks results. The syntax follows the normal filter coventions that can be used on GET routes.
filterSettingsstring or null
The filter settings to display.
namestring or null
The name of the task view.
createdOndatetime or null
The date this task view was created.
createdByUUID or null
The id of the user who created this task view.
updatedOndatetime or null
The date this task view was last modified.
updatedByUUID or null
The id of the user who last modified this task view.
Was this page helpful?
Previous

Subscribes the current user to a shared task view.

Next
Built with
OK

Bearer authentication of the form Bearer <token>, where token is your auth token.