Get a message

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

Request

Returns the detailed information about a discussion message 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

messageidinteger

Message ID

Examples

GET /api/2.0/project/message/%7Bmessageid:[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/message/%7Bmessageid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Message

CanEditFilesboolean
CanReadFilesboolean
Subscribersarray of object
FirstNamestring
LastNamestring
UserNamestring
Emailstring
Birthdaystring
Sexstring
Statusenum of integerformat: int32

[1 - Active, 2 - Terminated, 4 - LeaveOfAbsence, 5 - Default, 7 - All]

Can be one of: Active, Terminated, LeaveOfAbsence, Default, All.

ActivationStatusenum of integerformat: int32

[0 - NotActivated, 1 - Activated, 2 - Pending, 4 - AutoGenerated]

Can be one of: NotActivated, Activated, Pending, AutoGenerated.

Terminatedstring
Departmentstring
WorkFromstring
Groupsarray of object
Namestring
Idstringformat: uuid
Managerstring
Locationstring
Notesstring
Leadstringformat: uuid
AvatarMediumstring
Avatarstring
IsAdminboolean
IsLDAPboolean
ListAdminModulesarray of string
IsOwnerboolean
IsVisitorboolean
CultureNamestring
IsSSOboolean
QuotaLimitintegerformat: int64
UsedSpaceintegerformat: int64
DocsSpaceintegerformat: int64
MailSpaceintegerformat: int64
TalkSpaceintegerformat: int64
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Filesarray of object
Namestring
UpdatedByobject
Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring
Updatedstring
Locationstring
Commentsarray of object
CommentIDstring
UserIDstringformat: uuid
UserPoststring
UserFullNamestring
UserProfileLinkstring
UserAvatarPathstring
CommentBodystring
Inactiveboolean
IsReadboolean
IsEditPermissionsboolean
IsResponsePermissionsboolean
TimeStampStrstring
CommentListobject
Attachmentsarray of object
FileNamestring
FilePathstring
Projectobject
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
ProjectOwnerobject
Idintegerformat: int32
Titlestring
Statusintegerformat: int32
IsPrivateboolean
Textstring
CanCreateCommentboolean
CanEditboolean
CommentsCountintegerformat: int32
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).