Get a project by ID

GET /api/2.0/project/{id:[0-9]+}

Request

Returns the detailed information about a project with the ID 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

idinteger

Project ID

Examples

GET /api/2.0/project/%7Bid:[0-9]+%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com
curl --request GET \
  --url 'https://example.com/api/2.0/project/%7Bid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Project

CanEditboolean
CanDeleteboolean
Securityobject
CanCreateMilestoneboolean
CanCreateMessageboolean
CanCreateTaskboolean
CanCreateTimeSpendboolean
CanEditTeamboolean
CanReadFilesboolean
CanReadMilestonesboolean
CanReadMessagesboolean
CanReadTasksboolean
CanLinkContactboolean
CanReadContactsboolean
CanEditboolean
CanDeleteboolean
IsInTeamboolean
ProjectFolderobject
IsPrivateboolean
TaskCountintegerformat: int32
TaskCountTotalintegerformat: int32
MilestoneCountintegerformat: int32
DiscussionCountintegerformat: int32
ParticipantCountintegerformat: int32
TimeTrackingTotalstring
DocumentsCountintegerformat: int32
IsFollowboolean
Tagsarray of string
Createdstring
CreatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
CreatedByIdstringformat: uuid
Updatedstring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
UpdatedByIdstringformat: uuid
Idintegerformat: int32
Titlestring
Descriptionstring
Statusintegerformat: int32
Responsibleobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
ResponsibleIdstringformat: uuid

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).