TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

GET api/2.0/project/{status} This function requires authentication

Description

Returns a list of all the projects with a status specified in the request.

Parameters
Name Description Type Example
status
sent in url
Project status ("Open", "Paused", or "Closed") Open, Closed, Paused Open
Example
GET api/2.0/project/%22Open%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of projects

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "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": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "ResponsibleId": "00000000-0000-0000-0000-000000000000",
      "CanEdit": false,
      "IsPrivate": false
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <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>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Responsible>
    <ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
    <CanEdit>False</CanEdit>
    <IsPrivate>False</IsPrivate>
  </response>
</result>