Get Started
Portal api methods
Help

GET api/2.0/project/filter This function requires authentication

Description

Returns the list of all the portal projects filtered using project title, status or participant ID and 'Followed' status specified in the request

Parameters
Name Description Type Example
tag
sent in url
Project tag
optional
number 1234
status
sent in url
Project status
optional
project status Open = 0, Closed = 1
participant
sent in url
Participant GUID
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
manager
sent in url
Project manager GUID
optional
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
departament
sent in url
guid 9924256A-739C-462b-AF15-E652A3B1B6EB
follow
sent in url
My followed project
optional
Bool value true
Example
GET api/2.0/project/filter?tag=1234&participant=9924256A-739C-462b-AF15-E652A3B1B6EB&manager=9924256A-739C-462b-AF15-E652A3B1B6EB&departament=9924256A-739C-462b-AF15-E652A3B1B6EB&follow=True
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Projects list

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "canEdit": false,
      "canDelete": false,
      "security": null,
      "projectFolder": 13234,
      "id": 10,
      "title": "Sample Title",
      "description": "Sample description",
      "status": 0,
      "responsible": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "isPrivate": false,
      "taskCount": 0,
      "taskCountTotal": 0,
      "milestoneCount": 0,
      "discussionCount": 0,
      "participantCount": 0,
      "timeTrackingTotal": null,
      "documentsCount": 0,
      "isFollow": false,
      "updatedBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2019-12-15T06:37:51.0085991Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2019-12-15T06:37:51.0085991Z"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <canEdit>false</canEdit>
    <canDelete>false</canDelete>
    <security />
    <projectFolder>13234</projectFolder>
    <id>10</id>
    <title>Sample Title</title>
    <description>Sample description</description>
    <status>0</status>
    <responsible>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </responsible>
    <isPrivate>false</isPrivate>
    <taskCount>0</taskCount>
    <taskCountTotal>0</taskCountTotal>
    <milestoneCount>0</milestoneCount>
    <discussionCount>0</discussionCount>
    <participantCount>0</participantCount>
    <timeTrackingTotal />
    <documentsCount>0</documentsCount>
    <isFollow>false</isFollow>
    <updatedBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </updatedBy>
    <created>2019-12-15T06:37:51.0085991Z</created>
    <createdBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createdBy>
    <updated>2019-12-15T06:37:51.0085991Z</updated>
  </response>
</result>