Get filtered tasks

GET /api/2.0/project/task/filter

Request

Returns a list with the detailed information about all the tasks matching the parameters specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

projectidinteger

Project ID

myProjectsboolean

Specifies whether to return tasks only from my projects or not

milestonearray of integer

Milestone ID

myMilestonesboolean

Specifies whether to return tasks only from my milestones or not

nomilestoneboolean

Specifies whether to return tasks only without milestones or not

taginteger

Project tag

statusarray of integer

Task status

substatusarray of integer

Custom task status

followboolean

Specifies whether to return only followed tasks or not

departamentstring

Departament GUID

participantarray of string

Participant GUID

creatorstring

Creator GUID

deadlineStartstring

Minimum value of task deadline

deadlineStopstring

Maximum value of task deadline

lastIdinteger

Last task ID

Examples

GET /api/2.0/project/task/filter HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request GET \
  --url https://example.com/api/2.0/project/task/filter \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

List of tasks

CreateByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Createdstring
Contactobject
Emailobject
InfoTypeenum of integerformat: int32

[0 - Phone, 1 - Email, 2 - Website, 3 - Skype, 4 - Twitter, 5 - LinkedIn, 6 - Facebook, 7 - Address, 8 - LiveJournal, 9 - MySpace, 10 - GMail, 11 - Blogger, 12 - Yahoo, 13 - MSN, 14 - ICQ, 15 - Jabber, 16 - AIM, 17 - VK]

Can be one of: Phone, Email, Website, Skype, Twitter, LinkedIn, Facebook, Address, LiveJournal, MySpace, GMail, Blogger, Yahoo, MSN, ICQ, Jabber, AIM, VK.

Categoryintegerformat: int32
Datastring
CategoryNamestring
IsPrimaryboolean
IDintegerformat: int32
SmallFotoUrlstring
MediumFotoUrlstring
DisplayNamestring
IsCompanyboolean
AccessListarray of object
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
IsPrivateboolean
IsSharedboolean
ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject
Titlestring
Symbolstring
Abbreviationstring
CultureNamestring
IsConvertableboolean
IsBasicboolean
CanEditboolean
CanDeleteboolean
IDintegerformat: int32
Titlestring
Descriptionstring
DeadLinestring
AlertValueintegerformat: int32
Responsibleobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
IsClosedboolean
Categoryobject
ImagePathstring
Titlestring
Descriptionstring
Colorstring
SortOrderintegerformat: int32
IDintegerformat: int32
Entityobject
EntityTypestring
EntityIdintegerformat: int32
EntityTitlestring
CanEditboolean
IDintegerformat: int32

401

Unauthorized

Get Help

  • If you have any questions about ONLYOFFICE Workspace, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).